Features#

After configured GitHub plug -in，You can click the github icon on the Arkid login page，Jump to GitHub website to complete OAATH2 certification，And bind to the user of Arkid

Create GitHub applications#

Open the setting page to create GitHub developersClick to create，Fill in the formGenerate client SecretSave client Id and client Secret

name，The homepage URL and callback URL can be filled in freely，The steps will be changed to ARKID automatic URL after the step back the URL。

Open the third -party certification pageFill in the form parameter， Click to createClick the editor button，Get ARKID callback URL

Re -set up GitHub application callback URLClick GitHub icon on the login pageClick the certification button

Implementation#

Abstract methods to cover the base class of plug -in，See ARKID.core.extension.external_idp.ExternalIdpExtension

Unified binding and unbinding instructions#

See [three -party account binding] (../../%20%20%20UserGuide/User Manual/%20 ordinary users/Certification management/Three -party account binding/)

Code#

`extension_root.com_longgui_external_idp_github.ExternalIdpGithubExtension (ExternalIdpExtension)` #

Source code in extension_root/com_longgui_external_idp_github/__init__.py

class ExternalIdpGithubExtension(ExternalIdpExtension):
    def load(self):
        super().load()
        self.register_extend_field(GithubUser, "github_user_id")
        self.register_extend_field(GithubUser, "github_nickname")
        self.register_extend_field(GithubUser, "github_avatar")
        self.register_external_idp_schema("github", GithubConfigSchema)

    def get_img_url(self):
        """
        返回Github的图标URL
        """
        return IMG_URL

    def get_auth_code_from_request(self, request):
        code = request.GET.get("code", '')
        return code

    def get_authorize_url(self, config, callback_url, next_url):
        """
        Args:
            config (arkid.core.extension.TenantExtensionConfig): 第三方登录的插件运行时配置
            redirect_uri (str): 在ArkID中创建Github登录配置后返回的回调地址
        Returns:
            str: 返回用于向Github发起认证的URL
        """
        redirect_uri = "{}{}".format(callback_url, next_url)
        redirect_uri = quote(redirect_uri)
        url = "{}?client_id={}&redirect_uri={}".format(
            AUTHORIZE_URL,
            config.config.get("client_id"),
            redirect_uri,
        )
        return url

    def get_ext_token(self, config, code):
        """
        Args:
            config (arkid.core.extension.TenantExtensionConfig): 第三方登录的插件运行时配置
            code (str): Github返回的授权码
        Returns:
            str: 返回Github返回的access_token
        """
        response = requests.post(
            GET_TOKEN_URL,
            params={
                "code": code,
                "client_id": config.config.get("client_id"),
                "client_secret": config.config.get("client_secret"),
                "grant_type": "authorization_code",
            },
        ).__getattribute__("_content")
        result = dict(
            [(k, v[0]) for k, v in parse_qs(response.decode()).items()]
        )  # 将响应信息转换为字典
        return result["access_token"]

    def get_ext_user_info(self, config, code, token):
        """
        Args:
            config (arkid.core.extension.TenantExtensionConfig): 第三方登录的插件运行时配置
            code (str): Github返回的授权码
            token (str): Github返回的access_token
        Returns:
            tuple: 返回Github中用户信息中的id， login，avatar_url和所有用户信息
        """
        headers = {"Authorization": "token " + token}
        response = requests.get(
            GET_USERINFO_URL,
            params={"access_token": token},
            headers=headers,
        ).json()
        return response["id"], response["login"], response["avatar_url"], response

    def get_arkid_user(self, ext_id):
        """
        Args:
            ext_id (str): 从Github用户信息接口获取的用户标识
        Returns:
            arkid.core.models.User: 返回ext_id绑定的ArkID用户
        """
        github_user = GithubUser.valid_objects.filter(github_user_id=ext_id).first()
        if github_user:
            return github_user.target
        else:
            return None

    def bind_arkid_user(self, ext_id, user, data):
        """
        Args:
            ext_id (str): 从Github用户信息接口获取的用户标识
            user (arkid.core.models.User): 用于绑定的ArkID用户
            data (dict) request数据
        """
        user.github_user_id = ext_id
        user.github_nickname = data.get('ext_name', '')
        user.github_avatar = data.get('ext_icon', '')
        user.save()

    def get_img_and_redirect_url(self, config):
        return config.config.get("img_url", ""), config.config.get("login_url", "")

