sdk

Feb 25, 2025

Changes in this version

+ const DefaultRSAKeySize

+ const ECKeySize256

+ const ECKeySize384

+ const ECKeySize521

+ const ErrPlatformUnreachable

+ func ValidateHealthyPlatformConnection(platformEndpoint string, dialOptions []grpc.DialOption) error

type KeyAccess

+ EphemeralPublicKey string

+ SchemaVersion string

type Manifest

+ TDFVersion string

type Option

+ func WithConnectionValidation() Option

+ type SchemaValidationIntensity int

+ const Lax

+ const Skip

+ const Strict

type Statement

+ func (s *Statement) UnmarshalJSON(data []byte) error

type TDFOption

+ func WithWrappingKeyAlg(keyType ocrypto.KeyType) TDFOption

type TDFReaderOption

+ func WithSchemaValidation(intensity SchemaValidationIntensity) TDFReaderOption

+ func WithSessionKeyType(keyType ocrypto.KeyType) TDFReaderOption

Jan 21, 2025

Changes in this version

+ var ErrInvalidPerSchema = errors.New("manifest was not valid")

+ func FromBulkErrors(err error) ([]error, bool)

+ type BulkDecryptOption func(request *BulkDecryptRequest)

+ func WithTDFType(tdfType TdfType) BulkDecryptOption

+ func WithTDFs(tdfs ...*BulkTDF) BulkDecryptOption

+ type BulkDecryptRequest struct

+ TDFType TdfType

+ TDFs []*BulkTDF

+ type BulkErrors []error

+ func (b BulkErrors) Error() string

+ func (b BulkErrors) Unwrap() []error

+ type BulkTDF struct

+ Error error

+ Reader io.ReadSeeker

+ Writer io.Writer

+ type NanoTDFDecryptHandler struct

+ func (n *NanoTDFDecryptHandler) CreateRewrapRequest(_ context.Context) (map[string]*kas.UnsignedRewrapRequest_WithPolicyRequest, error)

+ func (n *NanoTDFDecryptHandler) Decrypt(_ context.Context, result []kaoResult) (uint32, error)

type SDK

+ func (s SDK) BulkDecrypt(ctx context.Context, opts ...BulkDecryptOption) error

Jan 8, 2025

Changes in this version

+ const TDFSpecVersion

+ const Version

Nov 15, 2024

Changes in this version

type NanoTDFConfig

+ func (config *NanoTDFConfig) EnableCollection()

type Option

+ func WithStoreCollectionHeaders() Option

Oct 28, 2024

Changes in this version

type TDFReaderOption

+ func WithDisableAssertionVerification(disable bool) TDFReaderOption

Oct 15, 2024

Changes in this version

+ var ErrRewrapBadRequest = fmt.Errorf("[%w] tdf: rewrap request 400", ErrTampered)

+ var ErrRootSigValidation = fmt.Errorf("[%w] tdf: failed integrity check on root signature", ErrTampered)

+ var ErrRootSignatureFailure = fmt.Errorf("[%w] tdf: issue verifying root signature", ErrTampered)

+ var ErrSegSigValidation = fmt.Errorf("[%w] tdf: failed integrity check on segment hash", ErrTampered)

+ var ErrSegSizeMismatch = fmt.Errorf("[%w] tdf: mismatch encrypted segment size in manifest", ErrTampered)

+ var ErrTDFPayloadInvalidOffset = fmt.Errorf("[%w] sdk.Reader.ReadAt: negative offset", ErrTampered)

+ var ErrTDFPayloadReadFail = fmt.Errorf("[%w] tdf: fail to read payload from tdf", ErrTampered)

+ var ErrTampered = errors.New("tamper detected")

+ type ErrAssertionFailure struct

+ ID string

+ func (e ErrAssertionFailure) Error() string

+ func (e ErrAssertionFailure) Unwrap() error

Oct 9, 2024

Changes in this version

type SDK

