kmssdk

package module

Go to main page

Versions in this module

v1

v1.4.0

Sep 7, 2026

Changes in this version

type Option

+ func WithTLSCACert(path string) Option

+ func WithTLSCAPath(dir string) Option

+ func WithTLSClientCert(certFile, keyFile string) Option

+ func WithTLSConfig(cfg *tls.Config) Option

+ func WithTLSServerName(name string) Option

v1.3.0

Sep 7, 2026

Changes in this version

+ const AsyncProcessError

+ const AsyncProcessFinished

+ const AsyncProcessInProgress

+ const KeyFormatAESCBCPad

+ const KeyFormatAESGCM

+ const KeyFormatAESKWPWrapped

+ const KeyFormatAESWrapped

+ const KeyFormatNone

+ const KeyFormatOpenSSLPublic

+ const KeyFormatPKCS12

+ const KeyFormatPKCS8

+ const KeyFormatPlain

+ const KeyFormatQPMLDSAWrapAESKWP

+ const KeyFormatRSAESOAEPSHA1Wrapped

+ const KeyFormatRSAESOAEPSHA256AESWrapped

+ const KeyFormatRSAESOAEPSHA256Wrapped

+ const KeyFormatRSAESPKCS1V15AESCBCPadWrapped

+ const KeyFormatRSAESPKCS1V15AESGCMWrapped

+ const KeyFormatRSAESPKCS1V15Wrapped

+ const KeyFormatWrapped

+ const KeyFormatX509

+ const KeyValueTypeCertificate

+ const KeyValueTypeMulti

+ const KeyValueTypePrivate

+ const KeyValueTypePublic

+ const KeyValueTypeRaw

+ const KeyValueTypeSecret

+ const OAuth2ProviderOther

+ var ErrSuccessorUnknown = errors.New("key rotated but successor not identified")

+ func WithCorrelationID(ctx context.Context, id string) context.Context

type APIError

+ CorrelationID string

+ type AsyncProcess struct

+ CreatedBy string

+ CreationDate time.Time

+ DataEmbeddedInDB bool

+ DataFileName string

+ EndDate time.Time

+ Failures int

+ ID uuid.UUID

+ KeyID uuid.UUID

+ LastFailureReason string

+ Process string

+ ProcessJSONRequest string

+ ProcessJSONResponse string

+ ProcessResponseEmbeddedInDB bool

+ StartDate time.Time

+ Status string

+ VslotID uuid.UUID

+ type CertificateRequest struct

+ Challenge string

+ CommonName string

+ CountryCode string

+ Data []byte

+ EmailAddress string

+ Encoded []byte

+ IssuerAttributes map[string]any

+ IssuerKeyID uuid.UUID

+ LocalityName string

+ OrganisationName string

+ OrganisationUnit string

+ SerialNumber *int

+ SignatureAlgorithm string

+ StateName string

+ StoreInDB bool

+ UnstructuredName string

+ ValidFrom time.Time

+ ValidTo time.Time

type Client

+ func (c *Client) AttachKey(ctx context.Context, vslotID uuid.UUID, key KeyData) (KeyDataResponse, error)

+ func (c *Client) CreateKeyAlias(ctx context.Context, keyID uuid.UUID) (KeyAlias, error)

+ func (c *Client) DeleteKeyAsyncProcess(ctx context.Context, id uuid.UUID) error

+ func (c *Client) DeleteVSlotAsyncProcess(ctx context.Context, id uuid.UUID) error

+ func (c *Client) DeriveKey(ctx context.Context, keyID uuid.UUID, request DeriveRequest) (KeyDataResponse, error)

+ func (c *Client) EditKey(ctx context.Context, keyID uuid.UUID, useAttributes KeyUseAttributes) (KeyDataResponse, error)

+ func (c *Client) ExportKey(ctx context.Context, keyID uuid.UUID, values []KeyValue) (KeyDataResponse, error)

+ func (c *Client) FindKeyAliases(ctx context.Context, filter KeyAliasFilter) ([]KeyAlias, error)

+ func (c *Client) GenerateCSR(ctx context.Context, keyID uuid.UUID, request CertificateRequest) ([]byte, error)

