kp

Apr 16, 2024

Changes in this version

+ const KMIP_Profile_Native

type Client

+ func (c *Client) CreateKMIPAdapter(ctx context.Context, profileOpt CreateKMIPAdapterProfile, ...) (*KMIPAdapter, error)

+ func (c *Client) CreateKMIPClientCertificate(ctx context.Context, adapter_nameOrID, cert_payload string, ...) (*KMIPClientCertificate, error)

+ func (c *Client) DeleteKMIPAdapter(ctx context.Context, nameOrID string) error

+ func (c *Client) DeleteKMIPClientCertificate(ctx context.Context, adapter_nameOrID, cert_nameOrID string) error

+ func (c *Client) DeleteKMIPObject(ctx context.Context, adapter_id, object_id string) error

+ func (c *Client) GetKMIPAdapter(ctx context.Context, nameOrID string) (*KMIPAdapter, error)

+ func (c *Client) GetKMIPAdapters(ctx context.Context, listOpts *ListKmipAdaptersOptions) (*KMIPAdapters, error)

+ func (c *Client) GetKMIPClientCertificate(ctx context.Context, adapter_nameOrID, cert_nameOrID string) (*KMIPClientCertificate, error)

+ func (c *Client) GetKMIPClientCertificates(ctx context.Context, adapter_nameOrID string, listOpts *ListOptions) (*KMIPClientCertificates, error)

+ func (c *Client) GetKMIPObject(ctx context.Context, adapter_id, object_id string) (*KMIPObject, error)

+ func (c *Client) GetKMIPObjects(ctx context.Context, adapter_id string, listOpts *ListKmipObjectsOptions) (*KMIPObjects, error)

+ type CollectionMetadata struct

+ CollectionTotal int

+ CollectionType string

+ TotalCount int

+ type CreateKMIPAdapterOption func(*KMIPAdapter)

+ func WithKMIPAdapterDescription(description string) CreateKMIPAdapterOption

+ func WithKMIPAdapterName(name string) CreateKMIPAdapterOption

+ type CreateKMIPAdapterProfile func(*KMIPAdapter)

+ func WithNativeProfile(crkID string) CreateKMIPAdapterProfile

+ type CreateKMIPClientCertOption func(*KMIPClientCertificate)

+ func WithKMIPClientCertName(name string) CreateKMIPClientCertOption

+ type KMIPAdapter struct

+ CreatedAt *time.Time

+ CreatedBy string

+ Description string

+ ID string

+ Name string

+ Profile string

+ ProfileData map[string]string

+ UpdatedAt *time.Time

+ UpdatedBy string

+ type KMIPAdapters struct

+ Adapters []KMIPAdapter

+ Metadata CollectionMetadata

+ type KMIPClientCertificate struct

+ Certificate string

+ CreatedAt *time.Time

+ CreatedBy string

+ ID string

+ Name string

+ type KMIPClientCertificates struct

+ Certificates []KMIPClientCertificate

+ Metadata CollectionMetadata

+ type KMIPObject struct

+ CreatedAt *time.Time

+ CreatedBy string

+ CreatedByCertID string

+ DestroyedAt *time.Time

+ DestroyedBy string

+ DestroyedByCertID string

+ ID string

+ KMIPObjectType int

+ ObjectState int

+ UpdatedAt *time.Time

+ UpdatedBy string

+ UpdatedByCertID string

+ type KMIPObjects struct

+ Metadata CollectionMetadata

+ Objects []KMIPObject

+ type ListKmipAdaptersOptions struct

+ Limit *uint32

+ Offset *uint32

+ TotalCount *bool

+ type ListKmipObjectsOptions struct

+ Limit *uint32

+ ObjectStateFilter *[]int32

+ Offset *uint32

+ TotalCount *bool

+ type ListOptions struct

+ Limit *uint32

+ Offset *uint32

+ TotalCount *bool

Aug 23, 2023

retracted

Changes in this version

+ type DeleteKeyRingQueryOption func(*http.Request)

+ func WithForce(force bool) DeleteKeyRingQueryOption

Aug 17, 2023

retracted

Changes in this version

type Client

+ func (c *Client) CreateKeyWithOptions(ctx context.Context, name string, extractable bool, options ...CreateKeyOption) (*Key, error)

+ func (c *Client) CreateKeyWithPolicyOverridesWithOptions(ctx context.Context, name string, extractable bool, policy Policy, ...) (*Key, error)

+ type CreateKeyOption func(k *Key)

+ func WithAliases(aliases []string) CreateKeyOption

+ func WithDescription(description string) CreateKeyOption

+ func WithExpiration(expiration *time.Time) CreateKeyOption

+ func WithPayload(payload string, encryptedNonce, iv *string, sha1 bool) CreateKeyOption

+ func WithTags(tags []string) CreateKeyOption

Mar 31, 2023

Changes in this version

type Client

+ func (c *Client) WrapCreateDEKV2(ctx context.Context, idOrAlias string, additionalAuthData *[]string) (*KeyActionResponse, error)

type ListKeyVersionsOptions

+ AllKeyStates *bool

Dec 14, 2022

Changes in this version

type Client

+ func (c *Client) WrapV2(ctx context.Context, idOrAlias string, plainText []byte, ...) (*KeyActionResponse, error)

type ClientConfig

+ Headers http.Header

+ type KeyActionResponse struct

+ CipherText string

+ KeyVersion *KeyVersion

+ PlainText string

type KeysActionRequest

+ KeyVersion *KeyVersion

Oct 12, 2022

Changes in this version

type Attributes

+ IntervalMonth *int

type Client

+ func (c *Client) CreateImportedKeyWithPolicyOverrides(ctx context.Context, name string, expiration *time.Time, ...) (*Key, error)

+ func (c *Client) CreateImportedKeyWithPolicyOverridesWithSHA1(ctx context.Context, name string, expiration *time.Time, ...) (*Key, error)

+ func (c *Client) CreateImportedRootKeyWithPolicyOverrides(ctx context.Context, name string, expiration *time.Time, ...) (*Key, error)

+ func (c *Client) CreateImportedStandardKeyWithPolicyOverrides(ctx context.Context, name string, expiration *time.Time, payload string, ...) (*Key, error)

+ func (c *Client) CreateKeyWithPolicyOverrides(ctx context.Context, name string, expiration *time.Time, extractable bool, ...) (*Key, error)

+ func (c *Client) CreateRootKeyWithPolicyOverrides(ctx context.Context, name string, expiration *time.Time, aliases []string, ...) (*Key, error)

+ func (c *Client) CreateStandardKeyWithPolicyOverrides(ctx context.Context, name string, expiration *time.Time, aliases []string, ...) (*Key, error)

+ func (c *Client) DisableRotationPolicy(ctx context.Context, idOrAlias string) (*Policy, error)

+ func (c *Client) EnableRotationPolicy(ctx context.Context, idOrAlias string) (*Policy, error)

+ func (c *Client) GetRotationInstancePolicy(ctx context.Context) (*InstancePolicy, error)

+ func (c *Client) SetRotationInstancePolicy(ctx context.Context, enable bool, intervalMonth *int) error

+ type FilterQueryBuilder struct

+ func GetFilterQueryBuilder() *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) Build() string

+ func (fq *FilterQueryBuilder) CreationDate() *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) DeletionDate() *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) Equal(dateInput time.Time) *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) ExpirationDate() *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) Extractable(val bool) *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) GreaterThan(dateInput time.Time) *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) GreaterThanOrEqual(dateInput time.Time) *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) LastRotationDate() *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) LastUpdateDate() *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) LessThan(dateInput time.Time) *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) LessThanOrEqual(dateInput time.Time) *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) None() *FilterQueryBuilder

+ func (fq *FilterQueryBuilder) State(states []KeyState) *FilterQueryBuilder

type Key

+ Rotation *Rotation

type ListKeysOptions

+ Filter *string

type MultiplePolicies

+ Rotation *RotationPolicyData

type Rotation

+ Enabled *bool

+ type RotationPolicyData struct

+ Enabled bool

+ IntervalMonth *int

Aug 29, 2022

