==================================== aws-msk-iam-sasl-signer-python ==================================== |Version| |Python| |Build| |License| |SecurityScan| .. |Build| image:: https://github.com/aws/aws-msk-iam-sasl-signer-python/actions/workflows/run-tests.yml/badge.svg?branch=main :target: https://github.com/aws/aws-msk-iam-sasl-signer-python/actions/workflows/run-tests.yml :alt: Build status .. |Python| image:: https://img.shields.io/pypi/pyversions/aws-msk-iam-sasl-signer-python.svg?style=flat :target: https://pypi.python.org/pypi/aws-msk-iam-sasl-signer-python/ :alt: Python Versions .. |Version| image:: http://img.shields.io/pypi/v/aws-msk-iam-sasl-signer-python.svg?style=flat :target: https://pypi.python.org/pypi/aws-msk-iam-sasl-signer-python/ :alt: Package Version .. |License| image:: http://img.shields.io/pypi/l/aws-msk-iam-sasl-signer-python.svg?style=flat :target: https://github.com/aws/aws-msk-iam-sasl-signer-python/blob/main/LICENSE :alt: License .. |SecurityScan| image:: https://github.com/aws/aws-msk-iam-sasl-signer-python/actions/workflows/securityscan.yml/badge.svg?branch=main :target: https://github.com/aws/aws-msk-iam-sasl-signer-python/actions/workflows/securityscan.yml :alt: Security Scan This is an Amazon MSK Library in Python. This library provides a function to generates a base 64 encoded signed url to enable authentication/authorization with an MSK Cluster. The signed url is generated by using your IAM credentials. * Free software: Apache Software License 2.0 Features -------- * Provides a function to generate auth token using IAM credentials from the AWS default credentials chain. * Provides a function to generate auth token using IAM credentials from the AWS named profile. * Provides a function to generate auth token using assumed IAM role's credentials. * Provides a function to generate auth token using a CredentialProvider. The CredentialProvider should be inherited from botocore.credentials.CredentialProvider class. Get Started ----------- * For installation, refer to `installation guide`_ * In order to use the signer library with a Kafka client library with SASL/OAUTHBEARER mechanism, add the callback function in your code. * For example, here is the sample code to use with `dpkp/kafka-python`_ library: .. code-block:: python from kafka import KafkaProducer from kafka.errors import KafkaError import socket import time from aws_msk_iam_sasl_signer import MSKAuthTokenProvider class MSKTokenProvider(): def token(self): token, _ = MSKAuthTokenProvider.generate_auth_token('') return token tp = MSKTokenProvider() producer = KafkaProducer( bootstrap_servers='', security_protocol='SASL_SSL', sasl_mechanism='OAUTHBEARER', sasl_oauth_token_provider=tp, client_id=socket.gethostname(), ) topic = "" while True: try: inp=input(">") producer.send(topic, inp.encode()) producer.flush() print("Produced!") except Exception: print("Failed to send message:", e) producer.close() * Here is a sample consumer with `confluent-kafka-python`_ library : .. code-block:: python from confluent_kafka import Consumer import socket import time from aws_msk_iam_sasl_signer import MSKAuthTokenProvider def oauth_cb(oauth_config): auth_token, expiry_ms = MSKAuthTokenProvider.generate_auth_token("") # Note that this library expects oauth_cb to return expiry time in seconds since epoch, while the token generator returns expiry in ms return auth_token, expiry_ms/1000 c = Consumer({ "debug": "all", 'bootstrap.servers': "", 'client.id': socket.gethostname(), 'security.protocol': 'SASL_SSL', 'sasl.mechanisms': 'OAUTHBEARER', 'oauth_cb': oauth_cb, 'group.id': 'mygroup', 'auto.offset.reset': 'earliest' }) c.subscribe(['']) print("Starting consumer!") while True: msg = c.poll(5) if msg is None: continue if msg.error(): print("Consumer error: {}".format(msg.error())) continue print('Received message: {}'.format(msg.value().decode('utf-8'))) c.close() * In order to use a named profile to generate token, replace the token() function with code below : .. code-block:: python class MSKTokenProvider(): def token(self): oauth2_token, _ = MSKAuthTokenProvider.generate_auth_token_from_profile('', '') return oauth2_token * In order to use a role arn to generate token, replace the token() function with code below : .. code-block:: python class MSKTokenProvider(): def token(self): oauth2_token, _ = MSKAuthTokenProvider.generate_auth_token_from_role_arn('', '') return oauth2_token * In order to use a custom credentials provider, replace the token() function with code below : .. code-block:: python class MSKTokenProvider(): def token(self): oauth2_token, _ = MSKAuthTokenProvider.generate_auth_token_from_credentials_provider('', '', aws_debug_creds = True) .. code-block:: sh Credentials Identity: {UserId: ABCD:test124, Account: 1234567890, Arn: arn:aws:sts::1234567890:assumed-role/abc/test124} The log line provides the IAM Account, IAM user id and the ARN of the IAM Principal corresponding to the credential being used. Getting Help ------------ Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests. * Ask a `question `__ or open a `discussion `__. * If you think you may have found a bug, please open an `issue `__. * Open a support case with `AWS Support `__. This repository provides a pluggable library with any Python Kafka client for SASL/OAUTHBEARER mechanism. For more information about SASL/OAUTHBEARER mechanism please go to `KIP 255 `__. Opening Issues -------------- If you encounter a bug with the AWS MSK IAM SASL Signer for Python, we would like to hear about it. Search the `Issues `__ and see if others are also experiencing the same issue before opening a new issue. Please include the version of AWS MSK IAM SASL Signer for Python, Python, and OS you’re using. Please also include reproduction case when appropriate. The GitHub issues are intended for bug reports and feature requests. For help and questions with using AWS MSK IAM SASL Signer for Python, please make use of the resources listed in the Getting Help section. Keeping the list of open issues lean will help us respond in a timely manner. Contributing ------------ We value feedback and contributions from our community. Whether it's a bug report, new feature, correction, or additional documentation, we welcome your issues and pull requests. Please read through this `CONTRIBUTING `__ document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your contribution. More Resources -------------- * `NOTICE `__ * `Changelog `__ * `License `__ * `MSK Documentation `__ * `Issues `__ Credits ------- This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage .. _`dpkp/kafka-python`: https://github.com/dpkp/kafka-python .. _`installation guide`: https://github.com/aws/aws-msk-iam-sasl-signer-python/blob/main/docs/installation.rst .. _`confluent-kafka-python`: https://github.com/confluentinc/confluent-kafka-python ================= Changelog ================= 1.0.1 (2024-01-17) ------------------ * Expanding version dependency constraints 1.0.0 (2023-11-09) ------------------ * First release of AWS MSK IAM SASL Signer Python library.

aws-msk-iam-sasl-signer-python1.0.1

Package Downloads

Authors

Project URLs

Requires Python

Dependencies