+ func (s *SDK) StoreKASKeys(url string, keys *policy.KasPublicKeySet) error

Aug 23, 2024

Changes in this version

type NanoTDFHeader

+ func (header *NanoTDFHeader) GetKasURL() ResourceLocator

type Option

+ func WithNoKIDInNano() Option

type ResourceLocator

+ func (rl ResourceLocator) GetIdentifier() (string, error)

+ func (rl ResourceLocator) GetURL() (string, error)

Aug 20, 2024

Changes in this version

+ const ErrAccessTokenInvalid

+ var ErrInvalid = errors.New("invalid type")

+ type AttributeNameFQN struct

+ func NewAttributeNameFQN(u string) (AttributeNameFQN, error)

+ func (a AttributeNameFQN) Authority() string

+ func (a AttributeNameFQN) Name() string

+ func (a AttributeNameFQN) Prefix() string

+ func (a AttributeNameFQN) Select(v string) AttributeValueFQN

+ func (a AttributeNameFQN) String() string

+ type AttributeValueFQN struct

+ func NewAttributeValueFQN(u string) (AttributeValueFQN, error)

+ func (a AttributeValueFQN) Authority() string

+ func (a AttributeValueFQN) Name() string

+ func (a AttributeValueFQN) Prefix() AttributeNameFQN

+ func (a AttributeValueFQN) String() string

+ func (a AttributeValueFQN) Value() string

+ type OAuthAccessTokenSource struct

+ func NewOAuthAccessTokenSource(source oauth2.TokenSource, scopes []string, key *ocrypto.RsaKeyPair) (*OAuthAccessTokenSource, error)

+ func (t *OAuthAccessTokenSource) AccessToken(_ context.Context, _ *http.Client) (auth.AccessToken, error)

+ func (t *OAuthAccessTokenSource) MakeToken(tokenMaker func(jwk.Key) ([]byte, error)) ([]byte, error)

type Option

+ func WithOAuthAccessTokenSource(t oauth2.TokenSource) Option

Aug 19, 2024

Changes in this version

+ const ErrPlatformAuthzEndpointNotFound

+ const ErrPlatformIssuerNotFound

+ const ErrPlatformPublicClientIDNotFound

+ const ErrPlatformTokenEndpointNotFound

type PlatformConfiguration

+ func (c PlatformConfiguration) AuthzEndpoint() (string, error)

+ func (c PlatformConfiguration) Issuer() (string, error)

+ func (c PlatformConfiguration) PublicClientID() (string, error)

+ func (c PlatformConfiguration) TokenEndpoint() (string, error)

Aug 16, 2024

Changes in this version

type Option

+ func WithCustomCoreConnection(conn *grpc.ClientConn) Option

Aug 12, 2024

Changes in this version

+ func IsValidNanoTdf(reader io.ReadSeeker) (bool, error)

+ func IsValidTdf(reader io.ReadSeeker) (bool, error)

+ type AppliesToState string

+ const Encrypted

+ const Unencrypted

+ func (ats AppliesToState) String() string

type Assertion

+ AppliesToState AppliesToState

+ Binding Binding

+ ID string

+ Scope Scope

+ Statement Statement

+ Type AssertionType

+ func (a *Assertion) Sign(hash, sig string, key AssertionKey) error

+ func (a Assertion) GetHash() ([]byte, error)

+ func (a Assertion) Verify(key AssertionKey) (string, string, error)

+ type AssertionConfig struct

+ AppliesToState AppliesToState

+ ID string

+ Scope Scope

+ SigningKey AssertionKey

+ Statement Statement

+ Type AssertionType

+ type AssertionKey struct

+ Alg AssertionKeyAlg

+ Key interface{}

+ func (k AssertionKey) Algorithm() AssertionKeyAlg

+ func (k AssertionKey) IsEmpty() bool

+ type AssertionKeyAlg string

+ const AssertionKeyAlgHS256

+ const AssertionKeyAlgRS256

+ func (a AssertionKeyAlg) String() string

+ type AssertionType string