+ func (c *Client) GenerateCertificate(ctx context.Context, keyID uuid.UUID, request CertificateRequest) ([]byte, error)

+ func (c *Client) GetKeyAsyncProcess(ctx context.Context, id uuid.UUID) (AsyncProcess, error)

+ func (c *Client) GetKeyAsyncProcesses(ctx context.Context) ([]AsyncProcess, error)

+ func (c *Client) GetVSlotAsyncProcess(ctx context.Context, id uuid.UUID) (AsyncProcess, error)

+ func (c *Client) GetVSlotAsyncProcesses(ctx context.Context) ([]AsyncProcess, error)

+ func (c *Client) ImportKey(ctx context.Context, vslotID uuid.UUID, key KeyData) (KeyDataResponse, error)

+ func (c *Client) ImportKeyValues(ctx context.Context, keyID uuid.UUID, values []KeyValue) (KeyDataResponse, error)

+ func (c *Client) MoveKeyAlias(ctx context.Context, aliasID, fromKeyID, toKeyID uuid.UUID) (KeyAlias, error)

+ func (c *Client) RotateKey(ctx context.Context, keyID uuid.UUID) (uuid.UUID, error)

+ func (c *Client) SetKeyState(ctx context.Context, keyID uuid.UUID, state string, enabled bool) error

+ func (c *Client) SignPDF(ctx context.Context, keyID uuid.UUID, pdf []byte) ([]byte, error)

+ func (c *Client) SignSOD(ctx context.Context, keyID uuid.UUID, request SignSODRequest) ([]byte, error)

+ func (c *Client) SignTimestamp(ctx context.Context, keyID uuid.UUID, request SignTimestampRequest) ([]byte, error)

+ func (c *Client) TransportKey(ctx context.Context, keyID, targetVslotID uuid.UUID) (KeyDataResponse, error)

+ func (c *Client) UpdateCertificate(ctx context.Context, keyID uuid.UUID, certificate []byte, storeInDB bool) ([]byte, error)

+ type DeriveRequest struct

+ Algorithm string

+ Attributes map[string]string

+ Data []byte

+ KeyAlgorithm string

+ Persistence string

+ Values []KeyValue

+ type KeyAlias struct

+ CreatedBy string

+ CreationDate time.Time

+ ID uuid.UUID

+ KeyID uuid.UUID

+ Universe string

+ type KeyAliasFilter struct

+ ID uuid.UUID

+ KeyID uuid.UUID

type KeyFilter

+ Alg string

+ AliasID uuid.UUID

+ Enabled *bool

+ Persistence string

+ State string

+ Type string

type Option

+ func WithClientSecret(secret string) Option

+ type SignSODRequest struct

+ Algorithm string

+ DG10Hash []byte

+ DG11Hash []byte

+ DG12Hash []byte

+ DG13Hash []byte

+ DG14Hash []byte

+ DG15Hash []byte

+ DG16Hash []byte

+ DG1Hash []byte

+ DG2Hash []byte

+ DG3Hash []byte

+ DG4Hash []byte

+ DG5Hash []byte

+ DG6Hash []byte

+ DG7Hash []byte

+ DG8Hash []byte

+ DG9Hash []byte

+ Data []byte

+ DigestAlgorithm string

+ LDSVersion string

+ UnicodeVersion string

+ type SignTimestampRequest struct

+ Algorithm string

+ Data []byte

+ Digest []byte

+ DigestAlgorithm string

+ TSQ []byte

v1.2.0

Jul 21, 2026

Changes in this version

type Client

+ func (c *Client) Sign(ctx context.Context, keyID uuid.UUID, request SignRequest) ([]byte, error)

+ func (c *Client) Verify(ctx context.Context, keyID uuid.UUID, request SignRequest) (bool, error)

+ type SignRequest struct

+ Algorithm string

+ Attributes *SignatureAttributes

+ Data []byte

+ type SignatureAttributes struct

+ HashAlg *int

+ MGF *int

+ SaltLength *int

+ Signature []byte

v1.1.0

