Skip to content

Commit e616b12

Browse files
committed
docs: Updates docstring.
1 parent cb4fb63 commit e616b12

1 file changed

Lines changed: 11 additions & 14 deletions

File tree

securesystemslib/signer/_aws_signer.py

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,28 +29,26 @@
2929
class AWSSigner(Signer):
3030
"""AWS Key Management Service Signer
3131
32-
This Signer uses AWS KMS to sign. This signer supports signing with RSA and
33-
EC keys uses "ambient" credentials: typically environment variables such as
34-
AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN (if
35-
necessary). These will be recognized by the boto3 SDK, which underlies the
36-
aws_kms Python module.
32+
This Signer uses AWS KMS to sign and supports signing with RSA/EC keys and
33+
uses "ambient" credentials typically environment variables such as
34+
AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN. These will
35+
be recognized by the boto3 SDK, which underlies the aws_kms Python module.
3736
3837
For more details on AWS authentication, refer to the AWS Command Line
3938
Interface User Guide:
40-
https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html.
39+
https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html
4140
4241
Some practical authentication options include:
43-
AWS CLI: https://aws.amazon.com/cli/
44-
AWS SDKs: https://aws.amazon.com/tools/
42+
AWS CLI: https://aws.amazon.com/cli/
43+
AWS SDKs: https://aws.amazon.com/tools/
4544
4645
The specific permissions that AWS KMS signer needs are:
47-
kms:Sign for the sign()
48-
kms:GetPublicKey for the import()
46+
kms:Sign for sign()
47+
kms:GetPublicKey for import()
4948
5049
Arguments:
5150
aws_key_id (str): AWS KMS key ID or alias.
52-
public_key (Key): The related public key
53-
instance.
51+
public_key (Key): The related public key instance.
5452
5553
Returns:
5654
AWSSigner: An instance of the AWSSigner class.
@@ -59,8 +57,7 @@ class AWSSigner(Signer):
5957
UnsupportedAlgorithmError: If the payload hash algorithm is unsupported.
6058
BotoCoreError: Errors from the botocore.exceptions library.
6159
ClientError: Errors related to AWS KMS client.
62-
UnsupportedLibraryError: If necessary libraries for AWS KMS are not
63-
available.
60+
UnsupportedLibraryError: If necessary libraries for AWS KMS are not available.
6461
"""
6562

6663
SCHEME = "awskms"

0 commit comments

Comments
 (0)