+ const BaseAssertion

+ const HandlingAssertion

+ func (at AssertionType) String() string

+ type AssertionVerificationKeys struct

+ DefaultKey AssertionKey

+ Keys map[string]AssertionKey

+ func (k AssertionVerificationKeys) Get(assertionID string) (AssertionKey, error)

+ func (k AssertionVerificationKeys) IsEmpty() bool

+ type Binding struct

+ Method string

+ Signature string

+ type BindingMethod string

+ const JWS

+ func (bm BindingMethod) String() string

type Manifest

+ Assertions []Assertion

type Reader

+ func (r *Reader) UnsafePayloadKeyRetrieval() ([]byte, error)

+ type Scope string

+ const Paylaod

+ const TrustedDataObj

+ func (s Scope) String() string

+ type Statement struct

+ Format string

+ Schema string

+ Value string

type TDFOption

+ func WithAssertions(assertionList ...AssertionConfig) TDFOption

+ type TDFReaderConfig struct

+ AssertionVerificationKeys AssertionVerificationKeys

+ type TDFReaderOption func(*TDFReaderConfig) error

+ func WithAssertionVerificationKeys(keys AssertionVerificationKeys) TDFReaderOption

+ type TdfType string

+ const Invalid

+ const Nano

+ const Standard

+ func GetTdfType(reader io.ReadSeeker) TdfType

+ func (t TdfType) String() string

Jul 22, 2024

Changes in this version

+ type PolicyBinding struct

+ Alg string

+ Hash string

Jul 11, 2024

Changes in this version

type KASInfo

+ Default bool

type SDK

+ func (s SDK) CreateTDFContext(ctx context.Context, writer io.Writer, reader io.ReadSeeker, opts ...TDFOption) (*TDFObject, error)

type TDFOption

+ func WithAutoconfigure(enable bool) TDFOption

+ func WithDataAttributeValues(attributes ...*policy.Value) TDFOption

Jul 11, 2024

Changes in this version

type KeyAccess

+ SplitID string

type Reader

+ func (r *Reader) Init(ctx context.Context) error

type SDK

+ func (s SDK) ReadNanoTDFContext(ctx context.Context, writer io.Writer, reader io.ReadSeeker) (uint32, error)

type TDFObject

+ func (t TDFObject) Size() int64

Jul 2, 2024

Changes in this version

type KASInfo

+ Algorithm string

type SDK

+ Unsafe unsafe.UnsafeServiceClient

Jun 24, 2024

Changes in this version

type KASInfo

+ KID string

type KeyAccess

+ KID string

type Option

+ func WithNoKIDInKAO() Option

Jun 10, 2024

Changes in this version

+ const ErrPlatformEndpointMalformed

+ func SanitizePlatformEndpoint(e string) (string, error)

type Option

+ func WithIPC() Option

Jun 3, 2024

Changes in this version

+ const ErrPlatformConfigFailed

type NanoTDFConfig

+ func (config *NanoTDFConfig) EnableECDSAPolicyBinding()

type NanoTDFHeader

+ func (header *NanoTDFHeader) ECCurve() (elliptic.Curve, error)

+ func (header *NanoTDFHeader) IsEcdsaBindingEnabled() bool

+ func (header *NanoTDFHeader) VerifyPolicyBinding() (bool, error)

type NanoTDFOption

+ func WithECDSAPolicyBinding() NanoTDFOption

type Option

+ func WithCustomWellknownConnection(conn *grpc.ClientConn) Option

+ func WithPlatformConfiguration(platformConfiguration PlatformConfiguration) Option

+ type PlatformConfiguration map[string]interface

type SDK

+ func (s SDK) PlatformIssuer() string

May 30, 2024

Changes in this version

+ const ErrNanoTDFHeaderRead

+ func SizeOfAuthTagForCipher(cipherType CipherMode) (int, error)

+ type CipherMode int

+ type NanoKASInfo struct

+ type NanoTDFConfig struct