Jul 21, 2026

Changes in this version

+ const AuthenticationTypeSelfManaged

+ const ErrCodeBadRequest

+ const ErrCodeConflict

+ const ErrCodeDeactivatedToken

+ const ErrCodeDisabledAccount

+ const ErrCodeEmailVerificationTokenInvalid

+ const ErrCodeForbiddenAccess

+ const ErrCodeForbiddenOperation

+ const ErrCodeInternalKeyAttributesDiffer

+ const ErrCodeInternalServerError

+ const ErrCodeInvalidMultipart

+ const ErrCodeInvalidSignature

+ const ErrCodeInvalidToken

+ const ErrCodeKeyLifecycle

+ const ErrCodeNotImplemented

+ const ErrCodeQuotaExceeded

+ const ErrCodeResourceNotFound

+ const ErrCodeTooManyResults

+ const ErrCodeUnauthorized

+ const ErrCodeWrongCredentials

+ const KeyStateActive

+ const KeyStateDeactivated

+ const KeyStateDeleted

+ const KeyStateDestroyed

+ const KeyStateProvisioned

+ const KeyTypeGenerated

+ const KeyTypeImported

+ const KeyTypeProvider

+ const KeyTypeWrap

+ const OAuth2ProviderKeycloak

+ const PersistenceExternal

+ const PersistenceInternal

+ const PersistenceNone

type APIError

+ Errors []string

type Client

+ func (c *Client) Logout(ctx context.Context) error

type Config

+ OAuth2 *OAuth2Config

+ type KeyData struct

+ Alg string

+ Attributes map[string]string

+ AttributesP11 map[string]string

+ Data []byte

+ Labels map[string]string

+ LogLevelID *uuid.UUID

+ Name string

+ Persistence string

+ State string

+ Type string

+ UseAttributes *KeyUseAttributes

+ ValidFrom time.Time

+ ValidTo time.Time

+ Values []KeyValue

+ type KeyDataResponse struct

+ ID uuid.UUID

+ Values []KeyValue

+ type OAuth2ClaimsConfig struct

+ Policy string

+ Universe string

+ Username string

+ type OAuth2Config struct

+ Claims OAuth2ClaimsConfig

+ Keycloak *OAuth2KeycloakConfig

+ Other *OAuth2OtherConfig

+ Provider OAuth2Provider

+ type OAuth2KeycloakConfig struct

+ ClientID string

+ Mode KeycloakMode

+ Realm string

+ URL string

+ type OAuth2OtherConfig struct

+ AccessTokenProperty string

+ Audience string

+ AuthorizationEndpoint string

+ ClientID string

+ LogoutEndpoint string

+ RedirectURI string

+ TokenEndpoint string

+ URL string

+ type OAuth2Provider string

type Option

+ func WithTimeout(d time.Duration) Option

+ type TokenSource interface

+ GetToken func(ctx context.Context) (string, error)

v1.0.1

May 27, 2026

v1.0.0

May 11, 2026

Changes in this version

+ const AuthenticationTypeOAuth2

+ const KeycloakModeManaged

+ const Oauth2ProviderKeycloak

+ type APIError struct

+ Code string

+ ErrorCode string

+ ErrorDescription string

+ Message string

+ StatusCode int

+ Timestamp string

+ func (e *APIError) Error() string

+ type Attributes struct

+ IV []byte

+ type AuthenticationType string

+ type Client struct

+ func NewClient(ctx context.Context, opts ...Option) *Client

+ func (c *Client) Connect(ctx context.Context) error

+ func (c *Client) CreateKey(ctx context.Context, key KeyDetail, vslotId uuid.UUID) (KeyDetail, error)

+ func (c *Client) Crypto(ctx context.Context, op CryptoOperation, keyID uuid.UUID, ...) ([]byte, error)

+ func (c *Client) DeleteKey(ctx context.Context, keyID uuid.UUID) error

+ func (c *Client) FindKeys(ctx context.Context, vslotId uuid.UUID, filter KeyFilter) ([]KeySearchResult, error)

+ func (c *Client) GetKey(ctx context.Context, keyId uuid.UUID) (KeyDetail, error)

