技术文章

当前位置:首页>帮助手册>技术文章

通过服务来调用接口实现单点登录

时间:2024-02-28   
内容导读

本篇讲服务管理中接口的访问控制与外部调用方式,适合需要让其他系统免登录拿到平台数据的场景。创建接口后可设置允许访问的地址表达式,用正则限定客户端来源;开启鉴权则要求调用方带上鉴权名称与加密令牌,令牌由用户名和时间戳拼接后经约定算法加密得到。文中给出请求地址的拼装规则、请求方法与前端加密代码样例,同时提示密钥长度设有下限,相关设置需由具备服务管理角色的账号操作。

本文介绍 O2OA 服务管理中接口的权限设定和调用方式。

适用版本:5.4及以上版本

创建接口

具有服务管理设计权限的用户(具有 ServiceManager 角色或 Manager 角色)打开“服务管理平台”,进入接口配置视图,点击左上角的新建按钮即可创建接口。

新建接口后,右侧属性栏中有两项与调用权限相关的配置:“允许访问的地址表达式”和“启用鉴权”。

image (96).png

允许访问的地址表达式

此处可输入一个正则表达式,用于匹配调用接口的客户端 Remote_Addr,仅匹配通过时接口才允许执行。例如仅允许 172.16.1.50 到 172.16.1.56 的地址调用接口,可输入:

172.16.1.5[0-6]

启用鉴权

此处选择“是”后,调用接口时需传入 client 名称和一个加密后的 token,因此需要先创建一组鉴权配置。

具有管理员权限的用户(具有 Manager 角色)打开“系统设置”-“系统 SSO 配置”,找到“鉴权配置”。

image (97).png

点击“添加鉴权配置”:

image (98).png

此处需要配置名称和密钥。

名称:可随意填写,即调用接口或进行 SSO 时传入的 client 参数。

密钥:可随意填写,用于后续加密,最少 8 位。

此处假设名称填写为 oa,密钥填写为 platform。

填写完成后确定。

image (99).png

接下来即可使用此鉴权配置调用接口。

启用鉴权后的接口调用地址为:

http://develop.o2oa.net:20030/x_program_center/jaxrs/invoke/{name}/client/{client}/token/{token}/execute

请求方法为:POST

地址中的{name}为接口的名称或别名;

地址中的{client}为鉴权的名称;

地址中的{token}为“用户名#1970年毫秒数”,使用鉴权密钥经 DES 加密后的值。

javascript 加密代码样例

