package options

import "go.mongodb.org/mongo-driver/x/mongo/driver/mongocrypt/options"

Index ¶

• type DataKeyOptions
• func DataKey() *DataKeyOptions
• func (dko *DataKeyOptions) SetKeyAltNames(names []string) *DataKeyOptions
• func (dko *DataKeyOptions) SetMasterKey(key bsoncore.Document) *DataKeyOptions
• type ExplicitEncryptionOptions
• func ExplicitEncryption() *ExplicitEncryptionOptions
• func (eeo *ExplicitEncryptionOptions) SetAlgorithm(algorithm string) *ExplicitEncryptionOptions
• func (eeo *ExplicitEncryptionOptions) SetContentionFactor(contentionFactor int64) *ExplicitEncryptionOptions
• func (eeo *ExplicitEncryptionOptions) SetKeyAltName(keyAltName string) *ExplicitEncryptionOptions
• func (eeo *ExplicitEncryptionOptions) SetKeyID(keyID primitive.Binary) *ExplicitEncryptionOptions
• func (eeo *ExplicitEncryptionOptions) SetQueryType(queryType QueryType) *ExplicitEncryptionOptions
• type MongoCryptOptions
• func MongoCrypt() *MongoCryptOptions
• func (mo *MongoCryptOptions) SetBypassQueryAnalysis(bypassQueryAnalysis bool) *MongoCryptOptions
• func (mo *MongoCryptOptions) SetEncryptedFieldsMap(efcMap map[string]bsoncore.Document) *MongoCryptOptions
• func (mo *MongoCryptOptions) SetKmsProviders(kmsProviders bsoncore.Document) *MongoCryptOptions
• func (mo *MongoCryptOptions) SetLocalSchemaMap(localSchemaMap map[string]bsoncore.Document) *MongoCryptOptions
• type QueryType

Types ¶

type DataKeyOptions ¶

type DataKeyOptions struct {
	KeyAltNames []string
	MasterKey   bsoncore.Document
}

DataKeyOptions specifies options for creating a new data key.

func DataKey ¶

func DataKey() *DataKeyOptions

DataKey creates a new DataKeyOptions instance.

func (*DataKeyOptions) SetKeyAltNames ¶

func (dko *DataKeyOptions) SetKeyAltNames(names []string) *DataKeyOptions

SetKeyAltNames specifies alternate key names.

func (*DataKeyOptions) SetMasterKey ¶

func (dko *DataKeyOptions) SetMasterKey(key bsoncore.Document) *DataKeyOptions

SetMasterKey specifies the master key.

type ExplicitEncryptionOptions ¶

type ExplicitEncryptionOptions struct {
	KeyID            *primitive.Binary
	KeyAltName       *string
	Algorithm        string
	QueryType        *QueryType
	ContentionFactor *int64
}

ExplicitEncryptionOptions specifies options for configuring an explicit encryption context.

func ExplicitEncryption ¶

func ExplicitEncryption() *ExplicitEncryptionOptions

ExplicitEncryption creates a new ExplicitEncryptionOptions instance.

func (*ExplicitEncryptionOptions) SetAlgorithm ¶

func (eeo *ExplicitEncryptionOptions) SetAlgorithm(algorithm string) *ExplicitEncryptionOptions

SetAlgorithm specifies an encryption algorithm.

func (*ExplicitEncryptionOptions) SetContentionFactor ¶

func (eeo *ExplicitEncryptionOptions) SetContentionFactor(contentionFactor int64) *ExplicitEncryptionOptions

SetContentionFactor specifies the contention factor.

func (*ExplicitEncryptionOptions) SetKeyAltName ¶

func (eeo *ExplicitEncryptionOptions) SetKeyAltName(keyAltName string) *ExplicitEncryptionOptions

SetKeyAltName sets the key alternative name.

func (*ExplicitEncryptionOptions) SetKeyID ¶

func (eeo *ExplicitEncryptionOptions) SetKeyID(keyID primitive.Binary) *ExplicitEncryptionOptions

SetKeyID sets the key identifier.

func (*ExplicitEncryptionOptions) SetQueryType ¶

func (eeo *ExplicitEncryptionOptions) SetQueryType(queryType QueryType) *ExplicitEncryptionOptions

SetQueryType specifies the query type.

type MongoCryptOptions ¶

type MongoCryptOptions struct {
	KmsProviders        bsoncore.Document
	LocalSchemaMap      map[string]bsoncore.Document
	BypassQueryAnalysis bool
	EncryptedFieldsMap  map[string]bsoncore.Document
}

MongoCryptOptions specifies options to configure a MongoCrypt instance.

func MongoCrypt ¶

func MongoCrypt() *MongoCryptOptions

MongoCrypt creates a new MongoCryptOptions instance.

func (*MongoCryptOptions) SetBypassQueryAnalysis ¶

func (mo *MongoCryptOptions) SetBypassQueryAnalysis(bypassQueryAnalysis bool) *MongoCryptOptions

SetBypassQueryAnalysis skips the NeedMongoMarkings state.

func (*MongoCryptOptions) SetEncryptedFieldsMap ¶

func (mo *MongoCryptOptions) SetEncryptedFieldsMap(efcMap map[string]bsoncore.Document) *MongoCryptOptions

SetEncryptedFieldsMap specifies the encrypted fields map.

func (*MongoCryptOptions) SetKmsProviders ¶

func (mo *MongoCryptOptions) SetKmsProviders(kmsProviders bsoncore.Document) *MongoCryptOptions

SetKmsProviders specifies the KMS providers map.

func (*MongoCryptOptions) SetLocalSchemaMap ¶

func (mo *MongoCryptOptions) SetLocalSchemaMap(localSchemaMap map[string]bsoncore.Document) *MongoCryptOptions

SetLocalSchemaMap specifies the local schema map.

type QueryType ¶

type QueryType int

QueryType describes the type of query the result of Encrypt is used for.

const (
	QueryTypeEquality QueryType = 1
)

These constants specify valid values for QueryType

Source Files ¶

mongocrypt_context_options.go mongocrypt_options.go