+ func (c *Client) GetKeys(ctx context.Context, vslotId uuid.UUID) ([]KeySearchResult, error)

+ func (c *Client) GetVSlots(ctx context.Context) ([]Vslot, error)

+ type Config struct

+ Oauth2 *Oauth2Config

+ Type AuthenticationType

+ UniverseAsUsernamePrefix *bool

+ type CryptoAlgorithm struct

+ Algorithm string

+ Description string

+ KeyTypes []string

+ KeyUsage []string

+ Params map[string]any

+ type CryptoOperation string

+ const OperationDecrypt

+ const OperationEncrypt

+ type CryptoRequest struct

+ Algorithm string

+ Attributes Attributes

+ Data []byte

+ type KeyDetail struct

+ Alg string

+ AliasID *uuid.UUID

+ Attributes map[string]string

+ AttributesP11 map[string]string

+ CreatedBy string

+ CreationDate time.Time

+ Enabled bool

+ ID uuid.UUID

+ IDProvider []byte

+ IDUser []byte

+ KCV []byte

+ KeyLinks []uuid.UUID

+ KeySize *int

+ KeyValues []KeyValue

+ Labels map[string]string

+ LogLevelID *uuid.UUID

+ Name string

+ Persistence string

+ Rotated bool

+ State string

+ SupportedAlgorithms []CryptoAlgorithm

+ Type string

+ UseAttributes *KeyUseAttributes

+ ValidFrom time.Time

+ ValidTo time.Time

+ VslotID uuid.UUID

+ type KeyFilter struct

+ ID uuid.UUID

+ Name string

+ type KeySearchResult struct

+ Alg string

+ AlgType string

+ AttachedValues []string

+ CreatedBy string

+ CreationDate time.Time

+ ID uuid.UUID

+ IDProvider []byte

+ IDUser []byte

+ KCV []byte

+ Name string

+ Persistence string

+ State KeyState

+ ValidFrom time.Time

+ ValidTo time.Time

+ VslotID uuid.UUID

+ type KeyState struct

+ Enabled bool

+ State string

+ type KeyUseAttributes struct

+ Decrypt bool

+ Derive bool

+ Encrypt bool

+ Extractable bool

+ Sign bool

+ Unwrap bool

+ Verify bool

+ Wrap bool

+ type KeyValue struct

+ Format string

+ FormatParameters map[string]string

+ ID uuid.UUID

+ Password string

+ Type string

+ Value []byte

+ WrapKey []byte

+ WrapKeyFormat string

+ WrapKeyFormatParameters map[string]string

+ WrapKeyID *uuid.UUID

+ WrappingKey *KeyDetail

+ type KeycloakMode string

+ type Oauth2 struct

+ func NewOauth2(baseURL string, httpClient *http.Client, username, password string, ...) *Oauth2

+ func (o *Oauth2) GetToken(ctx context.Context) (string, error)

+ type Oauth2ClaimsConfig struct

+ Policy string

+ Universe string

+ Username string

+ type Oauth2Config struct

+ Claims Oauth2ClaimsConfig

+ Keycloak *Oauth2KeycloakConfig

+ Other *Oauth2OtherConfig

+ Provider Oauth2Provider

+ type Oauth2KeycloakConfig struct

+ ClientID string

+ Mode KeycloakMode

+ Realm string

+ URL string

+ type Oauth2OtherConfig struct

+ AccessTokenProperty string

+ Audience string

+ AuthorizationEndpoint string

+ ClientID string

+ LogoutEndpoint string

+ RedirectURI string

+ TokenEndpoint string

+ URL string

+ type Oauth2Provider string

+ type Option func(*Client)

+ func WithBaseURL(url string) Option

+ func WithHTTPClient(hc *http.Client) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithTLSSkipVerify() Option

+ func WithUsernameAndPassword(username, password string) Option

+ type Vslot struct

+ CreatedBy string

+ CreationDate time.Time

+ ID uuid.UUID

+ LogLevelID *uuid.UUID

+ Provider uuid.UUID

+ ProviderName string

+ Universe string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL