View Source AWS.Signer (aws-elixir v1.0.0)

AWS Signer is a fully managed code-signing service to help you ensure the trust and integrity of your code.

Signer supports the following applications:

With code signing for AWS Lambda, you can sign AWS Lambda deployment packages. Integrated support is provided for Amazon S3, Amazon CloudWatch, and AWS CloudTrail. In order to sign code, you create a signing profile and then use Signer to sign Lambda zip files in S3.

With code signing for IoT, you can sign code for any IoT device that is supported by AWS. IoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code-signing certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management.

With Signer and the Notation CLI from the Notary Project, you can sign container images stored in a container registry such as Amazon Elastic Container Registry (ECR). The signatures are stored in the registry alongside the images, where they are available for verifying image authenticity and integrity.

For more information about Signer, see the AWS Signer Developer Guide.

Summary

Functions

add_profile_permission(client, profile_name, input, options \\ [])

Adds cross-account permissions to a signing profile.

cancel_signing_profile(client, profile_name, input, options \\ [])

Changes the state of an ACTIVE signing profile to CANCELED.

describe_signing_job(client, job_id, options \\ [])

Returns information about a specific code signing job.

get_revocation_status(client, certificate_hashes, job_arn, platform_id, profile_version_arn, signature_timestamp, options \\ [])

Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.

get_signing_platform(client, platform_id, options \\ [])

Returns information on a specific signing platform.

get_signing_profile(client, profile_name, profile_owner \\ nil, options \\ [])

Returns information on a specific signing profile.

list_profile_permissions(client, profile_name, next_token \\ nil, options \\ [])

Lists the cross-account permissions associated with a signing profile.

list_signing_jobs(client, is_revoked \\ nil, job_invoker \\ nil, max_results \\ nil, next_token \\ nil, platform_id \\ nil, requested_by \\ nil, signature_expires_after \\ nil, signature_expires_before \\ nil, status \\ nil, options \\ [])

Lists all your signing jobs.

list_signing_platforms(client, category \\ nil, max_results \\ nil, next_token \\ nil, partner \\ nil, target \\ nil, options \\ [])

Lists all signing platforms available in AWS Signer that match the request parameters.

list_signing_profiles(client, include_canceled \\ nil, max_results \\ nil, next_token \\ nil, platform_id \\ nil, statuses \\ nil, options \\ [])

Lists all available signing profiles in your AWS account.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of the tags associated with a signing profile resource.

metadata()

put_signing_profile(client, profile_name, input, options \\ [])

Creates a signing profile.

remove_profile_permission(client, profile_name, statement_id, input, options \\ [])

Removes cross-account permissions from a signing profile.

revoke_signature(client, job_id, input, options \\ [])

Changes the state of a signing job to REVOKED.

revoke_signing_profile(client, profile_name, input, options \\ [])

Changes the state of a signing profile to REVOKED.

sign_payload(client, input, options \\ [])

Signs a binary payload and returns a signature envelope.

start_signing_job(client, input, options \\ [])

Initiates a signing job to be performed on the code provided.

tag_resource(client, resource_arn, input, options \\ [])

Adds one or more tags to a signing profile.

untag_resource(client, resource_arn, input, options \\ [])

Removes one or more tags from a signing profile.

Functions

add_profile_permission(client, profile_name, input, options \\ [])

Adds cross-account permissions to a signing profile.

cancel_signing_profile(client, profile_name, input, options \\ [])

Changes the state of an ACTIVE signing profile to CANCELED.

A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

describe_signing_job(client, job_id, options \\ [])

Returns information about a specific code signing job.

You specify the job by using the jobId value that is returned by the StartSigningJob operation.

get_revocation_status(client, certificate_hashes, job_arn, platform_id, profile_version_arn, signature_timestamp, options \\ [])

Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.

get_signing_platform(client, platform_id, options \\ [])

Returns information on a specific signing platform.

get_signing_profile(client, profile_name, profile_owner \\ nil, options \\ [])

Returns information on a specific signing profile.

list_profile_permissions(client, profile_name, next_token \\ nil, options \\ [])

Lists the cross-account permissions associated with a signing profile.

list_signing_jobs(client, is_revoked \\ nil, job_invoker \\ nil, max_results \\ nil, next_token \\ nil, platform_id \\ nil, requested_by \\ nil, signature_expires_after \\ nil, signature_expires_before \\ nil, status \\ nil, options \\ [])

Lists all your signing jobs.

You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

list_signing_platforms(client, category \\ nil, max_results \\ nil, next_token \\ nil, partner \\ nil, target \\ nil, options \\ [])

Lists all signing platforms available in AWS Signer that match the request parameters.

If additional jobs remain to be listed, Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

list_signing_profiles(client, include_canceled \\ nil, max_results \\ nil, next_token \\ nil, platform_id \\ nil, statuses \\ nil, options \\ [])

Lists all available signing profiles in your AWS account.

Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of the tags associated with a signing profile resource.

metadata()

put_signing_profile(client, profile_name, input, options \\ [])

Creates a signing profile.

A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.

remove_profile_permission(client, profile_name, statement_id, input, options \\ [])

Removes cross-account permissions from a signing profile.

revoke_signature(client, job_id, input, options \\ [])

Changes the state of a signing job to REVOKED.

This indicates that the signature is no longer valid.

revoke_signing_profile(client, profile_name, input, options \\ [])

Changes the state of a signing profile to REVOKED.

This indicates that signatures generated using the signing profile after an effective start date are no longer valid.

sign_payload(client, input, options \\ [])

Signs a binary payload and returns a signature envelope.

start_signing_job(client, input, options \\ [])

Initiates a signing job to be performed on the code provided.

Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the Amazon S3 Getting Started Guide*.

* Your S3 source bucket must be version enabled.

* You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

* You specify the name of the source and destination buckets when calling the StartSigningJob operation.

* You must also specify a request token that identifies your request to Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see StartSigningJob.

tag_resource(client, resource_arn, input, options \\ [])

Adds one or more tags to a signing profile.

Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair.

untag_resource(client, resource_arn, input, options \\ [])

Removes one or more tags from a signing profile.

To remove the tags, specify a list of tag keys.