package signer
import "github.com/aws/aws-sdk-go-v2/service/signer"
Package signer provides the API client, operations, and parameter types for AWS Signer.
With code signing for IoT, you can sign code that you create for any IoT device that is supported by Amazon Web Services (AWS). Code signing is available through Amazon FreeRTOS (http://docs.aws.amazon.com/freertos/latest/userguide/) and AWS IoT Device Management (http://docs.aws.amazon.com/iot/latest/developerguide/), and integrated with AWS Certificate Manager (ACM) (http://docs.aws.amazon.com/acm/latest/userguide/). In order to sign code, you import a third-party code signing certificate with ACM that is used to sign updates in Amazon FreeRTOS and AWS IoT Device Management. For general information about using code signing, see the Code Signing for IoT Developer Guide (http://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html).
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type CancelSigningProfileInput
- type CancelSigningProfileOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CancelSigningProfile(ctx context.Context, params *CancelSigningProfileInput, optFns ...func(*Options)) (*CancelSigningProfileOutput, error)
- func (c *Client) DescribeSigningJob(ctx context.Context, params *DescribeSigningJobInput, optFns ...func(*Options)) (*DescribeSigningJobOutput, error)
- func (c *Client) GetSigningPlatform(ctx context.Context, params *GetSigningPlatformInput, optFns ...func(*Options)) (*GetSigningPlatformOutput, error)
- func (c *Client) GetSigningProfile(ctx context.Context, params *GetSigningProfileInput, optFns ...func(*Options)) (*GetSigningProfileOutput, error)
- func (c *Client) ListSigningJobs(ctx context.Context, params *ListSigningJobsInput, optFns ...func(*Options)) (*ListSigningJobsOutput, error)
- func (c *Client) ListSigningPlatforms(ctx context.Context, params *ListSigningPlatformsInput, optFns ...func(*Options)) (*ListSigningPlatformsOutput, error)
- func (c *Client) ListSigningProfiles(ctx context.Context, params *ListSigningProfilesInput, optFns ...func(*Options)) (*ListSigningProfilesOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) PutSigningProfile(ctx context.Context, params *PutSigningProfileInput, optFns ...func(*Options)) (*PutSigningProfileOutput, error)
- func (c *Client) StartSigningJob(ctx context.Context, params *StartSigningJobInput, optFns ...func(*Options)) (*StartSigningJobOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- type DescribeSigningJobInput
- type DescribeSigningJobOutput
- type EndpointResolver
- type EndpointResolverFunc
- type GetSigningPlatformInput
- type GetSigningPlatformOutput
- type GetSigningProfileInput
- type GetSigningProfileOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListSigningJobsInput
- type ListSigningJobsOutput
- type ListSigningPlatformsInput
- type ListSigningPlatformsOutput
- type ListSigningProfilesInput
- type ListSigningProfilesOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type PutSigningProfileInput
- type PutSigningProfileOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolverOptions
- type StartSigningJobInput
- type StartSigningJobOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
Constants ¶
const ServiceAPIVersion = "2017-08-25"
const ServiceID = "signer"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type CancelSigningProfileInput ¶
type CancelSigningProfileInput struct { // The name of the signing profile to be canceled. // // This member is required. ProfileName *string }
type CancelSigningProfileOutput ¶
type CancelSigningProfileOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Signer.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CancelSigningProfile ¶
func (c *Client) CancelSigningProfile(ctx context.Context, params *CancelSigningProfileInput, optFns ...func(*Options)) (*CancelSigningProfileOutput, error)
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.
func (*Client) DescribeSigningJob ¶
func (c *Client) DescribeSigningJob(ctx context.Context, params *DescribeSigningJobInput, optFns ...func(*Options)) (*DescribeSigningJobOutput, error)
Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.
func (*Client) GetSigningPlatform ¶
func (c *Client) GetSigningPlatform(ctx context.Context, params *GetSigningPlatformInput, optFns ...func(*Options)) (*GetSigningPlatformOutput, error)
Returns information on a specific signing platform.
func (*Client) GetSigningProfile ¶
func (c *Client) GetSigningProfile(ctx context.Context, params *GetSigningProfileInput, optFns ...func(*Options)) (*GetSigningProfileOutput, error)
Returns information on a specific signing profile.
func (*Client) ListSigningJobs ¶
func (c *Client) ListSigningJobs(ctx context.Context, params *ListSigningJobsInput, optFns ...func(*Options)) (*ListSigningJobsOutput, error)
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, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.
func (*Client) ListSigningPlatforms ¶
func (c *Client) ListSigningPlatforms(ctx context.Context, params *ListSigningPlatformsInput, optFns ...func(*Options)) (*ListSigningPlatformsOutput, error)
Lists all signing platforms available in code signing that match the request parameters. If additional jobs remain to be listed, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.
func (*Client) ListSigningProfiles ¶
func (c *Client) ListSigningProfiles(ctx context.Context, params *ListSigningProfilesInput, optFns ...func(*Options)) (*ListSigningProfilesOutput, error)
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, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Returns a list of the tags associated with a signing profile resource.
func (*Client) PutSigningProfile ¶
func (c *Client) PutSigningProfile(ctx context.Context, params *PutSigningProfileInput, optFns ...func(*Options)) (*PutSigningProfileOutput, error)
Creates a signing profile. A signing profile is a code signing 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 (http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html)
func (*Client) StartSigningJob ¶
func (c *Client) StartSigningJob(ctx context.Context, params *StartSigningJobInput, optFns ...func(*Options)) (*StartSigningJobOutput, error)
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 (http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html) in the Amazon S3 Getting Started Guide.
- Your S3 source bucket must be version
enabled.
- You must create an S3 destination bucket. Code signing 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 code signing.
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/ (http://docs.aws.amazon.com/acm/latest/userguide/)
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
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.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
type DescribeSigningJobInput ¶
type DescribeSigningJobInput struct { // The ID of the signing job on input. // // This member is required. JobId *string }
type DescribeSigningJobOutput ¶
type DescribeSigningJobOutput struct { // Date and time that the signing job was completed. CompletedAt *time.Time // Date and time that the signing job was created. CreatedAt *time.Time // The ID of the signing job on output. JobId *string // A list of any overrides that were applied to the signing operation. Overrides *types.SigningPlatformOverrides // The microcontroller platform to which your signed code image will be // distributed. PlatformId *string // The name of the profile that initiated the signing operation. ProfileName *string // The IAM principal that requested the signing job. RequestedBy *string // Name of the S3 bucket where the signed code image is saved by code signing. SignedObject *types.SignedObject // The Amazon Resource Name (ARN) of your code signing certificate. SigningMaterial *types.SigningMaterial // Map of user-assigned key-value pairs used during signing. These values contain // any information that you specified for use in your signing job. SigningParameters map[string]*string // The object that contains the name of your S3 bucket or your raw code. Source *types.Source // Status of the signing job. Status types.SigningStatus // String value that contains the status reason. StatusReason *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type GetSigningPlatformInput ¶
type GetSigningPlatformInput struct { // The ID of the target signing platform. // // This member is required. PlatformId *string }
type GetSigningPlatformOutput ¶
type GetSigningPlatformOutput struct { // The category type of the target signing platform. Category types.Category // The display name of the target signing platform. DisplayName *string // The maximum size (in MB) of the payload that can be signed by the target // platform. MaxSizeInMB *int32 // A list of partner entities that use the target signing platform. Partner *string // The ID of the target signing platform. PlatformId *string // A list of configurations applied to the target platform at signing. SigningConfiguration *types.SigningConfiguration // The format of the target platform's signing image. SigningImageFormat *types.SigningImageFormat // The validation template that is used by the target signing platform. Target *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetSigningProfileInput ¶
type GetSigningProfileInput struct { // The name of the target signing profile. // // This member is required. ProfileName *string }
type GetSigningProfileOutput ¶
type GetSigningProfileOutput struct { // The Amazon Resource Name (ARN) for the signing profile. Arn *string // A list of overrides applied by the target signing profile for signing // operations. Overrides *types.SigningPlatformOverrides // The ID of the platform that is used by the target signing profile. PlatformId *string // The name of the target signing profile. ProfileName *string // The ARN of the certificate that the target profile uses for signing operations. SigningMaterial *types.SigningMaterial // A map of key-value pairs for signing operations that is attached to the target // signing profile. SigningParameters map[string]*string // The status of the target signing profile. Status types.SigningProfileStatus // A list of tags associated with the signing profile. Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListSigningJobsInput ¶
type ListSigningJobsInput struct { // Specifies the maximum number of items to return in the response. Use this // parameter when paginating results. If additional items exist beyond the number // you specify, the nextToken element is set in the response. Use the nextToken // value in a subsequent request to retrieve additional items. MaxResults *int32 // String for specifying the next set of paginated results to return. After you // receive a response with truncated results, use this parameter in a subsequent // request. Set it to the value of nextToken from the response that you just // received. NextToken *string // The ID of microcontroller platform that you specified for the distribution of // your code image. PlatformId *string // The IAM principal that requested the signing job. RequestedBy *string // A status value with which to filter your results. Status types.SigningStatus }
type ListSigningJobsOutput ¶
type ListSigningJobsOutput struct { // A list of your signing jobs. Jobs []*types.SigningJob // String for specifying the next set of paginated results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListSigningPlatformsInput ¶
type ListSigningPlatformsInput struct { // The category type of a signing platform. Category *string // The maximum number of results to be returned by this operation. MaxResults *int32 // Value for specifying the next set of paginated results to return. After you // receive a response with truncated results, use this parameter in a subsequent // request. Set it to the value of nextToken from the response that you just // received. NextToken *string // Any partner entities connected to a signing platform. Partner *string // The validation template that is used by the target signing platform. Target *string }
type ListSigningPlatformsOutput ¶
type ListSigningPlatformsOutput struct { // Value for specifying the next set of paginated results to return. NextToken *string // A list of all platforms that match the request parameters. Platforms []*types.SigningPlatform // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListSigningProfilesInput ¶
type ListSigningProfilesInput struct { // Designates whether to include profiles with the status of CANCELED. IncludeCanceled *bool // The maximum number of profiles to be returned. MaxResults *int32 // Value for specifying the next set of paginated results to return. After you // receive a response with truncated results, use this parameter in a subsequent // request. Set it to the value of nextToken from the response that you just // received. NextToken *string }
type ListSigningProfilesOutput ¶
type ListSigningProfilesOutput struct { // Value for specifying the next set of paginated results to return. NextToken *string // A list of profiles that are available in the AWS account. This includes profiles // with the status of CANCELED if the includeCanceled parameter is set to true. Profiles []*types.SigningProfile // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) for the signing profile. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // A list of tags associated with the signing profile. Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type PutSigningProfileInput ¶
type PutSigningProfileInput struct { // The ID of the signing platform to be created. // // This member is required. PlatformId *string // The name of the signing profile to be created. // // This member is required. ProfileName *string // The AWS Certificate Manager certificate that will be used to sign code with the // new signing profile. // // This member is required. SigningMaterial *types.SigningMaterial // A subfield of platform. This specifies any different configuration options that // you want to apply to the chosen platform (such as a different hash-algorithm or // signing-algorithm). Overrides *types.SigningPlatformOverrides // Map of key-value pairs for signing. These can include any information that you // want to use during signing. SigningParameters map[string]*string // Tags to be associated with the signing profile that is being created. Tags map[string]*string }
type PutSigningProfileOutput ¶
type PutSigningProfileOutput struct { // The Amazon Resource Name (ARN) of the signing profile created. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type StartSigningJobInput ¶
type StartSigningJobInput struct { // String that identifies the signing request. All calls after the first that use // this token return the same response as the first call. // // This member is required. ClientRequestToken *string // The S3 bucket in which to save your signed object. The destination contains the // name of your bucket and an optional prefix. // // This member is required. Destination *types.Destination // The S3 bucket that contains the object to sign or a BLOB that contains your raw // code. // // This member is required. Source *types.Source // The name of the signing profile. ProfileName *string }
type StartSigningJobOutput ¶
type StartSigningJobOutput struct { // The ID of your signing job. JobId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) for the signing profile. // // This member is required. ResourceArn *string // One or more tags to be associated with the signing profile. // // This member is required. Tags map[string]*string }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) for the signing profile. // // This member is required. ResourceArn *string // A list of tag keys to be removed from the signing profile. // // This member is required. TagKeys []*string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_CancelSigningProfile.go api_op_DescribeSigningJob.go api_op_GetSigningPlatform.go api_op_GetSigningProfile.go api_op_ListSigningJobs.go api_op_ListSigningPlatforms.go api_op_ListSigningProfiles.go api_op_ListTagsForResource.go api_op_PutSigningProfile.go api_op_StartSigningJob.go api_op_TagResource.go api_op_UntagResource.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.27.0
- Published
- Oct 17, 2020
- Platform
- js/wasm
- Imports
- 28 packages
- Last checked
- now –
Tools for package owners.