+ func (config *NanoTDFConfig) SetAttributes(attributes []string)

+ func (config *NanoTDFConfig) SetKasURL(url string) error

+ type NanoTDFHeader struct

+ EncryptedPolicyBody []byte

+ EphemeralKey []byte

+ PolicyBinding []byte

+ func NewNanoTDFHeaderFromReader(reader io.Reader) (NanoTDFHeader, uint32, error)

+ func (header *NanoTDFHeader) GetCipher() CipherMode

+ type NanoTDFOption func(*NanoTDFConfig) error

+ func WithNanoDataAttributes(attributes ...string) NanoTDFOption

+ func WithNanoKasInformation(kasInfoList ...NanoKASInfo) NanoTDFOption

type Option

+ func WithSessionEncryptionRSA(key *rsa.PrivateKey) Option

+ func WithSessionSignerRSA(key *rsa.PrivateKey) Option

+ type ResourceLocator struct

+ func NewResourceLocator(url string) (*ResourceLocator, error)

+ func NewResourceLocatorFromReader(reader io.Reader) (*ResourceLocator, error)

type SDK

+ func (s SDK) CreateNanoTDF(writer io.Writer, reader io.Reader, config NanoTDFConfig) (uint32, error)

+ func (s SDK) NewNanoTDFConfig() (*NanoTDFConfig, error)

+ func (s SDK) ReadNanoTDF(writer io.Writer, reader io.ReadSeeker) (uint32, error)

May 21, 2024

Changes in this version

type Option

+ func WithCustomEntityResolutionConnection(conn *grpc.ClientConn) Option

type SDK

+ EntityResoution entityresolution.EntityResolutionServiceClient

type TDFOption

+ func WithMimeType(mimeType string) TDFOption

May 10, 2024

Changes in this version

+ func NewCertExchangeTokenSource(info oauth.CertExchangeInfo, credentials oauth.ClientCredentials, ...) (auth.AccessTokenSource, error)

+ type CertExchangeTokenSource struct

+ IdpEndpoint string

+ func (c *CertExchangeTokenSource) AccessToken(ctx context.Context, client *http.Client) (auth.AccessToken, error)

+ func (c *CertExchangeTokenSource) MakeToken(tokenMaker func(jwk.Key) ([]byte, error)) ([]byte, error)

+ type NanoTdf struct

+ EphemeralPublicKey *eccKey

type Option

+ func WithInsecurePlaintextConn() Option

+ func WithInsecureSkipVerifyConn() Option

+ func WithTLSCredentials(tls *tls.Config, audience []string) Option

Apr 22, 2024

Changes in this version

+ const ErrGrpcDialFailed

+ const ErrNanoTdfRead

+ const ErrShutdownFailed

+ const GMAC

+ const HS256

+ const JSONFormat

+ const XMLFormat

+ func ReadNanoTDFHeader(reader io.Reader) (*nanoTdf, error)

+ type Assertion struct

+ type AuthConfig struct

+ func NewAuthConfig() (*AuthConfig, error)

+ func NewOIDCAuthConfig(ctx context.Context, host, realm, clientID, clientSecret, subjectToken string) (*AuthConfig, error)

+ type EncryptedMetadata struct

+ Cipher string

+ Iv string

+ type EncryptionInformation struct

+ KeyAccessObjs []KeyAccess

+ KeyAccessType string

+ Method Method

+ Policy string

+ type Error string

+ func (c Error) Error() string

+ type IDPAccessTokenSource struct

+ func NewIDPAccessTokenSource(credentials oauth.ClientCredentials, idpTokenEndpoint string, scopes []string) (*IDPAccessTokenSource, error)

+ func (t *IDPAccessTokenSource) AccessToken() (auth.AccessToken, error)

+ func (t *IDPAccessTokenSource) MakeToken(tokenMaker func(jwk.Key) ([]byte, error)) ([]byte, error)

+ type IDPTokenExchangeTokenSource struct

