Récapitulatif de la prise en charge de tous les clients recommandés

Connexion de votre client à Event Streams

Pour savoir comment configurer votre client Java pour se connecter à Event Streams, voir Configuration de votre client.

Utilisation de SASL PLAIN

Utilisez les chaînes et propriétés suivantes.

• Utilisez la chaîne bootstrap_endpoints comme liste de serveurs d'amorçage et transmettez cette chaîne de paires hôte-port à votre client Kafka.
• Utilisez les propriétés user et api_key comme nom d'utilisateur et mot de passe.

Pour un client Java, l'exemple suivant montre l'ensemble minimal de propriétés, où ${USERNAME}, ${PASSWORD}, et ${BOOTSTRAP_ENDPOINTS} doivent être remplacés par les valeurs que vous avez récupérées précédemment.

bootstrap.servers=${BOOTSTRAP_ENDPOINTS}
sasl.mechanism=PLAIN
sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username="${USERNAME}" password="${PASSWORD}";
security.protocol=SASL_SSL
ssl.protocol=TLSv1.2
ssl.enabled.protocols=TLSv1.2
ssl.endpoint.identification.algorithm=HTTPS

Si vous utilisez un client Kafka antérieur à la version 0.10.2.1, la propriété sasl.jaas.config n'est pas prise en charge et vous devez fournir la configuration du client dans un fichier de configuration JAAS.

Utilisation de SASL OAUTHBEARER

Avant de configurer le mécanisme SASL pour le client Java, deux conditions sont requises.

• La version minimale du client Kafka Java prise en charge est 3.1.0.
• Un package jar supplémentaire doit être téléchargé à partir de Maven Central et mis à disposition dans le chemin d'accès aux classes.

Si Maven est utilisé dans le système de génération, ajoutez les informations suivantes au fichier pom.xml dans la section des dépendances.

<dependency>
    <groupId>com.ibm.cloud.eventstreams</groupId>
    <artifactId>oauth-client</artifactId>
    <version>1.3.1</version>
</dependency>

Si Gradle est utilisé dans le système de génération, ajoutez les informations suivantes au fichier build.gradle dans la section des dépendances.

implementation com.ibm.cloud.eventstreams:oauth-client:1.3.1

Utilisez les chaînes et propriétés suivantes.

• Utilisez la chaîne bootstrap_endpoints comme liste de serveurs d'amorçage et transmettez cette chaîne de paires hôte-port à votre client Kafka.
• Utilisez la chaîne api_key comme clé d'API.
• Le fichier IAMOAuthBearerLoginCallbackHandler est fourni par le package jar com.ibm.cloud.eventstreams:oauth-client:+.
• Le IBM Cloud® Identity and Access Management https://iam.cloud.ibm.com/identity/token est configuré pour générer un jeton à partir de la clé d'API à l'aide du type d'octroi spécifié dans la configuration jaas. Elle est effectuée côté client, de sorte que la clé d'API n'est jamais envoyée côté serveur et offre une meilleure sécurité qu'une clé d'API à durée de vie longue.
• Le noeud final de clé Cloud Identity and Access Management https://iam.cloud.ibm.com/identity/keys est configuré pour valider le jeton.

Pour un client Java, l'exemple suivant montre l'ensemble minimal de propriétés, où ${BOOTSTRAP_ENDPOINTS} et ${APIKEY} doivent être remplacés par les valeurs que vous avez récupérées précédemment.

bootstrap.servers=${BOOTSTRAP_ENDPOINTS}
sasl.mechanism=OAUTHBEARER
sasl.jaas.config=org.apache.kafka.common.security.oauthbearer.OAuthBearerLoginModule required grant_type="urn:ibm:params:oauth:grant-type:apikey" apikey="${APIKEY}";
sasl.login.callback.handler.class=com.ibm.eventstreams.oauth.client.IAMOAuthBearerLoginCallbackHandler
sasl.oauthbearer.token.endpoint.url=https://iam.cloud.ibm.com/identity/token
sasl.oauthbearer.jwks.endpoint.url=https://iam.cloud.ibm.com/identity/keys
security.protocol=SASL_SSL
ssl.protocol=TLSv1.2
ssl.enabled.protocols=TLSv1.2
ssl.endpoint.identification.algorithm=HTTPS

L'exemple de code fait référence aux exemplesEvent Streams.

Pour d'autres bibliothèques client Kafka, consultez leur documentation sur l'implémentation de la prise en charge d'OAUTHBEARER. Par exemple:.

• sarama: une implémentation de l'interface AccessTokenProvider est requise.
• librdkafka: une implémentation du rappel oauthbearer_token_refresh_cb est requise.

Pour plus d'informations sur la génération d'un jeton IBM Cloud IAM à l'aide d'une clé d'API, voir IBM Cloud® Identity and Access Management document.