1.0.2 • Published 1 year ago

sso-integration v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

sso-integration 是什么

用于在 node 服务中集成 Myid 登录功能

如何使用

可以直接看代码案例 sample.ts

目前只支持 Express.js

安装

npm i -S sso-integration

引入 sso-integration

import sso_integration from "sso-integration"

配置

  sso_integration.forRoot(
    app,
    {
      loginPath: // go to Myid page,
      loginCallbackPath: // SOLO: Assertion Consumer Service URLs,
      saml: {
        entryPoint: // SOLO: Entity ID,
        issuer: // SOLO: Issuer,
        cert: // SOLO: X.509 Signing Certificate,
      },
      loginSuccessCallBack: (req, res)=>{
    		// 登录成功后的回调方法
    		// 用户信息会挂载在 req['state'].account 上
        console.log('user profile', req['state'].account)
      },
      loginFailedCallback: (err: Error, req, res)=>{
        // Myid登录成功后,body解析失败,无法获取用户信息的回调接口
        console.error(err)
      }
    }
  )

Options

类型必传描述
loginPathStringy打开 Myid 登录页面的路径。示例:/pipp/sso/login
loginCallbackPathStringyMyid 登录成功后的回调接口路径。示例:/pipp/sso/login
samlObjectysaml 协议配置
saml.entryPointStringyEntity ID
saml.issuerStringyIssuer
saml.certStringyX.509 Signing Certificate
loginSuccessCallBackFunctionyMyid 登录成功后执行的回调方法,会包含用户信息。用户信息挂载在req['state'].account
loginFailedCallbackFunctionnMyid登录成功后,body解析失败,无法获取用户信息的回调接口