+ func NewIDPTokenExchangeTokenSource(exchangeInfo oauth.TokenExchangeInfo, credentials oauth.ClientCredentials, ...) (*IDPTokenExchangeTokenSource, error)

+ func (i IDPTokenExchangeTokenSource) AccessToken() (auth.AccessToken, error)

+ func (i IDPTokenExchangeTokenSource) MakeToken(keyMaker func(jwk.Key) ([]byte, error)) ([]byte, error)

+ type IntegrityAlgorithm = int

+ type IntegrityInformation struct

+ DefaultEncryptedSegSize int64

+ DefaultSegmentSize int64

+ SegmentHashAlgorithm string

+ Segments []Segment

+ type KASClient struct

+ type KASInfo struct

+ PublicKey string

+ URL string

+ type KeyAccess struct

+ EncryptedMetadata string

+ KasURL string

+ KeyType string

+ PolicyBinding string

+ Protocol string

+ WrappedKey string

+ type Manifest struct

+ type Method struct

+ Algorithm string

+ IV string

+ IsStreamable bool

+ type Option func(*config)

+ func WithAuthConfig(authConfig AuthConfig) Option

+ func WithClientCredentials(clientID, clientSecret string, scopes []string) Option

+ func WithCustomAuthorizationConnection(conn *grpc.ClientConn) Option

+ func WithCustomPolicyConnection(conn *grpc.ClientConn) Option

+ func WithExtraDialOptions(dialOptions ...grpc.DialOption) Option

+ func WithInsecureConn() Option

+ func WithTokenEndpoint(tokenEndpoint string) Option

+ func WithTokenExchange(subjectToken string, audience []string) Option

+ type Payload struct

+ IsEncrypted bool

+ MimeType string

+ Protocol string

+ Type string

+ URL string

+ type PolicyBody interface

+ type PolicyObject struct

+ Body struct{ ... }

+ UUID string

+ type Reader struct

+ func (r *Reader) DataAttributes() ([]string, error)

+ func (r *Reader) Manifest() Manifest

+ func (r *Reader) Policy() (PolicyObject, error)

+ func (r *Reader) Read(p []byte) (int, error)

+ func (r *Reader) ReadAt(buf []byte, offset int64) (int, error)

+ func (r *Reader) UnencryptedMetadata() ([]byte, error)

+ func (r *Reader) WriteTo(writer io.Writer) (int64, error)

+ type RequestBody struct

+ ClientPublicKey string

+ Policy string

+ type RootSignature struct

+ Algorithm string

+ Signature string

+ type SDK struct

+ Attributes attributes.AttributesServiceClient

+ Authorization authorization.AuthorizationServiceClient

+ KeyAccessServerRegistry kasregistry.KeyAccessServerRegistryServiceClient

+ Namespaces namespaces.NamespaceServiceClient

+ ResourceMapping resourcemapping.ResourceMappingServiceClient

+ SubjectMapping subjectmapping.SubjectMappingServiceClient

+ func New(platformEndpoint string, opts ...Option) (*SDK, error)

+ func (s SDK) Close() error

+ func (s SDK) Conn() *grpc.ClientConn

+ func (s SDK) CreateTDF(writer io.Writer, reader io.ReadSeeker, opts ...TDFOption) (*TDFObject, error)

+ func (s SDK) LoadTDF(reader io.ReadSeeker) (*Reader, error)

+ type Segment struct

+ EncryptedSize int64

+ Hash string

+ Size int64

+ type TDFConfig struct

+ func NewTDFConfig(opt ...TDFOption) (*TDFConfig, error)

+ type TDFFormat = int

+ type TDFObject struct

+ func (t *TDFObject) Manifest() Manifest

+ type TDFOption func(*TDFConfig) error

+ func WithDataAttributes(attributes ...string) TDFOption

+ func WithKasInformation(kasInfoList ...KASInfo) TDFOption

+ func WithMetaData(metaData string) TDFOption

+ func WithSegmentSize(size int64) TDFOption