README

Imis.com

composer require socialiteproviders/imis

安装和基本使用

请参阅基本安装指南，然后按照以下特定提供者的说明进行操作。

将配置添加到 config/services.php

'imis' => [
    'host' => env('IMIS_HOST'),
    'login_url' => env('IMIS_LOGIN_URL'),
    'client_id' => env('IMIS_CLIENT_ID'),
    'client_secret' => env('IMIS_CLIENT_SECRET'),
    'redirect' => env('IMIS_CALLBACK_URL'),
],

添加提供者事件监听器

Laravel 11+

在 Laravel 11 中，默认的 EventServiceProvider 提供者已被移除。取而代之的是，在您的 AppServiceProvider 的 boot 方法中使用 Event 门面上的 listen 方法添加监听器。

• 注意：除非您用自己的提供者覆盖它们，否则您无需为内置的 socialite 提供者添加任何内容。

Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('imis', \SocialiteProviders\Imis\Provider::class);
});

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \SocialiteProviders\Imis\ImisExtendSocialite::class.'@handle',
    ],
];

用法

现在您应该能够像平时使用 Socialite 一样使用此提供者（假设您已安装门面）

return Socialite::driver('imis')->redirect();

示例环境变量

IMIS_HOST=https://www.public-imis-site.com
IMIS_LOGIN_URL=Web/Sign-in.aspx
IMIS_CLIENT_ID=MySSOApp
IMIS_CLIENT_SECRET=
IMIS_CALLBACK_URL=https://example-laravel-site.com/oauth2/imis/callback

创建 IMIS 用户信息查询

在根目录下创建 'OAuth2' 目录，并在其中创建查询。

定义 > 摘要选项卡

• 名称：userInfo

• 描述

  根据 OAuth2 标准构建的 SSO 用户信息 https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims

定义 > 源选项卡

• 源：UserData + PartyData
• 关系：自定义（当 UserData.Party Id = PartyData.Party Id 时）

定义 > 过滤器

• 属性：Where PartyData.Party Id
• 函数：None
• 比较：Equal
• 值：Dynamic
• LoggedInUserKey
• 提示：No
• 限制结果数量为 1

定义 > 显示

• PartyData.Party Id - 别名 'sub'
• UserData.Username - 别名 'username'
• UserData.Email - 别名 'email'
• PartyData.First Name - 别名 'given_name'
• PartyData.Last Name - 别名 'family_name'

响应

https://{{URL}}/api/query?QueryName=$/OAuth2/userInfo

{
    "$type": "Asi.Soa.Core.DataContracts.PagedResult, Asi.Contracts",
    "Items": {
        "$type": "System.Collections.Generic.List`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            {
                "$type": "System.Dynamic.ExpandoObject, System.Core",
                "sub": "123456aa-UUID-0000-0000-000000000000",
                "username": "EXAMPLE@EXAMPLE.COM.AU",
                "email": "example@example.com",
                "given_name": "First",
                "family_name": "Last"
            }
        ]
    },
    "Offset": 0,
    "Limit": 100,
    "Count": 1,
    "TotalCount": 1,
    "NextPageLink": null,
    "HasNext": false,
    "NextOffset": 0
}

有用的提示

• SSO 设置信息

• 从 IQA 迁移到查询服务

• 在 IMIS 中使用相同的名称作为客户端 ID 和 SSO 内容项

• 需要创建自定义查询以返回用户信息，因为 Imis 不支持 userInfo 端点

• Imis 返回 'refresh_token' 而不是授权码，因此已修改提供者以处理此问题。

• 当用户未登录时，Imis 也会返回值。刷新令牌和 bearer 令牌与访客用户相关。由于访客用户没有用户属性，我们不应在我们的 Laravel 应用程序中允许这种情况。这就是我如何处理这种情况的

  // -- When handling a POST to the callback url
  
      public function oauthHandleCallback(Request $request, String $provider): RedirectResponse
      {
          switch ($provider) {
          
              case "imis":
  
                      // Copy 'refresh_token' to a 'code' for use in Socialite
                      $request->request->add(['code' => $request->post('refresh_token')]);
  
                      // Fails if user is a guest
                      try {
                          $user = Socialite::driver('imis')->stateless()->user();
                      }
                      catch(\Throwable $e) {
                          // Redirect to Imis login
                          return redirect()->away(config('services.imis.host').'/'.config('services.imis.login_url'));
                      }
                  break;
  
              default:
                  dd('provider fail not found');
          }
  
          $authUser = $this->findOrCreateUser($user, $provider);
  
          Auth::login($authUser, true);
  
          return redirect(config('app.url').'/member');
      }

项目设置教程

返回的用户字段

• id
• 昵称
• 姓名
• 电子邮件
• 头像
• 用户[]