我们使用 CryptoJS 进行 DES 加密。(GitHub: https://github.com/brix/crypto-js)

function crypDES (value, key) {
    var keyHex = CryptoJS.enc.Utf8.parse(key);
    var xtoken = CryptoJS.DES.encrypt(value, keyHex, {
      mode: CryptoJS.mode.ECB,
      padding: CryptoJS.pad.Pkcs7
    });
    var str = xtoken.ciphertext.toString(CryptoJS.enc.Base64);
    str = str.replace(/=/g, "");
    str = str.replace(/+/g, "-");
    str = str.replace(///g, "_");
    return str;
},

IOS 加密代码样例

/// o2oa DES加密 @param publicKey 加密公钥
func o2DESEncode(code: String, publicKey: String) -> String? {
    if let encode = desEncrypt(code: code, key: publicKey, iv: "12345678", options: (kCCOptionECBMode + kCCOptionPKCS7Padding)) {
        let first = encode.replacingOccurrences(of: "+", with: "-")
        let second = first.replacingOccurrences(of: "/", with: "_")
        let token = second.replacingOccurrences(of: "=", with: "")
        return token
    }else {
        print("加密错误")
        return nil
    }
}
/// DES 加密
func desEncrypt(code: String, key:String, iv:String, options:Int = kCCOptionPKCS7Padding) -> String? {
    if let keyData = key.data(using: String.Encoding.utf8),
        let data = code.data(using: String.Encoding.utf8),
        let cryptData    = NSMutableData(length: Int((data.count)) + kCCBlockSizeDES) {

        let keyLength              = size_t(kCCKeySizeDES)
        let operation: CCOperation = UInt32(kCCEncrypt)
        let algoritm:  CCAlgorithm = UInt32(kCCAlgorithmDES)
        let options:   CCOptions   = UInt32(options)

        var numBytesEncrypted :size_t = 0

        let cryptStatus = CCCrypt(operation,
                                  algoritm,
                                  options,
                                  (keyData as NSData).bytes, keyLength,
                                  iv,
                                  (data as NSData).bytes, data.count,
                                  cryptData.mutableBytes, cryptData.length,
                                  &numBytesEncrypted)

        if UInt32(cryptStatus) == UInt32(kCCSuccess) {
            cryptData.length = Int(numBytesEncrypted)
            let base64cryptString = cryptData.base64EncodedString()
            return base64cryptString
        }
        else {
            return nil
        }
    }
    return nil
}

Android 加密代码样例

fun o2DESEncode(code: String, publicKey: String): String {
    val sutil = CryptDES.getInstance(publicKey)
    var encode = ""
    try {
        encode = sutil.encryptBase64(code)
        Log.d(LOG_TAG,"加密后code:$encode")
        encode = encode.replace("+", "-")
        encode = encode.replace("/", "_")
        encode = encode.replace("=", "")
        Log.d(LOG_TAG,"替换特殊字符后的code:$encode")
    }catch (e: Exception) {
        Log.e(LOG_TAG,"加密失败", e)
    }
    return encode
}

public class CryptDES {
    private Cipher encryptCipher = null;
    private Cipher decryptCipher = null;
    private static CryptDES des = null;
    public static CryptDES getInstance(String des_key) {
        try {
            DESKeySpec key = new DESKeySpec(des_key.getBytes());
            SecretKeyFactory keyFactory = SecretKeyFactory.getInstance("DES");
            des = new CryptDES(keyFactory.generateSecret(key));
        } catch (Exception e) {
            e.printStackTrace();
        }
        return des;
    }
    private CryptDES(SecretKey key) throws Exception {
        encryptCipher = Cipher.getInstance("DES");
        decryptCipher = Cipher.getInstance("DES");
        encryptCipher.init(Cipher.ENCRYPT_MODE, key);
        decryptCipher.init(Cipher.DECRYPT_MODE, key);
    }    
    public String encryptBase64 (String unencryptedString) throws Exception {
        // Encode the string into bytes using utf-8
        byte[] unencryptedByteArray = unencryptedString.getBytes("UTF8");
        // Encrypt
        byte[] encryptedBytes = encryptCipher.doFinal(unencryptedByteArray);
        // Encode bytes to base64 to get a string
        byte [] encodedBytes = Base64.encode(encryptedBytes, Base64.DEFAULT);
        return new String(encodedBytes);
    }
    public String decryptBase64 (String encryptedString) throws Exception {
        // Encode bytes to base64 to get a string
        byte [] decodedBytes = Base64.encode(encryptedString.getBytes(), Base64.DEFAULT);
        // Decrypt
        byte[] unencryptedByteArray = decryptCipher.doFinal(decodedBytes);
        // Decode using utf-8
        return new String(unencryptedByteArray, "UTF8");
    }  
}

用户常见问题

整理自藕粉社区真实提问,按浏览量排序

Q接口如何接收【服务调用】中传来的参数?

具有服务管理设计权限的用户(具有 ServiceManager 角色或 Manager 角色)打开“服务管理平台”,进入接口配置视图,点击左上角的新建按钮,可创建一个新的接口。

查看原帖讨论 · 11,704 次浏览

以上问题仍无法解决?到 藕粉社区 提问,或致电 400-888-0545。

相关内容

O2OA 翱途 企业应用开发平台

兰德网络O2OA平台软件

开源、自主可控的协同办公底座

研发与运营

纵横翱途(杭州)科技有限公司

企业级协同应用 · 工作流引擎 · AI 智能体

www.o2oa.net | 400-888-0545

上一篇:介绍如何通过OAuth2与O2OA进行单点登录

下一篇:系统协作集成-平台部署之OnlyOffice集成版(O2OA容器化部署)