func Version() string
Version returns the version string for the loaded libmongocrypt, or an empty string if libmongocrypt was not loaded.
Context represents a mongocrypt_ctx_t handle
type Context struct{}
func (c *Context) AddOperationResult(bsoncore.Document) error
AddOperationResult feeds the result of a database operation to mongocrypt.
func (c *Context) Close()
Close cleans up any resources associated with the given Context instance.
func (c *Context) CompleteOperation() error
CompleteOperation signals a database operation has been completed.
func (c *Context) Finish() (bsoncore.Document, error)
Finish performs the final operations for the context and returns the resulting document.
func (c *Context) FinishKmsContexts() error
FinishKmsContexts signals that all KMS contexts have been completed.
func (c *Context) NextKmsContext() *KmsContext
NextKmsContext returns the next KmsContext, or nil if there are no more.
func (c *Context) NextOperation() (bsoncore.Document, error)
NextOperation gets the document for the next database operation to run.
func (c *Context) ProvideKmsProviders(bsoncore.Document) error
ProvideKmsProviders provides the KMS providers when in the NeedKmsCredentials state.
func (c *Context) State() State
State returns the current State of the Context.
Error represents an error from an operation on a MongoCrypt instance.
type Error struct {
Code int32
Message string
}
func (Error) Error() string
Error implements the error interface
KmsContext represents a mongocrypt_kms_ctx_t handle.
type KmsContext struct{}
func (kc *KmsContext) BytesNeeded() int32
BytesNeeded returns the number of bytes that should be received from the KMS. After sending the message to the KMS, this message should be called in a loop until the number returned is 0.
func (kc *KmsContext) FeedResponse([]byte) error
FeedResponse feeds the bytes received from the KMS to mongocrypt.
func (kc *KmsContext) HostName() (string, error)
HostName gets the host name of the KMS.
func (kc *KmsContext) KMSProvider() string
KMSProvider gets the KMS provider of the KMS context.
func (kc *KmsContext) Message() ([]byte, error)
Message returns the message to send to the KMS.
MongoCrypt represents a mongocrypt_t handle.
type MongoCrypt struct{}
func NewMongoCrypt(*options.MongoCryptOptions) (*MongoCrypt, error)
NewMongoCrypt constructs a new MongoCrypt instance configured using the provided MongoCryptOptions.
func (m *MongoCrypt) Close()
Close cleans up any resources associated with the given MongoCrypt instance.
func (m *MongoCrypt) CreateDataKeyContext(string, *options.DataKeyOptions) (*Context, error)
CreateDataKeyContext creates a Context to use for creating a data key.
func (m *MongoCrypt) CreateDecryptionContext(bsoncore.Document) (*Context, error)
CreateDecryptionContext creates a Context to use for decryption.
func (m *MongoCrypt) CreateEncryptionContext(string, bsoncore.Document) (*Context, error)
CreateEncryptionContext creates a Context to use for encryption.
func (m *MongoCrypt) CreateExplicitDecryptionContext(bsoncore.Document) (*Context, error)
CreateExplicitDecryptionContext creates a Context to use for explicit decryption.
func (m *MongoCrypt) CreateExplicitEncryptionContext(bsoncore.Document, *options.ExplicitEncryptionOptions) (*Context, error)
CreateExplicitEncryptionContext creates a Context to use for explicit encryption.
func (m *MongoCrypt) CreateExplicitEncryptionExpressionContext(bsoncore.Document, *options.ExplicitEncryptionOptions) (*Context, error)
CreateExplicitEncryptionExpressionContext creates a Context to use for explicit encryption of an expression.
func (m *MongoCrypt) CryptSharedLibVersion() uint64
CryptSharedLibVersion returns the version number for the loaded crypt_shared library, or 0 if the crypt_shared library was not loaded.
func (m *MongoCrypt) CryptSharedLibVersionString() string
CryptSharedLibVersionString returns the version string for the loaded crypt_shared library, or an empty string if the crypt_shared library was not loaded.
func (m *MongoCrypt) GetKmsProviders(context.Context) (bsoncore.Document, error)
GetKmsProviders returns the originally configured KMS providers.
func (m *MongoCrypt) RewrapDataKeyContext([]byte, *options.RewrapManyDataKeyOptions) (*Context, error)
RewrapDataKeyContext creates a Context to use for rewrapping a data key.
State represents a state that a MongocryptContext can be in.
type State int
These constants are valid values for the State type. The values must match the values defined in the mongocrypt_ctx_state_t enum in libmongocrypt.
const (
StateError State = 0
NeedMongoCollInfo State = 1
NeedMongoMarkings State = 2
NeedMongoKeys State = 3
NeedKms State = 4
Ready State = 5
Done State = 6
NeedKmsCredentials State = 7
)
func (s State) String() string
String implements the Stringer interface.