@datafire/amazonaws_signer

Client library for AWS Signer

Installation and Usage

npm install --save @datafire/amazonaws_signer

let amazonaws_signer = require('@datafire/amazonaws_signer').create({
  hmac: ""
});

amazonaws_signer.ListSigningJobs({
  "body": {},
  "Action": "",
  "Version": ""
}).then(data => {
  console.log(data);
});

Description

You can use Code Signing for Amazon FreeRTOS (AWS Signer) to sign code that you created for any of the IoT devices that Amazon Web Services supports. AWS Signer is integrated with Amazon FreeRTOS, AWS Certificate Manager, and AWS CloudTrail. Amazon FreeRTOS customers can use AWS Signer to sign code images before making them available for microcontrollers. You can use ACM to import third-party certificates to be used by AWS Signer. For general information about using AWS Signer, see the Code Signing for Amazon FreeRTOS Developer Guide.

Actions

ListSigningJobs

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 AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

amazonaws_signer.ListSigningJobs({
  "body": {},
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required ListSigningJobsRequest
  • maxResults string: Pagination limit
  • nextToken string: Pagination token
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output ListSigningJobsResponse

StartSigningJob

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 Create 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 AWS 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 http://docs.aws.amazon.com/acm/latest/userguide/

amazonaws_signer.StartSigningJob({
  "body": {
    "source": {},
    "destination": {},
    "clientRequestToken": ""
  },
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required StartSigningJobRequest
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output StartSigningJobResponse

DescribeSigningJob

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

amazonaws_signer.DescribeSigningJob({
  "body": {},
  "jobId": "",
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required DescribeSigningJobRequest
  • jobId required string
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output DescribeSigningJobResponse

ListSigningPlatforms

Lists all signing platforms available in AWS Signer that match the request parameters. 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 AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

amazonaws_signer.ListSigningPlatforms({
  "body": {},
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required ListSigningPlatformsRequest
  • maxResults string: Pagination limit
  • nextToken string: Pagination token
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output ListSigningPlatformsResponse

GetSigningPlatform

Returns information on a specific signing platform.

amazonaws_signer.GetSigningPlatform({
  "body": {},
  "platformId": "",
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required GetSigningPlatformRequest
  • platformId required string
  • platformId_query string
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output GetSigningPlatformResponse

ListSigningProfiles

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 AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

amazonaws_signer.ListSigningProfiles({
  "body": {},
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required ListSigningProfilesRequest
  • maxResults string: Pagination limit
  • nextToken string: Pagination token
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output ListSigningProfilesResponse

CancelSigningProfile

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.

amazonaws_signer.CancelSigningProfile({
  "body": {},
  "profileName": "",
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required CancelSigningProfileRequest
  • profileName required string
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

Output schema unknown

GetSigningProfile

Returns information on a specific signing profile.

amazonaws_signer.GetSigningProfile({
  "body": {},
  "profileName": "",
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required GetSigningProfileRequest
  • profileName required string
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output GetSigningProfileResponse

PutSigningProfile

Creates a signing profile. A signing profile is an AWS Signer template that can be used to carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html

amazonaws_signer.PutSigningProfile({
  "body": {
    "signingMaterial": {
      "certificateArn": ""
    },
    "platformId": ""
  },
  "profileName": "",
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required PutSigningProfileRequest
  • profileName required string
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output PutSigningProfileResponse

Definitions

AccessDeniedException

BucketName

• BucketName string

CancelSigningProfileRequest

• CancelSigningProfileRequest object

Category

• Category string (values: AWSIoT)

CertificateArn

• CertificateArn string

ClientRequestToken

• ClientRequestToken string

CompletedAt

• CompletedAt string

CreatedAt

• CreatedAt string

DescribeSigningJobRequest

• DescribeSigningJobRequest object

DescribeSigningJobResponse

• DescribeSigningJobResponse object
  • completedAt CompletedAt
  • createdAt CreatedAt
  • jobId JobId
  • overrides SigningPlatformOverrides
  • platformId PlatformId
  • profileName ProfileName
  • requestedBy RequestedBy
  • signedObject SignedObject
  • signingMaterial SigningMaterial
  • signingParameters SigningParameters
  • source Source
  • status SigningStatus
  • statusReason StatusReason

Destination

• Destination object: Points to an S3Destination object that contains information about your S3 bucket.
  • s3 S3Destination

DisplayName

• DisplayName string

EncryptionAlgorithm

• EncryptionAlgorithm string (values: RSA, ECDSA)

EncryptionAlgorithmOptions

• EncryptionAlgorithmOptions object: The encryption algorithm options that are available to an AWS Signer job.
  • allowedValues required EncryptionAlgorithms
  • defaultValue required EncryptionAlgorithm

EncryptionAlgorithms

• EncryptionAlgorithms array
  • items EncryptionAlgorithm

GetSigningPlatformRequest

• GetSigningPlatformRequest object

GetSigningPlatformResponse

• GetSigningPlatformResponse object
  • category Category
  • displayName DisplayName
  • maxSizeInMB MaxSizeInMB
  • partner String
  • platformId PlatformId
  • signingConfiguration SigningConfiguration
  • signingImageFormat SigningImageFormat
  • target String

GetSigningProfileRequest

• GetSigningProfileRequest object

GetSigningProfileResponse

• GetSigningProfileResponse object
  • overrides SigningPlatformOverrides
  • platformId PlatformId
  • profileName ProfileName
  • signingMaterial SigningMaterial
  • signingParameters SigningParameters
  • status SigningProfileStatus

HashAlgorithm

• HashAlgorithm string (values: SHA1, SHA256)

HashAlgorithmOptions

• HashAlgorithmOptions object: The hash algorithms that are available to an AWS Signer job.
  • allowedValues required HashAlgorithms
  • defaultValue required HashAlgorithm

HashAlgorithms

• HashAlgorithms array
  • items HashAlgorithm

ImageFormat

• ImageFormat string (values: JSON)

ImageFormats

• ImageFormats array
  • items ImageFormat

InternalServiceErrorException

JobId

• JobId string

Key

• Key string

ListSigningJobsRequest

• ListSigningJobsRequest object

ListSigningJobsResponse

• ListSigningJobsResponse object
  • jobs SigningJobs
  • nextToken NextToken

ListSigningPlatformsRequest

• ListSigningPlatformsRequest object

ListSigningPlatformsResponse

• ListSigningPlatformsResponse object
  • nextToken String
  • platforms SigningPlatforms

ListSigningProfilesRequest

• ListSigningProfilesRequest object

ListSigningProfilesResponse

• ListSigningProfilesResponse object
  • nextToken NextToken
  • profiles SigningProfiles

MaxResults

• MaxResults integer

MaxSizeInMB

• MaxSizeInMB integer

NextToken

• NextToken string

PlatformId

• PlatformId string

Prefix

• Prefix string

ProfileName

• ProfileName string

PutSigningProfileRequest

• PutSigningProfileRequest object
  • overrides SigningPlatformOverrides
  • platformId required PlatformId
  • signingMaterial required SigningMaterial
  • signingParameters SigningParameters

PutSigningProfileResponse

• PutSigningProfileResponse object
  • arn string

RequestedBy

• RequestedBy string

ResourceNotFoundException

S3Destination

• S3Destination object: The name and prefix of the S3 bucket where AWS Signer saves your signed objects.
  • bucketName BucketName
  • prefix Prefix

S3SignedObject

• S3SignedObject object: The S3 bucket name and key where AWS Signer saved your signed code image.
  • bucketName BucketName
  • key key

S3Source

• S3Source object: Information about the S3 bucket where you saved your unsigned code.
  • bucketName required BucketName
  • key required Key
  • version required Version

SignedObject

• SignedObject object: Points to an S3SignedObject object that contains information about your signed code image.
  • s3 S3SignedObject

SigningConfiguration

• SigningConfiguration object: The configuration of an AWS Signer operation.
  • encryptionAlgorithmOptions required EncryptionAlgorithmOptions
  • hashAlgorithmOptions required HashAlgorithmOptions

SigningConfigurationOverrides

• SigningConfigurationOverrides object: A signing configuration that overrides the default encryption or hash algorithm of a signing job.
  • encryptionAlgorithm EncryptionAlgorithm
  • hashAlgorithm HashAlgorithm

SigningImageFormat

• SigningImageFormat object: The image format of an AWS Signer platform or profile.
  • defaultFormat required ImageFormat
  • supportedFormats required ImageFormats

SigningJob

• SigningJob object: Contains information about a signing job.
  • createdAt CreatedAt
  • jobId JobId
  • signedObject SignedObject
  • signingMaterial SigningMaterial
  • source Source
  • status SigningStatus

SigningJobs

• SigningJobs array
  • items SigningJob

SigningMaterial

• SigningMaterial object: The ACM certificate that is used to sign your code.
  • certificateArn required CertificateArn

SigningParameterKey

• SigningParameterKey string

SigningParameterValue

• SigningParameterValue string

SigningParameters

• SigningParameters array
  • items object
    • key SigningParameterKey
    • value SigningParameterValue

SigningPlatform

• SigningPlatform object: Contains information about the signing configurations and parameters that is used to perform an AWS Signer job.
  • category Category
  • displayName String
  • maxSizeInMB MaxSizeInMB
  • partner String
  • platformId String
  • signingConfiguration SigningConfiguration
  • signingImageFormat SigningImageFormat
  • target String

SigningPlatformOverrides

• SigningPlatformOverrides object: Any overrides that are applied to the signing configuration of an AWS Signer platform.
  • signingConfiguration SigningConfigurationOverrides

SigningPlatforms

• SigningPlatforms array
  • items SigningPlatform

SigningProfile

• SigningProfile object: Contains information about the ACM certificates and AWS Signer configuration parameters that can be used by a given AWS Signer user.
  • platformId PlatformId
  • profileName ProfileName
  • signingMaterial SigningMaterial
  • signingParameters SigningParameters
  • status SigningProfileStatus

SigningProfileStatus

• SigningProfileStatus string (values: Active, Canceled)

SigningProfiles

• SigningProfiles array
  • items SigningProfile

SigningStatus

• SigningStatus string (values: InProgress, Failed, Succeeded)

Source

• Source object: An S3Source object that contains information about the S3 bucket where you saved your unsigned code.
  • s3 S3Source

StartSigningJobRequest

• StartSigningJobRequest object
  • clientRequestToken required ClientRequestToken
  • destination required Destination
  • profileName ProfileName
  • source required Source

StartSigningJobResponse

• StartSigningJobResponse object
  • jobId JobId

StatusReason

• StatusReason string

String

• String string

ThrottlingException

ValidationException

Version

• Version string

bool

• bool boolean

key

• key string

string

• string string