Changes in this version

+ func GetKeySearchQuery(searchStr *string, opts ...SearchOpts) (*string, error)

+ func GetKeySortStr(opts ...SortByOpts) *string

type ListKeysOptions

+ Search *string

+ Sort *string

+ type SearchOpts func(s *string)

+ func AddAliasScope() SearchOpts

+ func AddEscape() SearchOpts

+ func AddKeyNameScope() SearchOpts

+ func ApplyNot() SearchOpts

+ func WithExactMatch() SearchOpts

+ type SortByOpts func(s *string)

+ func WithCreationDate() SortByOpts

+ func WithCreationDateDesc() SortByOpts

+ func WithDeletionDate() SortByOpts

+ func WithDeletionDateDesc() SortByOpts

+ func WithExpirationDate() SortByOpts

+ func WithExpirationDateDesc() SortByOpts

+ func WithExtractable() SortByOpts

+ func WithExtractableDesc() SortByOpts

+ func WithID() SortByOpts

+ func WithIDDesc() SortByOpts

+ func WithImported() SortByOpts

+ func WithImportedDesc() SortByOpts

+ func WithLastRotateDate() SortByOpts

+ func WithLastRotateDateDesc() SortByOpts

+ func WithLastUpdateDate() SortByOpts

+ func WithLastUpdateDateDesc() SortByOpts

+ func WithState() SortByOpts

+ func WithStateDesc() SortByOpts

Jun 23, 2022

Changes in this version

+ const AlgorithmRSAOAEP1

+ const AlgorithmRSAOAEP256

type Client

+ func (c *Client) CreateImportedKeyWithSHA1(ctx context.Context, name string, expiration *time.Time, ...) (*Key, error)

+ func (c *Client) ListKeyVersions(ctx context.Context, idOrAlias string, ...) (*KeyVersions, error)

+ func (c *Client) ListKeys(ctx context.Context, listKeysOptions *ListKeysOptions) (*Keys, error)

+ func (c *Client) PurgeKey(ctx context.Context, idOrAlias string, prefer PreferReturn) (*Key, error)

+ func (c *Client) RotateV2(ctx context.Context, idOrAlias string, new_key *KeyPayload) error

+ func (c *Client) SetKeyRing(ctx context.Context, idOrAlias, newKeyRingID string) (*Key, error)

+ func (c *Client) SyncAssociatedResources(ctx context.Context, idOrAlias string) error

type Key

+ PurgeAllowed *bool

+ PurgeAllowedFrom *time.Time

+ PurgeScheduledOn *time.Time

+ type KeyPayload struct

+ func NewKeyPayload(payload, encryptedNonce, iv string) KeyPayload

+ func (kp KeyPayload) WithRSA1() KeyPayload

+ func (kp KeyPayload) WithRSA256() KeyPayload

+ type KeyState uint32

+ const Active

+ const Deactivated

+ const Destroyed

+ const Suspended

+ type KeyVersions struct

+ KeyVersion []KeyVersion

+ Metadata KeyVersionsMetadata

+ type KeyVersionsMetadata struct

+ CollectionTotal *uint32

+ CollectionType string

+ TotalCount *uint32

type KeysActionRequest

+ EncryptedNonce string

+ EncryptionAlgorithm string

+ IV string

+ type ListKeyVersionsOptions struct

+ Limit *uint32

+ Offset *uint32

+ TotalCount *bool

+ type ListKeysOptions struct

+ Extractable *bool

+ Limit *uint32

+ Offset *uint32

+ State []KeyState

Mar 18, 2021

Changes in this version

type Key

+ Imported bool

+ KeyRingID string

Feb 22, 2021

Changes in this version

+ const AllowedIP

+ const CreateRootKey

+ const CreateStandardKey

+ const EnforceToken

+ const ImportRootKey

+ const ImportStandardKey

+ const KeyCreateImportAccess

+ const Metrics

+ type AliasesMetadata struct

+ CollectionType string

+ NumberOfAliases int

+ type AllowedIPPolicyData struct

+ Enabled bool

+ IPAddresses IPAddresses

