문제 상황
Python의 boto3 라이브러리를 사용하여 AWS Secrets Manager에 저장된 특정 위치의 보안 키(시크릿)를 업데이트하는 방법을 알아보겠습니다.
해결 접근 방식 및 알고리즘
1단계: 예외 처리를 위해 boto3와 botocore의 예외 클래스를 임포트합니다.
2단계: 필수 파라미터는 secret_stored_location(시크릿이 저장된 위치)과 secret_key_pair(업데이트할 키-값 쌍)입니다. 이때 secret_key_pair는 반드시 딕셔너리(dict)가 아닌 문자열(string) 형태로 전달해야 합니다.
3단계: boto3를 사용하여 AWS 세션을 생성합니다. 기본 프로필에 region_name이 설정되어 있지 않다면, 세션 생성 시 명시적으로 리전 이름을 전달해야 합니다.
4단계: secretsmanager 서비스를 위한 AWS 클라이언트를 생성합니다.
5단계: update_secret 메서드를 호출하면서 secret_stored_location은 SecretId로, secret_key_pair는 SecretString으로 전달합니다.
6단계: 호출이 성공하면 업데이트된 시크릿의 메타데이터가 반환됩니다.
7단계: 시크릿 업데이트 중 문제가 발생할 경우 일반 예외(generic exception)를 처리하여 오류 원인을 명확히 파악할 수 있도록 합니다.
예제 코드
아래 코드를 사용하면 AWS Secrets Manager에서 시크릿을 업데이트할 수 있습니다.
import boto3
from botocore.exceptions import ClientError
def update_secret_details(secret_stored_location, secret_key_pair):
session = boto3.session.Session()
client = session.client('secretsmanager')
try:
response = client.update_secret(
SecretId=secret_stored_location,
SecretString=secret_key_pair
)
return response
except ClientError as e:
raise Exception("boto3 client error in update_secret_details: " + e.__str__())
except Exception as e:
raise Exception("Unexpected error in update_secret_details: " + e.__str__())
a = update_secret_details('/secrets/aws', '{"user_test1":"test"}')
print(a)
실행 결과
{'ARN': 'arn:aws:secretsmanager:us-east-1:***************:secret:/secrets/aws-wr1Aj6', 'Name': '/secrets/aws', 'VersionId': 'f5308bed-7c23-4d47-a32b-8f2a5f044e53', '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}}추가 참고 사항
update_secret API는 새로운 버전의 시크릿 값을 생성하는 대신 기존 시크릿의 메타데이터나 값을 수정합니다. 만약 시크릿 값 자체를 변경하고 버전 관리를 활용하고 싶다면 put_secret_value 메서드를 사용하는 것이 좋습니다. 또한, 운영 환경에서는 AWS IAM 권한 설정을 통해 secretsmanager:UpdateSecret 액션에 대한 접근을 최소 권한 원칙에 따라 제한하는 것이 보안상 안전합니다.