django-cognito-saml

使用cognito（通过pyjwt）实现django身份验证的库。

假设

• 使用授权码流程。隐式授权不安全，因为访问令牌在没有加密的情况下通过请求参数传输。

设置

以下设置应在您的设置文件中针对一个COGNITO_CONFIG字典设置。

安装

1. 将上述设置添加到您的设置中。

COGNITO_CONFIG = {
    "ENDPOINT": "",
    "CLIENT_ID": "",
    "CLIENT_SECRET": "",
    "JWKS_URI": "",
    "REDIRECT_URI": "",
    "RESPONSE_HOOK": ""
    "REQUIRED_GROUPS": []
}

2. 定义您的身份验证后端。从django_cognito_saml.backends.CognitoUserBackend继承。

   通过自定义 authenticate 方法来定义您的用户 username 字段。如果您想为用户添加额外的字段或修改用户的权限，请重写 configure_user 方法。configure_user 方法可以访问 self.cognito_jwt，其中包含包含 cognito saml 声明的解码 jwt 令牌。

   如果想要禁用自动创建用户，请设置 create_unknown_user = False。

class CustomCognitoBackend(CognitoUserBackend):
    # Change this to False if you do not want to create a remote user.
    create_unknown_user = True

    def authenticate(  # type: ignore[override]
        self, request: HttpRequest, cognito_jwt: dict[str, Any], **kwargs: Any
    ) -> Optional[AbstractBaseUser]:
        # Customizing the username field used to create the user
        remote_user = cognito_jwt["username"]
        user = super().authenticate(request, remote_user=remote_user, **kwargs)
        return user

    def configure_user(  # type: ignore[override]
        self, request: HttpRequest, user: AbstractBaseUser, created: bool = True
    ) -> AbstractBaseUser:
        # Configuring the user post login
        if created:
            user.name = self.cognito_jwt["name"]
            user.save()
        return user

3. 将 SuperUserBackend 添加到您的身份验证后端。

AUTHENTICATION_BACKENDS = (
    ...
    "django_cognito_saml.backends.SuperUserBackend",
    ...
)

4. 将 cognito saml 网址添加到您的 urls.py。

urls = [
    ...
    path("/", include("django_cognito_saml.urls")),
]