Couchbase C Client  2.10.7
Asynchronous C Client for Couchbase
example/crypto/openssl_symmetric_encrypt.c

Shows how to use field-encryption API to encrypt JSON values.

/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
* Copyright 2018 Couchbase, Inc.
*
* 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
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h> /* strlen */
#ifdef _WIN32
#define PRIx64 "I64x"
#else
#include <inttypes.h>
#endif
#include "openssl_symmetric_provider.h"
static void die(lcb_t instance, const char *msg, lcb_error_t err)
{
fprintf(stderr, "%s. Received code 0x%X (%s)\n", msg, err, lcb_strerror(instance, err));
exit(EXIT_FAILURE);
}
static void op_callback(lcb_t instance, int cbtype, const lcb_RESPBASE *rb)
{
if (rb->rc == LCB_SUCCESS) {
fprintf(stderr, "CAS: 0x%" PRIx64 "\n", rb->cas);
} else {
die(instance, lcb_strcbtype(cbtype), rb->rc);
}
}
static void store_encrypted(lcb_t instance, const char *key, const char *val)
{
lcb_CMDSTORE cmd = {};
lcbcrypto_FIELDSPEC field = {};
printf("KEY: %s\n", key);
printf("PLAIN: %s\n", val);
ecmd.version = 0;
ecmd.prefix = NULL;
ecmd.doc = val;
ecmd.ndoc = strlen(val);
ecmd.out = NULL;
ecmd.nout = 0;
ecmd.nfields = 1;
ecmd.fields = &field;
field.name = "message";
field.alg = "AES-256-HMAC-SHA256";
err = lcbcrypto_encrypt_fields(instance, &ecmd);
if (err != LCB_SUCCESS) {
die(instance, "Couldn't encrypt field 'message'", err);
}
/* chop trailing LF for nicer look */
if (ecmd.out[ecmd.nout - 1] == '\n') {
ecmd.out[ecmd.nout - 1] = ' ';
}
printf("CIPHER: %s\n", ecmd.out);
LCB_CMD_SET_KEY(&cmd, key, strlen(key));
LCB_CMD_SET_VALUE(&cmd, ecmd.out, ecmd.nout);
err = lcb_store3(instance, NULL, &cmd);
free(ecmd.out); // NOTE: it should be compatible with what providers use to allocate memory
if (err != LCB_SUCCESS) {
die(instance, "Couldn't schedule storage operation", err);
}
lcb_wait(instance);
}
int main(int argc, char *argv[])
{
lcb_t instance;
{
struct lcb_create_st create_options = {};
create_options.version = 3;
if (argc < 2) {
fprintf(stderr, "Usage: %s couchbase://host/bucket [ password [ username ] ]\n", argv[0]);
exit(EXIT_FAILURE);
}
create_options.v.v3.connstr = argv[1];
if (argc > 2) {
create_options.v.v3.passwd = argv[2];
}
if (argc > 3) {
create_options.v.v3.username = argv[3];
}
err = lcb_create(&instance, &create_options);
if (err != LCB_SUCCESS) {
die(NULL, "Couldn't create couchbase handle", err);
}
err = lcb_connect(instance);
if (err != LCB_SUCCESS) {
die(instance, "Couldn't schedule connection", err);
}
lcb_wait(instance);
err = lcb_get_bootstrap_status(instance);
if (err != LCB_SUCCESS) {
die(instance, "Couldn't bootstrap from cluster", err);
}
lcb_install_callback3(instance, LCB_CALLBACK_STORE, op_callback);
}
lcbcrypto_register(instance, "AES-256-HMAC-SHA256", osp_create());
store_encrypted(instance, "secret-1", "{\"message\":\"The old grey goose jumped over the wrickety gate.\"}");
printf("\n");
store_encrypted(instance, "secret-2", "{\"message\":10}");
printf("\n");
store_encrypted(instance, "secret-3", "{\"message\":\"10\"}");
printf("\n");
store_encrypted(instance, "secret-4", "{\"message\":[\"The\",\"Old\",\"Grey\",\"Goose\",\"Jumped\",\"over\",\"the\",\"wrickety\",\"gate\"]}");
printf("\n");
store_encrypted(instance, "secret-5", "{\"message\":{\"myValue\":\"The old grey goose jumped over the wrickety gate.\",\"myInt\":10}}");
lcb_destroy(instance);
return 0;
}
lcbcrypto_CMDENCRYPT::nout
size_t nout
size of the output JSON document
Definition: crypto.h:142
lcb_wait
lcb_error_t lcb_wait(lcb_t instance)
Wait for the execution of all batched requests.
lcb_strerror
const char * lcb_strerror(lcb_t instance, lcb_error_t error)
Get a textual descrtiption for the given error code.
lcb_create_st3::passwd
const char * passwd
Password for bucket.
Definition: couchbase.h:293
lcb_get_bootstrap_status
lcb_error_t lcb_get_bootstrap_status(lcb_t instance)
Gets the initial bootstrap status.
lcbcrypto_CMDENCRYPT::doc
const char * doc
pointer to the input JSON document
Definition: crypto.h:139
lcb_create_st3::connstr
const char * connstr
Connection string.
Definition: couchbase.h:282
lcb_connect
lcb_error_t lcb_connect(lcb_t instance)
Schedule the initial connection This function will schedule the initial connection for the handle.
lcb_create_st3::username
const char * username
Username to use for authentication.
Definition: couchbase.h:288
LCB_SET
@ LCB_SET
Unconditionally store the item in the cluster.
Definition: couchbase.h:1055
LCB_DATATYPE_JSON
#define LCB_DATATYPE_JSON
Definition: couchbase.h:3355
lcb_error_t
lcb_error_t
Error codes returned by the library.
Definition: error.h:476
lcb_store3
lcb_error_t lcb_store3(lcb_t instance, const void *cookie, const lcb_CMDSTORE *cmd)
Schedule a single storage request.
LCB_CALLBACK_STORE
@ LCB_CALLBACK_STORE
lcb_store3()
Definition: couchbase.h:698
lcbcrypto_CMDENCRYPT
Command to encrypt JSON fields.
Definition: crypto.h:136
crypto.h
lcb_RESPBASE::cas
lcb_CAS cas
CAS for response (if applicable)
Definition: couchbase.h:626
lcb_RESPBASE::rc
lcb_error_t rc
Status code.
Definition: couchbase.h:626
lcb_create_st::lcb_CRST_u::v3
struct lcb_create_st3 v3
Use this field.
Definition: couchbase.h:338
lcbcrypto_register
void lcbcrypto_register(lcb_t instance, const char *name, lcbcrypto_PROVIDER *provider)
Register crypto-provider for specified alias.
lcb_strcbtype
const char * lcb_strcbtype(int cbtype)
Returns the type of the callback as a string.
lcbcrypto_CMDENCRYPT::fields
lcbcrypto_FIELDSPEC * fields
list of field specs
Definition: crypto.h:143
lcb_create_st
Wrapper structure for lcb_create()
Definition: couchbase.h:328
lcbcrypto_CMDENCRYPT::nfields
size_t nfields
number of field specs
Definition: crypto.h:144
lcbcrypto_CMDENCRYPT::version
uint16_t version
version of the structure, currently valid value is 0
Definition: crypto.h:137
LCB_CMD_SET_KEY
#define LCB_CMD_SET_KEY(cmd, keybuf, keylen)
Set the key for the command.
Definition: couchbase.h:556
lcb_t
struct lcb_st * lcb_t
Definition: couchbase.h:41
lcb_create
lcb_error_t lcb_create(lcb_t *instance, const struct lcb_create_st *options)
Create an instance of lcb.
couchbase.h
lcbcrypto_encrypt_fields
lcb_error_t lcbcrypto_encrypt_fields(lcb_t instance, lcbcrypto_CMDENCRYPT *cmd)
Encrypt all specified fields in the JSON encoded object.
LCB_SUCCESS
@ LCB_SUCCESS
Success.
Definition: error.h:478
lcb_RESPBASE
Base response structure for callbacks.
Definition: couchbase.h:625
lcbcrypto_CMDENCRYPT::out
char * out
pointer to output JSON document.
Definition: crypto.h:141
lcb_destroy
void lcb_destroy(lcb_t instance)
Destroy (and release all allocated resources) an instance of lcb.
lcb_CMDSTORE::operation
lcb_storage_t operation
Controls how the operation is perfomed.
Definition: couchbase.h:1113
lcbcrypto_FIELDSPEC::alg
const char * alg
crypto provider alias (NUL-terminated)
Definition: crypto.h:125
lcbcrypto_CMDENCRYPT::prefix
const char * prefix
prefix to encrypted field.
Definition: crypto.h:138
LCB_CMD_SET_VALUE
#define LCB_CMD_SET_VALUE(scmd, valbuf, vallen)
Set the value buffer for the command. This may be used when the new value is a single contiguous buff...
Definition: couchbase.h:1139
lcb_create_st::version
int version
Indicates which field in the lcb_CRST_u union should be used.
Definition: couchbase.h:330
lcb_install_callback3
lcb_RESPCALLBACK lcb_install_callback3(lcb_t instance, int cbtype, lcb_RESPCALLBACK cb)
lcb_CMDSTORE
Command for storing an item to the server.
Definition: couchbase.h:1090
lcbcrypto_CMDENCRYPT::ndoc
size_t ndoc
size of the input JSON document
Definition: crypto.h:140
lcb_CMDSTORE::datatype
lcb_datatype_t datatype
Do not set this value for now.
Definition: couchbase.h:1107
lcbcrypto_FIELDSPEC
Structure for JSON field specification for encrypt/decrypt API.
Definition: crypto.h:123
lcbcrypto_FIELDSPEC::name
const char * name
field name (NUL-terminated)
Definition: crypto.h:124