PythonのBoto3を使ってAWS Secrets Managerからシークレットの詳細情報を取得する方法

課題

Pythonのboto3ライブラリを使用して、AWS Secrets Manager（AWSシークレットマネージャー）の特定の場所に保存されているシークレットの詳細情報を取得します。

解決のための手順・アルゴリズム

• ステップ1： boto3とbotocoreの例外クラスをインポートし、例外処理に備えます。

• ステップ2： secret_stored_location（シークレットが保存されている場所）は必須パラメータです。

• ステップ3： boto3ライブラリを使ってAWSセッションを作成します。デフォルトプロファイルにregion_nameが設定されていない場合は、セッション作成時に明示的にregion_nameを指定してください。

• ステップ4： secretmanager用のAWSクライアントを作成します。

• ステップ5： describe_secretを呼び出し、secret_stored_locationをSecretIdとして渡します。

• ステップ6： シークレットのメタデータが返却されます。

• ステップ7： シークレット情報の取得中に問題が発生した場合に備え、汎用的な例外処理を実装します。

サンプルコード

以下のコードを使用すると、AWS Secrets Manager内のシークレット詳細情報を取得できます。

import boto3
from botocore.exceptions import ClientError

def get_secret_details(secret_stored_location):
    session = boto3.session.Session()
    s3_client = session.client('secretmanager')
    try:
        response = s3_client.describe_secret(SecretId=secret_stored_location)
        return response
    except ClientError as e:
        raise Exception("boto3 client error in get_secret_details: " + e.__str__())
    except Exception as e:
        raise Exception("Unexpected error in get_secret_details: " + e.__str__())

a = get_secret_details('/secrets/aws')
print(a)

実行結果

{'ARN': 'arn:aws:secretsmanager:us-east-1:***************:secret:/secrets/aws-wr1Aj6', 'Name': '/secrets/aws', 'LastChangedDate': datetime.datetime(2021, 4, 3, 17, 6, 57, 601000, tzinfo=tzlocal()), 'LastAccessedDate': datetime.datetime(2021, 4, 3, 5, 30, tzinfo=tzlocal()), 'VersionIdsToStages': {'f5308bed-7c23-4d47-a32b-8f2a5f044e53': ['AWSCURRENT'], 'fcdc1b5b-2a35-4d12-9d84-65d529651d2e': ['AWSPREVIOUS']}, 'ResponseMetadata': {'RequestId': 'b32fe48d**************ab', 'HTTPStatusCode': 200, 'HTTPHeaders': {'date': 'Sat, 03 Apr 2021 09:40:48 GMT', 'content-type': 'application/x-amz-json-1.1', 'content-length': '197', 'connection': 'keep-alive', 'x-amzn-requestid': *********************************}, 'RetryAttempts': 0}}

補足説明

describe_secret APIは、シークレットそのものではなく、そのメタデータを返す点に注意してください。返却される主な情報は以下のとおりです。

• ARN： シークレットを一意に識別するAmazonリソースネーム。

• Name： シークレットの名前。

• LastChangedDate / LastAccessedDate： 最終更新日時および最終アクセス日時。

• VersionIdsToStages： 各バージョンIDと、それに紐づくステージラベル（AWSCURRENT＝現行バージョン、AWSPREVIOUS＝前バージョンなど）。

なお、シークレットの実際の値（機密文字列）を取得したい場合は、get_secret_value APIを使用してください。また、本番環境では認証情報の管理にIAMロールや環境変数を活用し、アクセスキーをコードに直接記述しないことを推奨します。