Module slack_bolt.authorization.async_authorize
Expand source code
import inspect
from logging import Logger
from typing import Optional, Callable, Awaitable, Dict, Any
from slack_sdk.errors import SlackApiError
from slack_sdk.oauth.installation_store import Bot, Installation
from slack_sdk.oauth.installation_store.async_installation_store import (
AsyncInstallationStore,
)
from slack_sdk.oauth.token_rotation.async_rotator import AsyncTokenRotator
from slack_sdk.web.async_client import AsyncWebClient
from slack_bolt.authorization.async_authorize_args import AsyncAuthorizeArgs
from slack_bolt.authorization import AuthorizeResult
from slack_bolt.context.async_context import AsyncBoltContext
from slack_bolt.error import BoltError
class AsyncAuthorize:
"""This provides authorize function that returns AuthorizeResult
for an incoming request from Slack."""
def __init__(self):
pass
async def __call__(
self,
*,
context: AsyncBoltContext,
enterprise_id: Optional[str],
team_id: Optional[str], # can be None for org-wide installed apps
user_id: Optional[str],
) -> Optional[AuthorizeResult]:
raise NotImplementedError()
class AsyncCallableAuthorize(AsyncAuthorize):
"""When you pass the authorize argument in AsyncApp constructor,
This authorize implementation will be used.
"""
def __init__(
self, *, logger: Logger, func: Callable[..., Awaitable[AuthorizeResult]]
):
self.logger = logger
self.func = func
self.arg_names = inspect.getfullargspec(func).args
async def __call__(
self,
*,
context: AsyncBoltContext,
enterprise_id: Optional[str],
team_id: Optional[str], # can be None for org-wide installed apps
user_id: Optional[str],
) -> Optional[AuthorizeResult]:
try:
all_available_args = {
"args": AsyncAuthorizeArgs(
context=context,
enterprise_id=enterprise_id,
team_id=team_id,
user_id=user_id,
),
"logger": context.logger,
"client": context.client,
"context": context,
"enterprise_id": enterprise_id,
"team_id": team_id,
"user_id": user_id,
}
for k, v in context.items():
if k not in all_available_args:
all_available_args[k] = v
kwargs: Dict[str, Any] = { # type: ignore
k: v for k, v in all_available_args.items() if k in self.arg_names # type: ignore
}
found_arg_names = kwargs.keys()
for name in self.arg_names:
if name not in found_arg_names:
self.logger.warning(f"{name} is not a valid argument")
kwargs[name] = None
auth_result: Optional[AuthorizeResult] = await self.func(**kwargs)
if auth_result is None:
return auth_result
if isinstance(auth_result, AuthorizeResult):
return auth_result
else:
raise ValueError(
f"Unexpected returned value from authorize function (type: {type(auth_result)})"
)
except SlackApiError as err:
self.logger.debug(
f"The stored bot token for enterprise_id: {enterprise_id} team_id: {team_id} "
f"is no longer valid. (response: {err.response})"
)
return None
class AsyncInstallationStoreAuthorize(AsyncAuthorize):
"""If you use the OAuth flow settings, this authorize implementation will be used.
As long as your own InstallationStore (or the built-in ones) works as you expect,
you can expect that the authorize layer should work for you without any customization.
"""
authorize_result_cache: Dict[str, AuthorizeResult]
find_installation_available: Optional[bool]
find_bot_available: Optional[bool]
token_rotator: Optional[AsyncTokenRotator]
_config_error_message: str = "AsyncInstallationStore with client_id/client_secret are required for token rotation"
def __init__(
self,
*,
logger: Logger,
installation_store: AsyncInstallationStore,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
token_rotation_expiration_minutes: Optional[int] = None,
# For v1.0.x compatibility and people who still want its simplicity
# use only InstallationStore#find_bot(enterprise_id, team_id)
bot_only: bool = False,
cache_enabled: bool = False,
client: Optional[AsyncWebClient] = None,
):
self.logger = logger
self.installation_store = installation_store
self.bot_only = bot_only
self.cache_enabled = cache_enabled
self.authorize_result_cache = {}
self.find_installation_available = None
self.find_bot_available = None
if client_id is not None and client_secret is not None:
self.token_rotator = AsyncTokenRotator(
client_id=client_id,
client_secret=client_secret,
client=client,
)
else:
self.token_rotator = None
self.token_rotation_expiration_minutes = (
token_rotation_expiration_minutes or 120
)
async def __call__(
self,
*,
context: AsyncBoltContext,
enterprise_id: Optional[str],
team_id: Optional[str], # can be None for org-wide installed apps
user_id: Optional[str],
) -> Optional[AuthorizeResult]:
if self.find_installation_available is None:
self.find_installation_available = hasattr(
self.installation_store, "async_find_installation"
)
if self.find_bot_available is None:
self.find_bot_available = hasattr(self.installation_store, "async_find_bot")
bot_token: Optional[str] = None
user_token: Optional[str] = None
if not self.bot_only and self.find_installation_available:
# Since v1.1, this is the default way.
# If you want to use find_bot / delete_bot only, you can set bot_only as True.
try:
# Note that this is the latest information for the org/workspace.
# The installer may not be the user associated with this incoming request.
latest_installation: Optional[
Installation
] = await self.installation_store.async_find_installation(
enterprise_id=enterprise_id,
team_id=team_id,
is_enterprise_install=context.is_enterprise_install,
)
# If the user_token in the latest_installation is not for the user associated with this request,
# we'll fetch a different installation for the user below
# The example use cases are:
# - The app's installation requires both bot and user tokens
# - The app has two installation paths 1) bot installation 2) individual user authorization
this_user_installation: Optional[Installation] = None
if latest_installation is not None:
# Save the latest bot token
bot_token = latest_installation.bot_token # this still can be None
user_token = (
latest_installation.user_token
) # this still can be None
if latest_installation.user_id != user_id:
# First off, remove the user token as the installer is a different user
latest_installation.user_token = None
latest_installation.user_scopes = []
# try to fetch the request user's installation
# to reflect the user's access token if exists
this_user_installation = (
await self.installation_store.async_find_installation(
enterprise_id=enterprise_id,
team_id=team_id,
user_id=user_id,
is_enterprise_install=context.is_enterprise_install,
)
)
if this_user_installation is not None:
user_token = this_user_installation.user_token
if latest_installation.bot_token is None:
# If latest_installation has a bot token, we never overwrite the value
bot_token = this_user_installation.bot_token
# If token rotation is enabled, running rotation may be needed here
refreshed = await self._rotate_and_save_tokens_if_necessary(
this_user_installation
)
if refreshed is not None:
user_token = refreshed.user_token
if latest_installation.bot_token is None:
# If latest_installation has a bot token, we never overwrite the value
bot_token = refreshed.bot_token
# If token rotation is enabled, running rotation may be needed here
refreshed = await self._rotate_and_save_tokens_if_necessary(
latest_installation
)
if refreshed is not None:
bot_token = refreshed.bot_token
if this_user_installation is None:
# Only when we don't have `this_user_installation` here,
# the `user_token` is for the user associated with this request
user_token = refreshed.user_token
except NotImplementedError as _:
self.find_installation_available = False
if (
# If you intentionally use only `find_bot` / `delete_bot`,
self.bot_only
# If the `find_installation` method is not available,
or not self.find_installation_available
# If the `find_installation` method did not return data and find_bot method is available,
or (
self.find_bot_available is True
and bot_token is None
and user_token is None
)
):
try:
bot: Optional[Bot] = await self.installation_store.async_find_bot(
enterprise_id=enterprise_id,
team_id=team_id,
is_enterprise_install=context.is_enterprise_install,
)
if bot is not None:
bot_token = bot.bot_token
if bot.bot_refresh_token is not None:
# Token rotation
if self.token_rotator is None:
raise BoltError(self._config_error_message)
refreshed = await self.token_rotator.perform_bot_token_rotation(
bot=bot,
token_rotation_expiration_minutes=self.token_rotation_expiration_minutes,
)
if refreshed is not None:
await self.installation_store.async_save_bot(refreshed)
bot_token = refreshed.bot_token
except NotImplementedError as _:
self.find_bot_available = False
except Exception as e:
self.logger.info(f"Failed to call find_bot method: {e}")
token: Optional[str] = bot_token or user_token
if token is None:
# No valid token was found
self._debug_log_for_not_found(enterprise_id, team_id)
return None
# Check cache to see if the bot object already exists
if self.cache_enabled and token in self.authorize_result_cache:
return self.authorize_result_cache[token]
try:
auth_test_api_response = await context.client.auth_test(token=token)
authorize_result = AuthorizeResult.from_auth_test_response(
auth_test_response=auth_test_api_response,
bot_token=bot_token,
user_token=user_token,
)
if self.cache_enabled:
self.authorize_result_cache[token] = authorize_result
return authorize_result
except SlackApiError as err:
self.logger.debug(
f"The stored bot token for enterprise_id: {enterprise_id} team_id: {team_id} "
f"is no longer valid. (response: {err.response})"
)
return None
# ------------------------------------------------
def _debug_log_for_not_found(
self, enterprise_id: Optional[str], team_id: Optional[str]
):
self.logger.debug(
"No installation data found "
f"for enterprise_id: {enterprise_id} team_id: {team_id}"
)
async def _rotate_and_save_tokens_if_necessary(
self, installation: Optional[Installation]
) -> Optional[Installation]:
if installation is None or (
installation.user_refresh_token is None
and installation.bot_refresh_token is None
):
# No need to rotate tokens
return None
if self.token_rotator is None:
# Token rotation is required but this Bolt app is not properly configured
raise BoltError(self._config_error_message)
refreshed: Optional[
Installation
] = await self.token_rotator.perform_token_rotation(
installation=installation,
minutes_before_expiration=self.token_rotation_expiration_minutes,
)
if refreshed is not None:
# Save the refreshed data in database for following requests
await self.installation_store.async_save(refreshed)
return refreshed
Classes
-
This provides authorize function that returns AuthorizeResult for an incoming request from Slack.
Expand source code
class AsyncAuthorize: """This provides authorize function that returns AuthorizeResult for an incoming request from Slack.""" def __init__(self): pass async def __call__( self, *, context: AsyncBoltContext, enterprise_id: Optional[str], team_id: Optional[str], # can be None for org-wide installed apps user_id: Optional[str], ) -> Optional[AuthorizeResult]: raise NotImplementedError()
Subclasses
-
When you pass the authorize argument in AsyncApp constructor, This authorize implementation will be used.
Expand source code
class AsyncCallableAuthorize(AsyncAuthorize): """When you pass the authorize argument in AsyncApp constructor, This authorize implementation will be used. """ def __init__( self, *, logger: Logger, func: Callable[..., Awaitable[AuthorizeResult]] ): self.logger = logger self.func = func self.arg_names = inspect.getfullargspec(func).args async def __call__( self, *, context: AsyncBoltContext, enterprise_id: Optional[str], team_id: Optional[str], # can be None for org-wide installed apps user_id: Optional[str], ) -> Optional[AuthorizeResult]: try: all_available_args = { "args": AsyncAuthorizeArgs( context=context, enterprise_id=enterprise_id, team_id=team_id, user_id=user_id, ), "logger": context.logger, "client": context.client, "context": context, "enterprise_id": enterprise_id, "team_id": team_id, "user_id": user_id, } for k, v in context.items(): if k not in all_available_args: all_available_args[k] = v kwargs: Dict[str, Any] = { # type: ignore k: v for k, v in all_available_args.items() if k in self.arg_names # type: ignore } found_arg_names = kwargs.keys() for name in self.arg_names: if name not in found_arg_names: self.logger.warning(f"{name} is not a valid argument") kwargs[name] = None auth_result: Optional[AuthorizeResult] = await self.func(**kwargs) if auth_result is None: return auth_result if isinstance(auth_result, AuthorizeResult): return auth_result else: raise ValueError( f"Unexpected returned value from authorize function (type: {type(auth_result)})" ) except SlackApiError as err: self.logger.debug( f"The stored bot token for enterprise_id: {enterprise_id} team_id: {team_id} " f"is no longer valid. (response: {err.response})" ) return None
Ancestors
-
If you use the OAuth flow settings, this authorize implementation will be used. As long as your own InstallationStore (or the built-in ones) works as you expect, you can expect that the authorize layer should work for you without any customization.
Expand source code
class AsyncInstallationStoreAuthorize(AsyncAuthorize): """If you use the OAuth flow settings, this authorize implementation will be used. As long as your own InstallationStore (or the built-in ones) works as you expect, you can expect that the authorize layer should work for you without any customization. """ authorize_result_cache: Dict[str, AuthorizeResult] find_installation_available: Optional[bool] find_bot_available: Optional[bool] token_rotator: Optional[AsyncTokenRotator] _config_error_message: str = "AsyncInstallationStore with client_id/client_secret are required for token rotation" def __init__( self, *, logger: Logger, installation_store: AsyncInstallationStore, client_id: Optional[str] = None, client_secret: Optional[str] = None, token_rotation_expiration_minutes: Optional[int] = None, # For v1.0.x compatibility and people who still want its simplicity # use only InstallationStore#find_bot(enterprise_id, team_id) bot_only: bool = False, cache_enabled: bool = False, client: Optional[AsyncWebClient] = None, ): self.logger = logger self.installation_store = installation_store self.bot_only = bot_only self.cache_enabled = cache_enabled self.authorize_result_cache = {} self.find_installation_available = None self.find_bot_available = None if client_id is not None and client_secret is not None: self.token_rotator = AsyncTokenRotator( client_id=client_id, client_secret=client_secret, client=client, ) else: self.token_rotator = None self.token_rotation_expiration_minutes = ( token_rotation_expiration_minutes or 120 ) async def __call__( self, *, context: AsyncBoltContext, enterprise_id: Optional[str], team_id: Optional[str], # can be None for org-wide installed apps user_id: Optional[str], ) -> Optional[AuthorizeResult]: if self.find_installation_available is None: self.find_installation_available = hasattr( self.installation_store, "async_find_installation" ) if self.find_bot_available is None: self.find_bot_available = hasattr(self.installation_store, "async_find_bot") bot_token: Optional[str] = None user_token: Optional[str] = None if not self.bot_only and self.find_installation_available: # Since v1.1, this is the default way. # If you want to use find_bot / delete_bot only, you can set bot_only as True. try: # Note that this is the latest information for the org/workspace. # The installer may not be the user associated with this incoming request. latest_installation: Optional[ Installation ] = await self.installation_store.async_find_installation( enterprise_id=enterprise_id, team_id=team_id, is_enterprise_install=context.is_enterprise_install, ) # If the user_token in the latest_installation is not for the user associated with this request, # we'll fetch a different installation for the user below # The example use cases are: # - The app's installation requires both bot and user tokens # - The app has two installation paths 1) bot installation 2) individual user authorization this_user_installation: Optional[Installation] = None if latest_installation is not None: # Save the latest bot token bot_token = latest_installation.bot_token # this still can be None user_token = ( latest_installation.user_token ) # this still can be None if latest_installation.user_id != user_id: # First off, remove the user token as the installer is a different user latest_installation.user_token = None latest_installation.user_scopes = [] # try to fetch the request user's installation # to reflect the user's access token if exists this_user_installation = ( await self.installation_store.async_find_installation( enterprise_id=enterprise_id, team_id=team_id, user_id=user_id, is_enterprise_install=context.is_enterprise_install, ) ) if this_user_installation is not None: user_token = this_user_installation.user_token if latest_installation.bot_token is None: # If latest_installation has a bot token, we never overwrite the value bot_token = this_user_installation.bot_token # If token rotation is enabled, running rotation may be needed here refreshed = await self._rotate_and_save_tokens_if_necessary( this_user_installation ) if refreshed is not None: user_token = refreshed.user_token if latest_installation.bot_token is None: # If latest_installation has a bot token, we never overwrite the value bot_token = refreshed.bot_token # If token rotation is enabled, running rotation may be needed here refreshed = await self._rotate_and_save_tokens_if_necessary( latest_installation ) if refreshed is not None: bot_token = refreshed.bot_token if this_user_installation is None: # Only when we don't have `this_user_installation` here, # the `user_token` is for the user associated with this request user_token = refreshed.user_token except NotImplementedError as _: self.find_installation_available = False if ( # If you intentionally use only `find_bot` / `delete_bot`, self.bot_only # If the `find_installation` method is not available, or not self.find_installation_available # If the `find_installation` method did not return data and find_bot method is available, or ( self.find_bot_available is True and bot_token is None and user_token is None ) ): try: bot: Optional[Bot] = await self.installation_store.async_find_bot( enterprise_id=enterprise_id, team_id=team_id, is_enterprise_install=context.is_enterprise_install, ) if bot is not None: bot_token = bot.bot_token if bot.bot_refresh_token is not None: # Token rotation if self.token_rotator is None: raise BoltError(self._config_error_message) refreshed = await self.token_rotator.perform_bot_token_rotation( bot=bot, token_rotation_expiration_minutes=self.token_rotation_expiration_minutes, ) if refreshed is not None: await self.installation_store.async_save_bot(refreshed) bot_token = refreshed.bot_token except NotImplementedError as _: self.find_bot_available = False except Exception as e: self.logger.info(f"Failed to call find_bot method: {e}") token: Optional[str] = bot_token or user_token if token is None: # No valid token was found self._debug_log_for_not_found(enterprise_id, team_id) return None # Check cache to see if the bot object already exists if self.cache_enabled and token in self.authorize_result_cache: return self.authorize_result_cache[token] try: auth_test_api_response = await context.client.auth_test(token=token) authorize_result = AuthorizeResult.from_auth_test_response( auth_test_response=auth_test_api_response, bot_token=bot_token, user_token=user_token, ) if self.cache_enabled: self.authorize_result_cache[token] = authorize_result return authorize_result except SlackApiError as err: self.logger.debug( f"The stored bot token for enterprise_id: {enterprise_id} team_id: {team_id} " f"is no longer valid. (response: {err.response})" ) return None # ------------------------------------------------ def _debug_log_for_not_found( self, enterprise_id: Optional[str], team_id: Optional[str] ): self.logger.debug( "No installation data found " f"for enterprise_id: {enterprise_id} team_id: {team_id}" ) async def _rotate_and_save_tokens_if_necessary( self, installation: Optional[Installation] ) -> Optional[Installation]: if installation is None or ( installation.user_refresh_token is None and installation.bot_refresh_token is None ): # No need to rotate tokens return None if self.token_rotator is None: # Token rotation is required but this Bolt app is not properly configured raise BoltError(self._config_error_message) refreshed: Optional[ Installation ] = await self.token_rotator.perform_token_rotation( installation=installation, minutes_before_expiration=self.token_rotation_expiration_minutes, ) if refreshed is not None: # Save the refreshed data in database for following requests await self.installation_store.async_save(refreshed) return refreshed
Ancestors
Class variables