`bind_arkid_user(self, ext_id, user, data)` #

Parameters:

Name	Type	Description	Default
`ext_id`	`str`	从Github用户信息接口获取的用户标识	required
`user`	`arkid.core.models.User`	用于绑定的ArkID用户	required

Source code in extension_root/com_longgui_external_idp_github/__init__.py

def bind_arkid_user(self, ext_id, user, data):
    """
    Args:
        ext_id (str): 从Github用户信息接口获取的用户标识
        user (arkid.core.models.User): 用于绑定的ArkID用户
        data (dict) request数据
    """
    user.github_user_id = ext_id
    user.github_nickname = data.get('ext_name', '')
    user.github_avatar = data.get('ext_icon', '')
    user.save()

`get_arkid_user(self, ext_id)` #

Parameters:

Name	Type	Description	Default
`ext_id`	`str`	从Github用户信息接口获取的用户标识	required

Returns:

Type	Description
`arkid.core.models.User`	返回ext_id绑定的ArkID用户

Source code in extension_root/com_longgui_external_idp_github/__init__.py

def get_arkid_user(self, ext_id):
    """
    Args:
        ext_id (str): 从Github用户信息接口获取的用户标识
    Returns:
        arkid.core.models.User: 返回ext_id绑定的ArkID用户
    """
    github_user = GithubUser.valid_objects.filter(github_user_id=ext_id).first()
    if github_user:
        return github_user.target
    else:
        return None

`get_auth_code_from_request(self, request)` #

抽象方法

Parameters:

Name	Type	Description	Default
`request`	`HTTPRequest`	第三方认证返回的用户标识	required

Returns:

Type	Description
`str`	授权码

Source code in extension_root/com_longgui_external_idp_github/__init__.py

def get_auth_code_from_request(self, request):
    code = request.GET.get("code", '')
    return code

`get_authorize_url(self, config, callback_url, next_url)` #

Parameters:

Name	Type	Description	Default
`config`	`arkid.core.extension.TenantExtensionConfig`	第三方登录的插件运行时配置	required
`redirect_uri`	`str`	在ArkID中创建Github登录配置后返回的回调地址	required

Returns:

Type	Description
`str`	返回用于向Github发起认证的URL

Source code in extension_root/com_longgui_external_idp_github/__init__.py

def get_authorize_url(self, config, callback_url, next_url):
    """
    Args:
        config (arkid.core.extension.TenantExtensionConfig): 第三方登录的插件运行时配置
        redirect_uri (str): 在ArkID中创建Github登录配置后返回的回调地址
    Returns:
        str: 返回用于向Github发起认证的URL
    """
    redirect_uri = "{}{}".format(callback_url, next_url)
    redirect_uri = quote(redirect_uri)
    url = "{}?client_id={}&redirect_uri={}".format(
        AUTHORIZE_URL,
        config.config.get("client_id"),
        redirect_uri,
    )
    return url

`get_ext_token(self, config, code)` #

Parameters:

Name	Type	Description	Default
`config`	`arkid.core.extension.TenantExtensionConfig`	第三方登录的插件运行时配置	required
`code`	`str`	Github返回的授权码	required

Returns:

Type	Description
`str`	返回Github返回的access_token

Source code in extension_root/com_longgui_external_idp_github/__init__.py

