Configurer Okta pour OAuth externe¶

Ce chapitre décrit comment configurer Snowflake en tant que ressource OAuth et Okta en tant que serveur d’autorisation externe OAuth pour permettre un accès automatique sécurisé aux données Snowflake.

Procédure de configuration¶

Les cinq étapes suivantes supposent que votre environnement n’a rien configuré concernant les serveurs d’autorisation OAuth Okta, les clients OAuth, les champs d’application et les métadonnées nécessaires.

Les informations des étapes 1-3 seront utilisées pour créer une intégration de sécurité dans Snowflake.

Si vous avez déjà un serveur d’autorisation et un client Okta configurés, il n’est pas nécessaire de suivre toutes les étapes ci-dessous. Parcourez plutôt les quatre étapes suivantes et vérifiez que vous pouvez obtenir les informations souhaitées, créer des champs d’application, affecter des champs d’application à une ou plusieurs politiques et accéder aux métadonnées.

Si vous n’avez pas un serveur et un client d’autorisation Okta OAuth configurés, suivez les cinq étapes ci-dessous.

Important

Les étapes de ce chapitre sont un exemple représentatif de la configuration d’Okta pour OAuth externe.

Vous pouvez configurer Okta sur n’importe quel état souhaité et utiliser n’importe quel flux OAuth à condition que vous puissiez obtenir les informations nécessaires pour l” intégration de la sécurité (dans ce chapitre).

Notez que les étapes suivantes servent de guide pour obtenir les informations nécessaires à la création de l’intégration de sécurité dans Snowflake.

Assurez-vous de consulter vos politiques de sécurité internes concernant la configuration d’un serveur d’autorisation pour vous assurer que votre organisation respecte toutes les réglementations et exigences de conformité nécessaires.

Les étapes 1-3 sont tirées de la documentation Okta sur les serveurs d’autorisation. Pour plus d’informations sur la façon dont Okta définit ses termes, son interface utilisateur et les options relatives aux serveurs d’autorisation, consultez les guides Okta suivants :

Créer un client compatible OAuth à utiliser avec Snowflake¶

