Struct: kms.SignOutput

import "../ibm-cos-sdk-go/service/kms"

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary

• KeyId *string

  The Amazon Resource Name (key ARN (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) of the asymmetric KMS key that was used to sign the message.

• Signature []byte

  The cryptographic signature that was generated for the message.

• SigningAlgorithm *string

  The signing algorithm that was used to sign the message.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetKeyId(string) *SignOutput operation

  SetKeyId sets the KeyId field's value.

• SetSignature([]byte) *SignOutput operation

  SetSignature sets the Signature field's value.

• SetSigningAlgorithm(string) *SignOutput operation

  SetSigningAlgorithm sets the SigningAlgorithm field's value.

• String() string operation

  String returns the string representation.

Structure Field Details

KeyId *string `min:"1" type:"string"`

The Amazon Resource Name (key ARN (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) of the asymmetric KMS key that was used to sign the message.

Signature []byte `min:"1" type:"blob"`

The cryptographic signature that was generated for the message.

• When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017 (tools.ietf.org/html/rfc8017).

• When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3 (tools.ietf.org/html/rfc3279#section-2.2.3). This is the most commonly used signature format and is appropriate for most uses.

When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Signature is automatically base64 encoded/decoded by the SDK.

SigningAlgorithm *string `type:"string" enum:"SigningAlgorithmSpec"`

The signing algorithm that was used to sign the message.

_ struct{} `type:"structure"`

Method Details

func (s SignOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 16463

func (s SignOutput) GoString() string {
	return s.String()
}

func (s *SignOutput) SetKeyId(v string) *SignOutput

SetKeyId sets the KeyId field's value.

// File 'service/kms/api.go', line 16468

func (s *SignOutput) SetKeyId(v string) *SignOutput {
	s.KeyId = &v
	return s
}

func (s *SignOutput) SetSignature(v []byte) *SignOutput

SetSignature sets the Signature field's value.

// File 'service/kms/api.go', line 16474

func (s *SignOutput) SetSignature(v []byte) *SignOutput {
	s.Signature = v
	return s
}

func (s *SignOutput) SetSigningAlgorithm(v string) *SignOutput

SetSigningAlgorithm sets the SigningAlgorithm field's value.

// File 'service/kms/api.go', line 16480

func (s *SignOutput) SetSigningAlgorithm(v string) *SignOutput {
	s.SigningAlgorithm = &v
	return s
}

func (s SignOutput) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 16454

func (s SignOutput) String() string {
	return awsutil.Prettify(s)
}