def get_ext_token(self, config, code):
    """
    Args:
        config (arkid.core.extension.TenantExtensionConfig): 第三方登录的插件运行时配置
        code (str): Github返回的授权码
    Returns:
        str: 返回Github返回的access_token
    """
    response = requests.post(
        GET_TOKEN_URL,
        params={
            "code": code,
            "client_id": config.config.get("client_id"),
            "client_secret": config.config.get("client_secret"),
            "grant_type": "authorization_code",
        },
    ).__getattribute__("_content")
    result = dict(
        [(k, v[0]) for k, v in parse_qs(response.decode()).items()]
    )  # 将响应信息转换为字典
    return result["access_token"]

`get_ext_user_info(self, config, code, token)` #

Parameters:

Name	Type	Description	Default
`config`	`arkid.core.extension.TenantExtensionConfig`	第三方登录的插件运行时配置	required
`code`	`str`	Github返回的授权码	required
`token`	`str`	Github返回的access_token	required

Returns:

Type	Description
`tuple`	返回Github中用户信息中的id， login，avatar_url和所有用户信息

Source code in extension_root/com_longgui_external_idp_github/__init__.py

def get_ext_user_info(self, config, code, token):
    """
    Args:
        config (arkid.core.extension.TenantExtensionConfig): 第三方登录的插件运行时配置
        code (str): Github返回的授权码
        token (str): Github返回的access_token
    Returns:
        tuple: 返回Github中用户信息中的id， login，avatar_url和所有用户信息
    """
    headers = {"Authorization": "token " + token}
    response = requests.get(
        GET_USERINFO_URL,
        params={"access_token": token},
        headers=headers,
    ).json()
    return response["id"], response["login"], response["avatar_url"], response

`get_img_and_redirect_url(self, config)` #

返回前端渲染第三方登录的按钮抽象方法

Parameters:

Name	Type	Description	Default
`config`	`arkid.extension.models.TenantExtensionConfig`	第三方认证提供的Client_ID,	required

Returns:

Type	Description
`tuple`	返回图片url和跳转地址('image_url', 'redirect_url')

Source code in extension_root/com_longgui_external_idp_github/__init__.py

def get_img_and_redirect_url(self, config):
    return config.config.get("img_url", ""), config.config.get("login_url", "")

`get_img_url(self)` #

返回Github的图标URL

Source code in extension_root/com_longgui_external_idp_github/__init__.py

def get_img_url(self):
    """
    返回Github的图标URL
    """
    return IMG_URL

`load(self)` #

抽象方法，插件加载的入口方法

Source code in extension_root/com_longgui_external_idp_github/__init__.py

def load(self):
    super().load()
    self.register_extend_field(GithubUser, "github_user_id")
    self.register_extend_field(GithubUser, "github_nickname")
    self.register_extend_field(GithubUser, "github_avatar")
    self.register_external_idp_schema("github", GithubConfigSchema)

Github Third -party login plug -in#

Features#

Create GitHub applications#

Create Arkid third -party login configuration,Get the recovery URL#

Update github application callback URL，Click the login button#

Implementation#

Unified binding and unbinding instructions#

Abstract method implementation:#

Code#

extension_root.com_longgui_external_idp_github.ExternalIdpGithubExtension (ExternalIdpExtension) #

bind_arkid_user(self, ext_id, user, data) #

get_arkid_user(self, ext_id) #

get_auth_code_from_request(self, request) #

get_authorize_url(self, config, callback_url, next_url) #

get_ext_token(self, config, code) #

get_ext_user_info(self, config, code, token) #

get_img_and_redirect_url(self, config) #

get_img_url(self) #

load(self) #

评论

`extension_root.com_longgui_external_idp_github.ExternalIdpGithubExtension (ExternalIdpExtension)` #

`bind_arkid_user(self, ext_id, user, data)` #

`get_arkid_user(self, ext_id)` #

`get_auth_code_from_request(self, request)` #

`get_authorize_url(self, config, callback_url, next_url)` #

`get_ext_token(self, config, code)` #

`get_ext_user_info(self, config, code, token)` #

`get_img_and_redirect_url(self, config)` #

`get_img_url(self)` #

`load(self)` #