+ type AllowedNetworkPolicyData struct

+ Enabled bool

+ Network string

type Attributes

+ AllowedIP IPAddresses

+ CreateRootKey *bool

+ CreateStandardKey *bool

+ EnforceToken *bool

+ ImportRootKey *bool

+ ImportStandardKey *bool

+ type BasicPolicyData struct

+ Enabled bool

type Client

+ func (c *Client) CreateImportedKeyWithAliases(ctx context.Context, name string, expiration *time.Time, ...) (*Key, error)

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

+ func (c *Client) CreateKeyRing(ctx context.Context, id string) error

+ func (c *Client) CreateKeyWithAliases(ctx context.Context, name string, expiration *time.Time, extractable bool, ...) (*Key, error)

+ func (c *Client) DeleteKeyAlias(ctx context.Context, aliasName, keyID string) error

+ func (c *Client) DeleteKeyRing(ctx context.Context, id string) error

+ func (c *Client) GetAllowedIPInstancePolicy(ctx context.Context) (*InstancePolicy, error)

+ func (c *Client) GetAllowedIPPrivateNetworkPort(ctx context.Context) (int, error)

+ func (c *Client) GetKeyCreateImportAccessInstancePolicy(ctx context.Context) (*InstancePolicy, error)

+ func (c *Client) GetKeyRings(ctx context.Context) (*KeyRings, error)

+ func (c *Client) GetMetricsInstancePolicy(ctx context.Context) (*InstancePolicy, error)

+ func (c *Client) SetAllowedIPInstancePolicy(ctx context.Context, enable bool, allowedIPs []string) error

+ func (c *Client) SetKeyCreateImportAccessInstancePolicy(ctx context.Context, enable bool, attributes map[string]bool) error

+ func (c *Client) SetMetricsInstancePolicy(ctx context.Context, enable bool) error

type ClientConfig

+ KeyRing string

+ type IPAddresses []string

type Key

+ Aliases []string

+ type KeyAlias struct

+ Alias string

+ CreatedBy string

+ CreationDate *time.Time

+ KeyID string

+ type KeyAliases struct

+ KeyAliases []KeyAlias

+ Metadata AliasesMetadata

+ type KeyCreateImportAccessInstancePolicy struct

+ CreateRootKey bool

+ CreateStandardKey bool

+ Enabled bool

+ EnforceToken bool

+ ImportRootKey bool

+ ImportStandardKey bool

+ type KeyRing struct

+ CreatedBy string

+ CreationDate *time.Time

+ ID string

+ type KeyRings struct

+ KeyRings []KeyRing

+ Metadata KeysMetadata

+ type MultiplePolicies struct

+ AllowedIP *AllowedIPPolicyData

+ AllowedNetwork *AllowedNetworkPolicyData

+ DualAuthDelete *BasicPolicyData

+ KeyCreateImportAccess *KeyCreateImportAccessInstancePolicy

+ Metrics *BasicPolicyData

Feb 9, 2021

Changes in this version

+ func GetCorrelationID(ctx context.Context) *uuid.UUID

+ func NewContextWithCorrelationID(ctx context.Context, uuid *uuid.UUID) context.Context

Jul 10, 2020

Changes in this version

+ const AllowedNetwork

+ const DualAuthDelete

+ const RotationPolicy

+ func EncryptKeyWithSHA1(key, pubKey string) (string, error)

+ func EncryptNonceWithCBCPAD(key, value, iv string) (string, string, error)

+ type Attributes struct

+ AllowedNetwork string

type Client

+ func (c *Client) CancelDualAuthDelete(ctx context.Context, id string) error

+ func (c *Client) DisableKey(ctx context.Context, id string) error

+ func (c *Client) EnableKey(ctx context.Context, id string) error

+ func (c *Client) GetAllowedNetworkInstancePolicy(ctx context.Context) (*InstancePolicy, error)

+ func (c *Client) GetDualAuthDeletePolicy(ctx context.Context, id string) (*Policy, error)

+ func (c *Client) GetDualAuthInstancePolicy(ctx context.Context) (*InstancePolicy, error)

