# Functions
DecodeKeySpec parses keySpec name to a signature.keySpec type.
DecodeSigningAlgorithm parses the signing algorithm name from a given string.
EncodeKeySpec returns the name of a keySpec according to the spec.
EncodeSigningAlgorithm returns the signing algorithm name of an algorithm according to the spec.
HashAlgorithmFromKeySpec returns the name of hash function according to the spec.
# Constants
CapabilityEnvelopeGenerator is the name of the capability for a plugin to support generating envelope signatures.
CapabilityRevocationCheckVerifier is the name of the capability for a plugin to support verifying revocation checks.
CapabilitySignatureGenerator is the name of the capability for a plugin to support generating raw signatures.
CapabilityTrustedIdentityVerifier is the name of the capability for a plugin to support verifying trusted identities.
CommandDescribeKey is the name of the plugin command which must be supported by every plugin that has the SIGNATURE_GENERATOR.RAW capability.
CommandGenerateEnvelope is the name of the plugin command which must be supported by every plugin that has the SIGNATURE_GENERATOR.ENVELOPE capability.
CommandGenerateSignature is the name of the plugin command which must be supported by every plugin that has the SIGNATURE_GENERATOR.RAW capability.
CommandGetMetadata is the name of the plugin command which must be supported by every plugin and returns the plugin metadata.
CommandVerifySignature is the name of the plugin command which must be supported by every plugin that has any SIGNATURE_VERIFIER.* capability
Deprecated: CommandVerifySignature exists for historical compatibility and should not be used.
ContractVersion is the <major>.<minor> version of the plugin contract.
ErrorCodeAccessDenied is used when user doesn't have required permission to access the key.
ErrorCodeGeneric is used when an general error occurred that does not fall into any categories.
ErrorCodeThrottled is used when an operation to generate signature was throttles and can be retried by Notation.
ErrorCodeTimeout is used when an operation to generate signature timed out and can be retried by Notation.
ErrorCodeUnsupportedContractVersion is used when when the contract version used in the request is unsupported.
ErrorCodeValidation is used when any of the required request fields is empty ormalformed/invalid.
one of the following supported hash algorithm names.
one of the following supported hash algorithm names.
one of the following supported hash algorithm names.
one of the following supported key spec names.
one of the following supported key spec names.
one of the following supported key spec names.
one of the following supported key spec names.
one of the following supported key spec names.
one of the following supported key spec names.
Prefix is the prefix required on all plugin binary names.
one of the following supported [signing algorithm] names.
one of the following supported [signing algorithm] names.
one of the following supported [signing algorithm] names.
one of the following supported [signing algorithm] names.
one of the following supported [signing algorithm] names.
one of the following supported [signing algorithm] names.
# Structs
RequestError is the common error response for any request.
# Type aliases
Capability is a feature available in the plugin contract.
Command is a CLI command available in the plugin contract.
CriticalAttributes contains all Notary Project defined critical attributes and their values in the signature envelope
Deprecated: CriticalAttributes exists for historical compatibility and should not be used.
DescribeKeyRequest contains the parameters passed in a describe-key request.
DescribeKeyResponse is the response of a describe-key request.
Deprecated: ErrorCode exists for historical compatibility and should not be used.
GenerateEnvelopeRequest contains the parameters passed in a generate-envelope request.
GenerateEnvelopeResponse is the response of a generate-envelope request.
GenerateSignatureRequest contains the parameters passed in a generate-signature request.
GenerateSignatureResponse is the response of a generate-signature request.
GetMetadataRequest contains the parameters passed in a get-plugin-metadata request.
GetMetadataResponse provided by the plugin.
HashAlgorithm is the type of hash algorithm.
KeySpec is type of the signing algorithm, including algorithm and size.
Request defines a plugin request, which is always associated to a command.
Signature represents a signature pulled from the envelope
Deprecated: Signature exists for historical compatibility and should not be used.
SignatureAlgorithm is the type of signature algorithm
Deprecated: SignatureAlgorithm exists for historical compatibility and should not be used.
TrustPolicy represents trusted identities that sign the artifacts
Deprecated: TrustPolicy exists for historical compatibility and should not be used.
VerificationResult is the result of a verification performed by the plugin.
VerifySignatureRequest contains the parameters passed in a verify-signature request.
VerifySignatureResponse is the response of a verify-signature request.