girder-cli-oauth-client

一个用于对Girder 4（Django）服务器执行OAuth登录的Python库。

描述

此库提供了使用OAuth2.0授权代码授予PKCE流程和带外重定向对Girder 4服务器进行身份验证的支持。

用法

• 安装库

  pip install girder-cli-oauth-client
  

• 使用您的应用程序特定配置实例化一个OauthClient

  from girder_cli_oauth_client import GirderCliOAuthClient
  
  oauth_client = GirderCliOAuthClient(
      'https://:8000/oauth/',
      '1ohsuyWIx9fEsJhmAH2AWGNUqd8Wsd7LHyongtVy',
      ['identity'],
  )
  

• 在开始登录流程时调用login

  oauth_client.login()  # open the browser to login and wait for a code
  

• 在每次应用程序启动时，无条件调用maybe_restore_login，尝试恢复登录状态；如果没有登录，则不会执行任何操作。

  oauth_client.maybe_restore_login()
  

• 在每次API请求中包含这些头信息

  requests.get('https://:8000/api/users/me', headers=oauth_client.auth_headers)
  

• 调用logout以清除任何活动登录

  oauth_client.logout()
  

示例应用程序

此存储库附带了一个示例应用程序。运行它

git clone https://github.com/girder/girder-cli-oauth-client.git
pip install -e '.[dev]'
cd example
python cli.py login
python cli.py me