+ func (c *Client) GetKeyMetadata(ctx context.Context, id string) (*Key, error)

+ func (c *Client) GetPolicies(ctx context.Context, id string) ([]Policy, error)

+ func (c *Client) GetRotationPolicy(ctx context.Context, id string) (*Policy, error)

+ func (c *Client) InitiateDualAuthDelete(ctx context.Context, id string) error

+ func (c *Client) ListRegistrations(ctx context.Context, keyId, crn string) (*registrations, error)

+ func (c *Client) RestoreKey(ctx context.Context, id, payload, encryptedNonce, iv string) (*Key, error)

+ func (c *Client) SetAllowedNetworkInstancePolicy(ctx context.Context, enable bool, networkType string) error

+ func (c *Client) SetDualAuthDeletePolicy(ctx context.Context, id string, enabled bool) (*Policy, error)

+ func (c *Client) SetDualAuthInstancePolicy(ctx context.Context, enable bool) error

+ func (c *Client) SetPolicies(ctx context.Context, id string, setRotationPolicy bool, rotationInterval int, ...) ([]Policy, error)

+ func (c *Client) SetRotationPolicy(ctx context.Context, id string, rotationInterval int) (*Policy, error)

+ type DualAuth struct

+ Enabled *bool

type Key

+ Deleted *bool

+ DeletedBy *string

+ DeletionDate *time.Time

+ DualAuthDelete *DualAuth

+ KeyVersion *KeyVersion

+ type KeyVersion struct

+ CreationDate *time.Time

+ ID string

type Policy

+ DualAuth *DualAuth

+ type PolicyData struct

+ Attributes *Attributes

+ Enabled *bool

+ type Registration struct

+ CreatedBy string

+ CreationDate *time.Time

+ Description string

+ KeyID string

+ KeyVersion KeyVersion

+ LastUpdateDate *time.Time

+ PreventKeyDeletion bool

+ ResourceCrn string

+ UpdatedBy string

+ type Rotation struct

+ Interval int

Apr 3, 2020

Changes in this version

type Client

+ func (c *Client) GetInstancePolicies(ctx context.Context) (*InstancePolicy, error)

+ func (c *Client) SetInstancePolicies(ctx context.Context, dualAuthEnabled bool) error

+ type InstancePolicies struct

+ Metadata PoliciesMetadata

+ Policies []InstancePolicy

+ type InstancePolicy struct

+ CreatedAt *time.Time

+ CreatedBy string

+ PolicyData struct{ ... }

+ PolicyType string

+ UpdatedAt *time.Time

+ UpdatedBy string

Mar 25, 2020

Changes in this version

+ type CallOpt interface

type Error

+ Reasons []reason

+ type ForceOpt struct

+ Force bool

Dec 17, 2019

Changes in this version

+ const DefaultBaseURL

+ const DefaultTokenURL

+ const VerboseAll

+ const VerboseAllNoRedact

+ const VerboseBodyOnly

+ const VerboseFailOnly

+ const VerboseNone

+ var RetryMax = 4

+ var RetryWaitMax = 30 * time.Second

+ func DefaultTransport() http.RoundTripper

+ func EncryptKey(key, pubkey string) (string, error)

+ func EncryptNonce(key, value, iv string) (string, string, error)

+ func NewContextWithAuth(parent context.Context, auth string) context.Context

+ type API = Client

+ type Client struct

+ Config ClientConfig

+ Dump Dump

+ HttpClient http.Client

+ Logger Logger

+ URL *url.URL

+ func New(config ClientConfig, transport http.RoundTripper) (*Client, error)

+ func NewWithLogger(config ClientConfig, transport http.RoundTripper, logger Logger) (*Client, error)

+ func (c *Client) CreateImportToken(ctx context.Context, expiration, maxAllowedRetrievals int) (*ImportTokenMetadata, error)

+ func (c *Client) CreateImportedKey(ctx context.Context, name string, expiration *time.Time, ...) (*Key, error)

+ func (c *Client) CreateImportedRootKey(ctx context.Context, name string, expiration *time.Time, ...) (*Key, error)