Accédez à la console d’administration Okta.
Cliquez sur Applications.
Cliquez sur Add Application.
Cliquez sur Create New App.
- Pour Platform, sélectionnez Native App.
Cliquez sur Create.
Saisissez un nom pour l’application.
Dans la zone Login redirect URIs, ajoutez l’URL complète du compte Snowflake (c’est-à-dire https://<identificateur_de_compte>.snowflakecomputing.com). Pour une liste des formats URL possibles, voir Connexion avec une URL.
Cliquez sur Save.
Depuis New Applications dans l’interface General, cliquez sur Edit.
Cochez Refresh Token et Resource Owner Password.
Cliquez sur Save.
Cliquez sur le bouton Edit à côté de Client Credentials.
Sélectionnez l’option Use Client Authentication.
Cliquez sur Save.
Dans le conteneur Client Credentials, enregistrez les ClientID et Secret. Ces deux valeurs seront appelées <OAUTH_CLIENT_ID> et <OAUTH_CLIENT_SECRET>, respectivement dans les étapes suivantes.

Créer un serveur d’autorisation OAuth¶

Accédez à la console d’administration Okta.
Dans le menu Security, cliquez sur API.
Cliquez sur Authorization Servers.
Cliquez sur Add Authorization Server.
Entrez un nom.
Entrez l’URL de compte Snowflake comme valeur Audience. Pour une liste des formats URL possibles, voir Connexion avec une URL.
Cliquez sur Save.

Effectuez les étapes suivantes pour le serveur d’autorisation nouvellement ajouté.

Copiez la valeur Issuer. Son format devrait ressembler à https://dev-390798.oktapreview.com/oauth2/auslh9j9vf9ej7NfT0h7. Cette valeur sera connue sous le nom de <OKTA_ISSUER> dans les étapes suivantes.
Cliquez sur Scopes.
Cliquez sur Add Scope.
Pour ajouter un rôle Snowflake en tant que champ d’application, entrez le champ d’application en ayant le nom du rôle Snowflake comme préfixe session:role: (par exemple : pour le rôle Analyste Snowflake, entrez session:role:analyst).
Cliquez sur Create.
Cliquez sur Access Policies.
Cliquez sur Add Policy.
Saisissez un nom et une description pour la politique. Attribuez-les au client créé précédemment et cliquez sur Create.
Dans la nouvelle politique d’accès ajoutée, cliquez sur Add Rule.
Saisissez un nom de règle.
Sélectionnez le Grant Types autorisé. Vous devez sélectionner Resource Owner Password et Client Credentials ainsi que tous ceux qui correspondent aux politiques de votre organisation.
Pour les champs d’application, vous pouvez sélectionner l’un des champs d’application ou sélectionner les champs d’application souhaités créés précédemment que les clients affectés à cette politique pourront demander (y compris accès_horsligne pour actualiser les jetons si nécessaire). Configurez tous les paramètres supplémentaires selon vos besoins.
Cliquez sur Create Rule.

Recueillir des informations sur Okta¶

Accédez à la console d’administration Okta.
Dans le menu Security, cliquez sur API.
Cliquez sur Authorization Servers.
Cliquez sur le serveur d’autorisation pour la ressource Snowflake.
Dans l’onglet Settings, copiez la valeur Issuer. Cette valeur sera connue sous le nom de <OKTA_ISSUER> dans les étapes suivantes. Son format devrait ressembler à https://dev-111111.oktapreview.com/oauth2/auslh9j9vf9ej7NfT0h7.

Dans le document Metadata :

Copiez la valeur Metadata URI , ouvrez un onglet de navigateur et collez l’URL dans la barre d’adresses.
Vous devriez voir le texte JSON dans le navigateur. Vous pouvez travailler avec ce texte dans un éditeur de texte ou dans le navigateur lui-même.
Recherchez le paramètre "jwks_uri" et copiez sa valeur. Son format devrait ressembler à https://dev-111111.oktapreview.com/oauth2/auslh9j9vf9ej7NfT0h7/v1/keys. Ce point de terminaison sera appelé <OKTA_JWS_KEY_ENDPOINT> dans les étapes suivantes.
Recherchez le paramètre "token_endpoint" et copiez sa valeur. Son format devrait ressembler à https://dev-111111.oktapreview.com/oauth2/auslh9j9vf9ej7NfT0h7/v1/token. Ce point de terminaison sera appelé <OKTA_OAUTH_TOKEN_ENDPOINT> dans les étapes suivantes.

Créer une intégration de sécurité pour Okta¶

Cette étape crée une intégration de sécurité dans Snowflake. L’intégration de sécurité garantit que Snowflake peut communiquer en toute sécurité avec Okta, valide les jetons d’Okta et fournit l’accès aux données Snowflake appropriées aux utilisateurs en fonction du rôle d’utilisateur associé au jeton OAuth.

Pour plus d’informations, voir CREATE SECURITY INTEGRATION.

Important

Seuls les administrateurs de compte (c’est-à-dire les utilisateurs dotés du rôle ACCOUNTADMIN) ou un rôle disposant du privilège global CREATE INTEGRATION peuvent exécuter cette commande SQL.

Les valeurs des paramètres d’intégration de sécurité sont sensibles à la casse et les valeurs que vous insérez dans l’intégration de sécurité doivent correspondre à ces valeurs dans votre environnement. Si la casse ne correspond pas, il est possible que le jeton d’accès ne soit pas validé, ce qui entraînera l’échec d’une tentative d’authentification.

Créer une intégration de sécurité avec des audiences

Le paramètre external_oauth_audience_list de l’intégration de sécurité doit correspondre à l” Audience que vous avez spécifiée lors de la configuration d’Okta.

create security integration external_oauth_okta_2
    type = external_oauth
    enabled = true
    external_oauth_type = okta
    external_oauth_issuer = '<OKTA_ISSUER>'
    external_oauth_jws_keys_url = '<OKTA_JWS_KEY_ENDPOINT>'
    external_oauth_audience_list = ('<snowflake_account_url')
    external_oauth_token_user_mapping_claim = 'sub'
    external_oauth_snowflake_user_mapping_attribute = 'login_name';

Copy

Modification de votre intégration de sécurité externe OAuth¶

Vous pouvez mettre à jour votre intégration de sécurité externe OAuth en exécutant une instruction ALTER sur l’intégration de sécurité.

Pour plus d’informations, voir ALTER SECURITY INTEGRATION (External OAuth).

Utilisation du rôle ANY avec External OAuth¶

Dans l’étape de configuration visant à créer une intégration de sécurité dans Snowflake, le jeton d’accès OAuth inclut la définition du champ d’application. Par conséquent, au moment de l’exécution, l’utilisation de l’intégration de sécurité externe OAuth ne permet ni au client OAuth ni à l’utilisateur d’utiliser un rôle non défini dans le jeton d’accès OAuth.

Après avoir validé le jeton d’accès et créé une session, le rôle ANY peut permettre au client et à l’utilisateur OAuth de décider de son rôle. Si nécessaire, le client ou l’utilisateur peut basculer vers un rôle différent de celui défini dans le jeton d’accès OAuth.

Pour configurer le rôle ANY, définissez le champ d’application en tant que SESSION:ROLE-ANY et configurez l’intégration de la sécurité avec le paramètre external_oauth_any_role_mode. Ce paramètre peut avoir trois valeurs de chaîne possibles :

DISABLE n’autorise pas le client ou l’utilisateur OAuth à changer de rôle (c’est-à-dire use role <rôle>;). Par défaut.
ENABLE permet au client ou à l’utilisateur OAuth de changer de rôle.
ENABLE_FOR_PRIVILEGE permet au client ou à l’utilisateur OAuth de changer de rôle uniquement pour un client ou un utilisateur avec le privilège USE_ANY_ROLE. Ce privilège peut être accordé et révoqué à un ou plusieurs rôles disponibles pour l’utilisateur. Par exemple :
```
grant USE_ANY_ROLE on integration external_oauth_1 to role1;
```
Copy
```
revoke USE_ANY_ROLE on integration external_oauth_1 from role1;
```
Copy

Définissez l’intégration de la sécurité comme suit :

create security integration external_oauth_1
    type = external_oauth
    enabled = true
    external_oauth_any_role_mode = 'ENABLE'
    ...

Copy

Utilisation de rôles secondaires avec External OAuth¶

La portée souhaitée pour le rôle primaire est transmise dans le jeton externe : soit le rôle par défaut de l’utilisateur (session:role-any), soit un rôle spécifique qui a été accordé à l’utilisateur (session:role:<nom_rôle>).

Par défaut, Snowflake n’active pas les rôles secondaires par défaut pour un utilisateur (c’est-à-dire le DEFAULT_SECONDARY_ROLES) de la session.

Pour activer les rôles secondaires par défaut pour un utilisateur dans une session et autoriser l’exécution de la commande USE SECONDARY ROLES tout en utilisant External OAuth, effectuez les étapes suivantes :

Configurez l’intégration de la sécurité pour la connexion. Définissez la valeur du paramètre EXTERNAL_OAUTH_ANY_ROLE_MODE comme ENABLE ou ENABLE_FOR_PRIVILEGE lorsque vous créez l’intégration de sécurité (à l’aide de CREATE SECURITY INTEGRATION) ou ultérieurement (à l’aide de ALTER SECURITY INTEGRATION).
Configurez le serveur d’autorisation pour passer la valeur statique de session:role-any dans l’attribut scope du jeton. Pour plus d’informations sur le paramètre de scope, voir Présentation de External OAuth.

Utilisation de la redirection des clients avec External OAuth¶

Snowflake prend en charge l’utilisation de la redirection des clients avec External OAuth, y compris l’utilisation de la redirection des clients et OAuth avec les clients Snowflake pris en charge.

Pour plus d’informations, voir Rediriger les connexions du client.

Utilisation de politiques réseau avec External OAuth¶

Actuellement, les politiques réseau ne peuvent pas être ajoutées à votre intégration de sécurité OAuth externe. Cependant, vous pouvez toujours mettre en œuvre des politiques de réseau qui s’appliquent largement à l’ensemble du compte Snowflake.

Si votre cas d’utilisation nécessite une politique réseau spécifique à l’intégration de sécurité OAuth, utilisez Snowflake OAuth. Cette approche permet à la politique réseau OAuth de Snowflake d’être distincte des autres politiques réseau qui peuvent s’appliquer au compte Snowflake.

Pour plus d’informations, voir Politiques réseau.

Utilisation de la réplication avec External OAuth¶

Snowflake prend en charge la réplication et le basculement/la restauration de l’intégration de sécurité External OAuth d’un compte source à un compte cible.

Pour plus de détails, voir Réplication des intégrations de sécurité et des politiques réseau sur plusieurs comptes.

Procédure de test¶

Dans le cadre du test de OAuth lors de l’utilisation d’Okta en tant que serveur d’autorisation, vous devez :

Vérifier que l’utilisateur de test existe dans Okta et possède un mot de passe.
Vérifier que l’utilisateur de test existe dans Snowflake avec la valeur d’attribut login_name définie sur <OKTA_USER_USERNAME>
Enregistrer un client OAuth.
Autorisez le client OAuth à faire une demande POST au point de terminaison de jeton Okta comme suit :
- Type d’autorisation défini sur Propriétaire de la ressource
- En-tête d’autorisation de base HTTP contenant le clientID et le secret
- Données FORM contenant le nom d’utilisateur et le mot de passe de l’utilisateur
- Inclure les champs d’application

L’exemple de commande demande à l’analyste et suppose que session:role:analyst a été défini dans Okta > OAuth App Resource.

Voici un exemple pour obtenir un jeton d’accès en utilisant cURL.

curl -X POST -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" \
  --user <OAUTH_CLIENT_ID>:<OAUTH_CLIENT_SECRET> \
  --data-urlencode "username=<OKTA_USER_USERNAME>" \
  --data-urlencode "password=<OKTA_USER_PASSWORD>" \
  --data-urlencode "grant_type=password" \
  --data-urlencode "scope=session:role:analyst" \
  <OKTA_OAUTH_TOKEN_ENDPOINT>

Copy

Connexion à Snowflake via OAuth externe¶

Après avoir configuré votre intégration de sécurité et obtenu votre jeton d’accès, vous pouvez vous connecter à Snowflake en utilisant l’un des éléments suivants :

Remarques :

Il est nécessaire de définir le paramètre authenticator sur oauth et le paramètre token sur external_oauth_access_token.
Lors du passage de la valeur token en tant que paramètre de requête URL, il est nécessaire d’encoder en URL la valeur token.
Lors du passage de la valeur token à un objet Propriétés (par exemple, pilote JDBC), aucune modification n’est nécessaire.

Par exemple, si vous utilisez le connecteur Python, définissez la chaîne de connexion comme indiqué ci-dessous.

ctx = snowflake.connector.connect(
   user="<username>",
   host="<hostname>",
   account="<account_identifier>",
   authenticator="oauth",
   token="<external_oauth_access_token>",
   warehouse="test_warehouse",
   database="test_db",
   schema="test_schema"
)

Copy

Vous pouvez maintenant utiliser OAuth externe pour vous connecter à Snowflake en toute sécurité.