1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
|
// Copyright (C) MongoDB, Inc. 2017-present.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License. You may obtain
// a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
// +build cse
package mongocrypt
// #cgo linux solaris darwin pkg-config: libmongocrypt
// #cgo windows CFLAGS: -I"c:/libmongocrypt/include"
// #cgo windows LDFLAGS: -lmongocrypt -Lc:/libmongocrypt/bin
// #include <mongocrypt.h>
// #include <stdlib.h>
import "C"
import (
"errors"
"unsafe"
"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"
"go.mongodb.org/mongo-driver/x/mongo/driver/mongocrypt/options"
)
type MongoCrypt struct {
wrapped *C.mongocrypt_t
}
// NewMongoCrypt constructs a new MongoCrypt instance configured using the provided MongoCryptOptions.
func NewMongoCrypt(opts *options.MongoCryptOptions) (*MongoCrypt, error) {
// create mongocrypt_t handle
wrapped := C.mongocrypt_new()
if wrapped == nil {
return nil, errors.New("could not create new mongocrypt object")
}
crypt := &MongoCrypt{
wrapped: wrapped,
}
// set options in mongocrypt
if err := crypt.setProviderOptions(opts.KmsProviders); err != nil {
return nil, err
}
if err := crypt.setLocalSchemaMap(opts.LocalSchemaMap); err != nil {
return nil, err
}
// initialize handle
if !C.mongocrypt_init(crypt.wrapped) {
return nil, crypt.createErrorFromStatus()
}
return crypt, nil
}
// CreateEncryptionContext creates a Context to use for encryption.
func (m *MongoCrypt) CreateEncryptionContext(db string, cmd bsoncore.Document) (*Context, error) {
ctx := newContext(C.mongocrypt_ctx_new(m.wrapped))
if ctx.wrapped == nil {
return nil, m.createErrorFromStatus()
}
cmdBinary := newBinaryFromBytes(cmd)
defer cmdBinary.close()
dbStr := C.CString(db)
defer C.free(unsafe.Pointer(dbStr))
if ok := C.mongocrypt_ctx_encrypt_init(ctx.wrapped, dbStr, C.int32_t(-1), cmdBinary.wrapped); !ok {
return nil, ctx.createErrorFromStatus()
}
return ctx, nil
}
// CreateDecryptionContext creates a Context to use for decryption.
func (m *MongoCrypt) CreateDecryptionContext(cmd bsoncore.Document) (*Context, error) {
ctx := newContext(C.mongocrypt_ctx_new(m.wrapped))
if ctx.wrapped == nil {
return nil, m.createErrorFromStatus()
}
cmdBinary := newBinaryFromBytes(cmd)
defer cmdBinary.close()
if ok := C.mongocrypt_ctx_decrypt_init(ctx.wrapped, cmdBinary.wrapped); !ok {
return nil, ctx.createErrorFromStatus()
}
return ctx, nil
}
// lookupString returns a string for the value corresponding to the given key in the document.
// if the key does not exist or the value is not a string, the empty string is returned.
func lookupString(doc bsoncore.Document, key string) string {
strVal, _ := doc.Lookup(key).StringValueOK()
return strVal
}
func setAltName(ctx *Context, altName string) error {
// create document {"keyAltName": keyAltName}
idx, doc := bsoncore.AppendDocumentStart(nil)
doc = bsoncore.AppendStringElement(doc, "keyAltName", altName)
doc, _ = bsoncore.AppendDocumentEnd(doc, idx)
keyAltBinary := newBinaryFromBytes(doc)
defer keyAltBinary.close()
if ok := C.mongocrypt_ctx_setopt_key_alt_name(ctx.wrapped, keyAltBinary.wrapped); !ok {
return ctx.createErrorFromStatus()
}
return nil
}
// CreateDataKeyContext creates a Context to use for creating a data key.
func (m *MongoCrypt) CreateDataKeyContext(kmsProvider string, opts *options.DataKeyOptions) (*Context, error) {
ctx := newContext(C.mongocrypt_ctx_new(m.wrapped))
if ctx.wrapped == nil {
return nil, m.createErrorFromStatus()
}
// Create a masterKey document of the form { "provider": <provider string>, other options... }.
var masterKey bsoncore.Document
switch {
case opts.MasterKey != nil:
// The original key passed into the top-level API was already transformed into a raw BSON document and passed
// down to here, so we can modify it without copying. Remove the terminating byte to add the "provider" field.
masterKey = opts.MasterKey[:len(opts.MasterKey)-1]
masterKey = bsoncore.AppendStringElement(masterKey, "provider", kmsProvider)
masterKey, _ = bsoncore.AppendDocumentEnd(masterKey, 0)
default:
masterKey = bsoncore.NewDocumentBuilder().AppendString("provider", kmsProvider).Build()
}
masterKeyBinary := newBinaryFromBytes(masterKey)
defer masterKeyBinary.close()
if ok := C.mongocrypt_ctx_setopt_key_encryption_key(ctx.wrapped, masterKeyBinary.wrapped); !ok {
return nil, ctx.createErrorFromStatus()
}
for _, altName := range opts.KeyAltNames {
if err := setAltName(ctx, altName); err != nil {
return nil, err
}
}
if ok := C.mongocrypt_ctx_datakey_init(ctx.wrapped); !ok {
return nil, ctx.createErrorFromStatus()
}
return ctx, nil
}
// CreateExplicitEncryptionContext creates a Context to use for explicit encryption.
func (m *MongoCrypt) CreateExplicitEncryptionContext(doc bsoncore.Document, opts *options.ExplicitEncryptionOptions) (*Context, error) {
ctx := newContext(C.mongocrypt_ctx_new(m.wrapped))
if ctx.wrapped == nil {
return nil, m.createErrorFromStatus()
}
if opts.KeyID != nil {
keyIDBinary := newBinaryFromBytes(opts.KeyID.Data)
defer keyIDBinary.close()
if ok := C.mongocrypt_ctx_setopt_key_id(ctx.wrapped, keyIDBinary.wrapped); !ok {
return nil, ctx.createErrorFromStatus()
}
}
if opts.KeyAltName != nil {
if err := setAltName(ctx, *opts.KeyAltName); err != nil {
return nil, err
}
}
algoStr := C.CString(opts.Algorithm)
defer C.free(unsafe.Pointer(algoStr))
if ok := C.mongocrypt_ctx_setopt_algorithm(ctx.wrapped, algoStr, -1); !ok {
return nil, ctx.createErrorFromStatus()
}
docBinary := newBinaryFromBytes(doc)
defer docBinary.close()
if ok := C.mongocrypt_ctx_explicit_encrypt_init(ctx.wrapped, docBinary.wrapped); !ok {
return nil, ctx.createErrorFromStatus()
}
return ctx, nil
}
// CreateExplicitDecryptionContext creates a Context to use for explicit decryption.
func (m *MongoCrypt) CreateExplicitDecryptionContext(doc bsoncore.Document) (*Context, error) {
ctx := newContext(C.mongocrypt_ctx_new(m.wrapped))
if ctx.wrapped == nil {
return nil, m.createErrorFromStatus()
}
docBinary := newBinaryFromBytes(doc)
defer docBinary.close()
if ok := C.mongocrypt_ctx_explicit_decrypt_init(ctx.wrapped, docBinary.wrapped); !ok {
return nil, ctx.createErrorFromStatus()
}
return ctx, nil
}
// Close cleans up any resources associated with the given MongoCrypt instance.
func (m *MongoCrypt) Close() {
C.mongocrypt_destroy(m.wrapped)
}
func (m *MongoCrypt) setProviderOptions(kmsProviders bsoncore.Document) error {
providersBinary := newBinaryFromBytes(kmsProviders)
defer providersBinary.close()
if ok := C.mongocrypt_setopt_kms_providers(m.wrapped, providersBinary.wrapped); !ok {
return m.createErrorFromStatus()
}
return nil
}
// setLocalSchemaMap sets the local schema map in mongocrypt.
func (m *MongoCrypt) setLocalSchemaMap(schemaMap map[string]bsoncore.Document) error {
if len(schemaMap) == 0 {
return nil
}
// convert schema map to BSON document
midx, mdoc := bsoncore.AppendDocumentStart(nil)
for key, doc := range schemaMap {
mdoc = bsoncore.AppendDocumentElement(mdoc, key, doc)
}
mdoc, _ = bsoncore.AppendDocumentEnd(mdoc, midx)
schemaMapBinary := newBinaryFromBytes(mdoc)
defer schemaMapBinary.close()
if ok := C.mongocrypt_setopt_schema_map(m.wrapped, schemaMapBinary.wrapped); !ok {
return m.createErrorFromStatus()
}
return nil
}
// createErrorFromStatus creates a new Error based on the status of the MongoCrypt instance.
func (m *MongoCrypt) createErrorFromStatus() error {
status := C.mongocrypt_status_new()
defer C.mongocrypt_status_destroy(status)
C.mongocrypt_status(m.wrapped, status)
return errorFromStatus(status)
}
|