{"author":"Amazon Managed Streaming for Apache Kafka","author_email":null,"bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Natural Language :: English","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":"====================================\naws-msk-iam-sasl-signer-python\n====================================\n|Version| |Python| |Build| |License| |SecurityScan|\n\n.. |Build| image:: https://github.com/aws/aws-msk-iam-sasl-signer-python/actions/workflows/run-tests.yml/badge.svg?branch=main\n :target: https://github.com/aws/aws-msk-iam-sasl-signer-python/actions/workflows/run-tests.yml\n :alt: Build status\n.. |Python| image:: https://img.shields.io/pypi/pyversions/aws-msk-iam-sasl-signer-python.svg?style=flat\n :target: https://pypi.python.org/pypi/aws-msk-iam-sasl-signer-python/\n :alt: Python Versions\n.. |Version| image:: http://img.shields.io/pypi/v/aws-msk-iam-sasl-signer-python.svg?style=flat\n :target: https://pypi.python.org/pypi/aws-msk-iam-sasl-signer-python/\n :alt: Package Version\n.. |License| image:: http://img.shields.io/pypi/l/aws-msk-iam-sasl-signer-python.svg?style=flat\n :target: https://github.com/aws/aws-msk-iam-sasl-signer-python/blob/main/LICENSE\n :alt: License\n.. |SecurityScan| image:: https://github.com/aws/aws-msk-iam-sasl-signer-python/actions/workflows/securityscan.yml/badge.svg?branch=main\n :target: https://github.com/aws/aws-msk-iam-sasl-signer-python/actions/workflows/securityscan.yml\n :alt: Security Scan\n\n\nThis is an Amazon MSK Library in Python. This library provides a function to generates a base 64 encoded signed url\nto enable authentication/authorization with an MSK Cluster.\nThe signed url is generated by using your IAM credentials.\n\n\n* Free software: Apache Software License 2.0\n\nFeatures\n--------\n\n* Provides a function to generate auth token using IAM credentials from the AWS default credentials chain.\n* Provides a function to generate auth token using IAM credentials from the AWS named profile.\n* Provides a function to generate auth token using assumed IAM role's credentials.\n* Provides a function to generate auth token using a CredentialProvider. The CredentialProvider should be inherited from botocore.credentials.CredentialProvider class.\n\n\nGet Started\n-----------\n\n* For installation, refer to `installation guide`_\n\n* In order to use the signer library with a Kafka client library with SASL/OAUTHBEARER mechanism, add the callback function in your code.\n\n* For example, here is the sample code to use with `dpkp/kafka-python`_ library:\n\n.. code-block:: python\n\n from kafka import KafkaProducer\n from kafka.errors import KafkaError\n import socket\n import time\n from aws_msk_iam_sasl_signer import MSKAuthTokenProvider\n\n class MSKTokenProvider():\n def token(self):\n token, _ = MSKAuthTokenProvider.generate_auth_token('')\n return token\n\n tp = MSKTokenProvider()\n\n producer = KafkaProducer(\n bootstrap_servers='',\n security_protocol='SASL_SSL',\n sasl_mechanism='OAUTHBEARER',\n sasl_oauth_token_provider=tp,\n client_id=socket.gethostname(),\n )\n\n topic = \"\"\n while True:\n try:\n inp=input(\">\")\n producer.send(topic, inp.encode())\n producer.flush()\n print(\"Produced!\")\n except Exception:\n print(\"Failed to send message:\", e)\n\n producer.close()\n\n* Here is a sample consumer with `confluent-kafka-python`_ library :\n\n.. code-block:: python\n\n from confluent_kafka import Consumer\n import socket\n import time\n from aws_msk_iam_sasl_signer import MSKAuthTokenProvider\n\n def oauth_cb(oauth_config):\n auth_token, expiry_ms = MSKAuthTokenProvider.generate_auth_token(\"\")\n # Note that this library expects oauth_cb to return expiry time in seconds since epoch, while the token generator returns expiry in ms\n return auth_token, expiry_ms/1000\n\n c = Consumer({\n \"debug\": \"all\",\n 'bootstrap.servers': \"\",\n 'client.id': socket.gethostname(),\n 'security.protocol': 'SASL_SSL',\n 'sasl.mechanism': 'OAUTHBEARER',\n 'oauth_cb': oauth_cb,\n 'group.id': 'mygroup',\n 'auto.offset.reset': 'earliest'\n })\n\n c.subscribe([''])\n\n print(\"Starting consumer!\")\n\n while True:\n msg = c.poll(5)\n\n if msg is None:\n continue\n if msg.error():\n print(\"Consumer error: {}\".format(msg.error()))\n continue\n print('Received message: {}'.format(msg.value().decode('utf-8')))\n\n c.close()\n\n* In order to use a named profile to generate token, replace the token() function with code below :\n\n.. code-block:: python\n\n class MSKTokenProvider():\n def token(self):\n oauth2_token, _ = MSKAuthTokenProvider.generate_auth_token_from_profile('', '')\n return oauth2_token\n\n* In order to use a role arn to generate token, replace the token() function with code below :\n\n.. code-block:: python\n\n class MSKTokenProvider():\n def token(self):\n oauth2_token, _ = MSKAuthTokenProvider.generate_auth_token_from_role_arn('', '')\n return oauth2_token\n\n\n* In order to use a custom credentials provider, replace the token() function with code below :\n\n.. code-block:: python\n\n class MSKTokenProvider():\n def token(self):\n oauth2_token, _ = MSKAuthTokenProvider.generate_auth_token_from_credentials_provider('', '', aws_debug_creds = True)\n\n\n.. code-block:: sh\n\n Credentials Identity: {UserId: ABCD:test124, Account: 1234567890, Arn: arn:aws:sts::1234567890:assumed-role/abc/test124}\n\n\nThe log line provides the IAM Account, IAM user id and the ARN of the IAM Principal corresponding to the credential being used.\n\nGetting Help\n------------\n\nPlease use these community resources for getting help. We use the GitHub issues\nfor tracking bugs and feature requests.\n\n* Ask a `question `__ or open a `discussion `__.\n* If you think you may have found a bug, please open an `issue `__.\n* Open a support case with `AWS Support `__.\n\nThis 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 `__.\n\nOpening Issues\n--------------\n\nIf you encounter a bug with the AWS MSK IAM SASL Signer for Python, we would like to hear about it.\nSearch the `Issues `__ and see\nif others are also experiencing the same issue before opening a new issue. Please\ninclude the version of AWS MSK IAM SASL Signer for Python, Python, and OS you’re using. Please\nalso include reproduction case when appropriate.\n\nThe GitHub issues are intended for bug reports and feature requests. For help\nand questions with using AWS MSK IAM SASL Signer for Python, please make use of the resources listed\nin the Getting Help section.\nKeeping the list of open issues lean will help us respond in a timely manner.\n\nContributing\n------------\n\nWe 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.\n\nMore Resources\n--------------\n\n* `NOTICE `__\n* `Changelog `__\n* `License `__\n* `MSK Documentation `__\n* `Issues `__\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n.. _`dpkp/kafka-python`: https://github.com/dpkp/kafka-python\n.. _`installation guide`: https://github.com/aws/aws-msk-iam-sasl-signer-python/blob/main/docs/installation.rst\n.. _`confluent-kafka-python`: https://github.com/confluentinc/confluent-kafka-python\n\n\n# Changelog\n\n## 1.0.2 (2025-03-04)\n\n* Add support for more Python versions\n\n## 1.0.1 (2024-01-17)\n\n* Expanding version dependency constraints\n\n## 1.0.0 (2023-11-09)\n\n* First release of AWS MSK IAM SASL Signer Python library.\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["Author","Classifier","Description","Description-Content-Type","Home-Page","Keywords","License","Provides-Extra","Requires-Dist","Requires-Python","Summary"],"home_page":"https://github.com/aws/aws-msk-iam-sasl-signer-python","keywords":"aws-msk-iam-sasl-signer-python","license":"Apache Software License 2.0","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"aws-msk-iam-sasl-signer-python","package_url":"https://pypi.org/project/aws-msk-iam-sasl-signer-python/","platform":null,"project_url":"https://pypi.org/project/aws-msk-iam-sasl-signer-python/","project_urls":{"Homepage":"https://github.com/aws/aws-msk-iam-sasl-signer-python"},"provides_extra":["test"],"release_url":"https://pypi.org/project/aws-msk-iam-sasl-signer-python/1.0.2/","requires_dist":["Click>=7.0","boto3>=1.26.125","botocore>=1.29.125","pytest==7.3.1; extra == \"test\"","pytest-cov==4.0.0; extra == \"test\"","coverage==7.2.5; extra == \"test\"","mock==5.0.2; extra == \"test\""],"requires_python":">=3.8","summary":"Amazon MSK Library in Python for SASL/OAUTHBEARER Auth","version":"1.0.2","yanked":false,"yanked_reason":null}

Dependency	Optional
boto3	false
botocore	false
Click	false
coverage	true
mock	true
pytest	true
pytest-cov	true

Package search

aws-msk-iam-sasl-signer-python

project_urls

Dependencies

All package metadata

Releases