+ func (c *Client) CreateImportedStandardKey(ctx context.Context, name string, expiration *time.Time, payload string) (*Key, error)

+ func (c *Client) CreateKey(ctx context.Context, name string, expiration *time.Time, extractable bool) (*Key, error)

+ func (c *Client) CreateRootKey(ctx context.Context, name string, expiration *time.Time) (*Key, error)

+ func (c *Client) CreateStandardKey(ctx context.Context, name string, expiration *time.Time) (*Key, error)

+ func (c *Client) DeleteKey(ctx context.Context, id string, prefer PreferReturn) (*Key, error)

+ func (c *Client) GetImportTokenTransportKey(ctx context.Context) (*ImportTokenKeyResponse, error)

+ func (c *Client) GetKey(ctx context.Context, id string) (*Key, error)

+ func (c *Client) GetKeys(ctx context.Context, limit int, offset int) (*Keys, error)

+ func (c *Client) GetPolicy(ctx context.Context, id string) (*Policy, error)

+ func (c *Client) Rotate(ctx context.Context, id, payload string) error

+ func (c *Client) SetPolicy(ctx context.Context, id string, prefer PreferReturn, rotationInterval int) (*Policy, error)

+ func (c *Client) Unwrap(ctx context.Context, id string, cipherText []byte, ...) ([]byte, error)

+ func (c *Client) UnwrapV2(ctx context.Context, id string, cipherText []byte, ...) ([]byte, []byte, error)

+ func (c *Client) Wrap(ctx context.Context, id string, plainText []byte, additionalAuthData *[]string) ([]byte, error)

+ func (c *Client) WrapCreateDEK(ctx context.Context, id string, additionalAuthData *[]string) ([]byte, []byte, error)

+ type ClientConfig struct

+ APIKey string

+ Authorization string

+ BaseURL string

+ InstanceID string

+ Timeout float64

+ TokenURL string

+ Verbose int

+ type ContextKey int

+ type Dump func(*http.Request, *http.Response, []byte, []byte, Logger, []string)

+ type Error struct

+ BodyContent []byte

+ CorrelationID string

+ Message string

+ StatusCode int

+ URL string

+ func (e Error) Error() string

+ type ImportTokenCreateRequest struct

+ ExpiresInSeconds int

+ MaxAllowedRetrievals int

+ type ImportTokenKeyResponse struct

+ CreationDate *time.Time

+ ExpirationDate *time.Time

+ ID string

+ Nonce string

+ Payload string

+ type ImportTokenMetadata struct

+ CreationDate *time.Time

+ ExpirationDate *time.Time

+ ID string

+ MaxAllowedRetrievals int

+ RemainingRetrievals int

+ type Key struct

+ AlgorithmType string

+ CRN string

+ CreatedBy string

+ CreationDate *time.Time

+ Description string

+ EncryptedNonce string

+ EncryptionAlgorithm string

+ Expiration *time.Time

+ Extractable bool

+ ID string

+ IV string

+ LastRotateDate *time.Time

+ LastUpdateDate *time.Time

+ Name string

+ Payload string

+ State int

+ Tags []string

+ Type string

+ type Keys struct

+ Keys []Key

+ Metadata KeysMetadata

+ type KeysActionRequest struct

+ AAD []string

+ CipherText string

+ Payload string

+ PlainText string

+ type KeysMetadata struct

+ CollectionType string

+ NumberOfKeys int

+ type Logger interface

+ Info func(...interface{})

+ func NewLogger(writer func(...interface{})) Logger

+ type Policies struct

+ Metadata PoliciesMetadata

+ Policies []Policy

+ type PoliciesMetadata struct

+ CollectionType string

+ NumberOfPolicies int

+ type Policy struct

+ CRN string

+ CreatedAt *time.Time

+ CreatedBy string

+ Rotation struct{ ... }

+ Type string

+ UpdatedAt *time.Time

+ UpdatedBy string

+ type PreferReturn int

+ const ReturnMinimal

+ const ReturnRepresentation

+ type Redact func(string, []string) string

+ type URLError struct

+ CorrelationID string

+ Err error

+ func (e URLError) Error() string