mt-libcouchbase 1.4.0

data/ext/libcouchbase/example/analytics/queries.h

@@ -0,0 +1,113 @@
+// This file was generated by queries.rb
+typedef struct analytics_query_str { const char *comment; size_t query_len; const char *query; } analytics_query_str;
+size_t num_queries = 27;
+analytics_query_str queries[28] = {
+{"Display dataverses defined by Analytics service",
+ 50,
+ "{\"statement\":\"SELECT * FROM Metadata.`Dataverse`\"}"},
+
+{"Tell analytics service to shadow the data from beer-sample bucket using breweries dataset.",
+ 84,
+ "{\"statement\":\"CREATE DATASET breweries ON `beer-sample` WHERE `type` = \\\"brewery\\\"\"}"},
+
+{"Tell analytics service to shadow the data from beer-sample bucket using beers dataset.",
+ 77,
+ "{\"statement\":\"CREATE DATASET beers ON `beer-sample` WHERE `type` = \\\"beer\\\"\"}"},
+
+{"Initiate the shadowing relationship of datasets to the data in Couchbase Server",
+ 34,
+ "{\"statement\":\"CONNECT LINK Local\"}"},
+
+{"List populated datasets",
+ 129,
+ "{\"statement\":\"SELECT ds.BucketName, ds.DatasetName, ds.`Filter` FROM Metadata.`Dataset` ds WHERE ds.DataverseName = \\\"Default\\\"\"}"},
+
+{"Ask Analytics the number of breweries",
+ 52,
+ "{\"statement\":\"SELECT VALUE COUNT(*) FROM breweries\"}"},
+
+{"Retrieve first brewery, ordered by name",
+ 75,
+ "{\"statement\":\"SELECT * FROM breweries ORDER BY name LIMIT 1\",\"pretty\":true}"},
+
+{"Find a particular brewery based on its Couchbase Server key",
+ 118,
+ "{\"statement\":\"SELECT meta(bw) AS meta, bw AS data FROM breweries bw WHERE meta(bw).id = 'kona_brewing'\",\"pretty\":true}"},
+
+{"Find the same brewery information but in a slightly simpler or cleaner way based only on the data",
+ 94,
+ "{\"statement\":\"SELECT VALUE bw FROM breweries bw WHERE bw.name = 'Kona Brewing'\",\"pretty\":true}"},
+
+{"Find brewery by name, but return objects instead of values",
+ 88,
+ "{\"statement\":\"SELECT bw FROM breweries bw WHERE bw.name = 'Kona Brewing'\",\"pretty\":true}"},
+
+{"Apply a range condition together with a string condition to select breweries",
+ 133,
+ "{\"statement\":\"SELECT VALUE bw FROM breweries bw WHERE bw.geo.lat > 60.0 AND bw.name LIKE '%Brewing%' ORDER BY bw.name\",\"pretty\":true}"},
+
+{"Fetch  list of all breweries paired with their associated beers, with the list enumerating the brewery name and the beer name for each such pair, while also limiting the answer set size to at most 3 results.",
+ 153,
+ "{\"statement\":\"SELECT bw.name AS brewer, br.name AS beer FROM breweries bw, beers br WHERE br.brewery_id = meta(bw).id ORDER BY bw.name, br.name LIMIT 3\"}"},
+
+{"Fetch  list of all breweries paired with their associated beers, including all attributes, while also limiting the answer set size to at most 3 results.",
+ 134,
+ "{\"statement\":\"SELECT * FROM breweries bw, beers br WHERE br.brewery_id = meta(bw).id ORDER BY bw.name, br.name LIMIT 3\",\"pretty\":true}"},
+
+{"Fetch  list of all breweries paired with their associated beers, including all attributes, while also limiting the answer set size to at most 3 results. With ANSI JOINS!",
+ 135,
+ "{\"statement\":\"SELECT * FROM breweries bw JOIN beers br ON br.brewery_id = meta(bw).id ORDER BY bw.name, br.name LIMIT 3\",\"pretty\":true}"},
+
+{"Fetch  list of all breweries paired with their associated beers, including all attributes, while also limiting the answer set size to at most 3 results. Select values explicitly.",
+ 163,
+ "{\"statement\":\"SELECT VALUE {\\\"bw\\\": bw, \\\"br\\\": br} FROM breweries bw, beers br WHERE br.brewery_id = meta(bw).id ORDER BY bw.name, br.name LIMIT 3\",\"pretty\":true}"},
+
+{"For each brewery produce an object that contains the brewery name along with a list of all of the brewery’s offered beer names and alcohol percentages",
+ 197,
+ "{\"statement\":\"SELECT bw.name AS brewer, (SELECT br.name, br.abv FROM beers br WHERE br.brewery_id = meta(bw).id ORDER BY br.name) AS beers FROM breweries bw ORDER BY bw.name LIMIT 2\",\"pretty\":true}"},
+
+{"For each Arizona brewery get the brewery's name, location, and a list of competitors' names -- where competitors are other breweries that are geographically close to their location",
+ 319,
+ "{\"statement\":\"SELECT bw1.name AS brewer, bw1.geo AS location, (SELECT VALUE bw2.name FROM breweries bw2 WHERE bw2.name != bw1.name AND abs(bw1.geo.lat - bw2.geo.lat) <= 0.1 AND abs(bw2.geo.lon - bw1.geo.lon) <= 0.1) AS competitors FROM breweries bw1 WHERE bw1.state = 'Arizona' ORDER BY bw1.name LIMIT 3\",\"pretty\":true}"},
+
+{"Find those breweries whose beers include at least one IPA and return the brewery’s name, phone number, and complete list of beer names and associated alcohol levels.",
+ 336,
+ "{\"statement\":\"WITH nested_breweries AS ( SELECT bw.name AS brewer, bw.phone, ( SELECT br.name, br.abv FROM beers br WHERE br.brewery_id = meta(bw).id ORDER BY br.name) AS beers FROM breweries bw) SELECT VALUE nb FROM nested_breweries nb WHERE (SOME b IN nb.beers SATISFIES b.name LIKE '%IPA%') ORDER BY nb.brewer LIMIT 2\",\"pretty\":true}"},
+
+{"Find those breweries that only have seriously strong beers",
+ 359,
+ "{\"statement\":\"WITH nested_breweries AS ( SELECT bw.name AS brewer, bw.phone, ( SELECT br.name, br.abv FROM beers br WHERE br.brewery_id = meta(bw).id ORDER BY br.name) AS beers FROM breweries bw) SELECT VALUE nb FROM nested_breweries nb WHERE (EVERY b IN nb.beers SATISFIES b.abv >= 10) AND ARRAY_COUNT(nb.beers) > 0 ORDER BY nb.brewer LIMIT 5\",\"pretty\":true}"},
+
+{"Compute the total number of beers in a SQL-like way",
+ 55,
+ "{\"statement\":\"SELECT COUNT(*) AS num_beers FROM beers\"}"},
+
+{"Compute the total number of beers and return unwrapped value",
+ 50,
+ "{\"statement\":\"SELECT VALUE COUNT(b) FROM beers b\"}"},
+
+{"Compute the total number of beers with explicit aggregate function",
+ 65,
+ "{\"statement\":\"SELECT VALUE ARRAY_COUNT((SELECT b FROM beers b))\"}"},
+
+{"For each brewery that offers more than 30 beers, the following group-by or aggregate query reports the number of beers that it offers",
+ 140,
+ "{\"statement\":\"SELECT br.brewery_id, COUNT(*) AS num_beers FROM beers br GROUP BY br.brewery_id HAVING COUNT(*) > 30 ORDER BY COUNT(*) DESC\"}"},
+
+{"For each brewery that offers more than 30 beers, the following group-by or aggregate query reports the number of beers that it offers. With a hash-based aggregation hint.",
+ 152,
+ "{\"statement\":\"SELECT br.brewery_id, COUNT(*) AS num_beers FROM beers br /*+ hash */ GROUP BY br.brewery_id HAVING COUNT(*) > 30 ORDER BY COUNT(*) DESC\"}"},
+
+{"Return the top three breweries based on their numbers of offered beers. Also illustrate the use of multiple aggregate functions to compute various alcohol content statistics for their beers",
+ 236,
+ "{\"statement\":\"SELECT bw.name, COUNT(*) AS num_beers, AVG(br.abv) AS abv_avg, MIN(br.abv) AS abv_min, MAX(br.abv) AS abv_max FROM breweries bw, beers br WHERE br.brewery_id = meta(bw).id GROUP BY bw.name ORDER BY num_beers DESC LIMIT 3\"}"},
+
+{"Find the same brewery information but specify name as parameter",
+ 108,
+ "{\"statement\":\"SELECT VALUE bw FROM breweries bw WHERE bw.name = $name\",\"$name\":\"Kona Brewing\",\"pretty\":true}"},
+
+{"Find the same brewery information but specify name as parameter",
+ 105,
+ "{\"statement\":\"SELECT VALUE bw FROM breweries bw WHERE bw.name = ?\",\"args\":[\"Kona Brewing\"],\"pretty\":true}"},
+
+{NULL, 0, NULL}};

data/ext/libcouchbase/example/crypto/.gitignore

@@ -0,0 +1,2 @@
+openssl_symmetric_decrypt
+openssl_symmetric_encrypt

data/ext/libcouchbase/example/crypto/Makefile

@@ -0,0 +1,13 @@
+LDFLAGS=-lcouchbase -lm
+CFLAGS=-g
+
+OPENSSL_LDFLAGS=$(shell pkg-config --libs openssl) ${LDFLAGS}
+OPENSSL_CFLAGS=$(shell pkg-config --cflags openssl) ${CFLAGS}
+
+all: openssl_symmetric_encrypt openssl_symmetric_decrypt
+
+openssl_symmetric_encrypt: openssl_symmetric_encrypt.c openssl_symmetric_provider.c common_provider.c
+	${CC} ${OPENSSL_CFLAGS} ${OPENSSL_LDFLAGS} -o $@ $^
+
+openssl_symmetric_decrypt: openssl_symmetric_decrypt.c openssl_symmetric_provider.c common_provider.c
+	${CC} ${OPENSSL_CFLAGS} ${OPENSSL_LDFLAGS} -o $@ $^

data/ext/libcouchbase/example/crypto/common_provider.c

@@ -0,0 +1,26 @@
+/* -*- 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 "common_provider.h"
+
+char * common_aes256_key_id = "mykeyid";
+
+uint8_t *common_hmac_sha256_key = "myauthpassword";
+
+uint8_t common_aes256_key[AES256_KEY_SIZE] = "!mysecretkey#9^5usdk39d&dlf)03sL";
+uint8_t common_aes256_iv[AES256_IV_SIZE] = {0x65, 0xe7, 0x66, 0xbe, 0x35, 0xb2, 0xd2, 0x52,
+                                            0x2b, 0x2e, 0x7e, 0x8e, 0x99, 0x9,  0x8d, 0xa9};

data/ext/libcouchbase/example/crypto/common_provider.h

@@ -0,0 +1,33 @@
+/* -*- 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.
+ */
+
+#ifndef _COMMON_PROVIDER_H
+#define _COMMON_PROVIDER_H
+
+#include <libcouchbase/couchbase.h>
+
+extern char * common_aes256_key_id;
+
+#define AES256_KEY_SIZE 32
+#define AES256_IV_SIZE 16
+
+extern uint8_t common_aes256_key[AES256_KEY_SIZE];
+extern uint8_t common_aes256_iv[AES256_IV_SIZE];
+
+extern uint8_t *common_hmac_sha256_key;
+
+#endif

data/ext/libcouchbase/example/crypto/openssl_symmetric_decrypt.c

@@ -0,0 +1,144 @@
+/* -*- 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 <libcouchbase/couchbase.h>
+#include <libcouchbase/crypto.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) {
+        const lcb_RESPGET *rg = (const lcb_RESPGET *)rb;
+        lcbcrypto_CMDDECRYPT dcmd = {};
+        lcbcrypto_FIELDSPEC field = {};
+        lcb_error_t err;
+
+        printf("VALUE:  %.*s\n", (int)rg->nvalue, rg->value);
+        dcmd.version = 0;
+        dcmd.prefix = NULL;
+        dcmd.doc = rg->value;
+        dcmd.ndoc = rg->nvalue;
+        dcmd.out = NULL;
+        dcmd.nout = 0;
+        dcmd.nfields = 1;
+        dcmd.fields = &field;
+        field.name = "message";
+        field.alg = "AES-256-HMAC-SHA256";
+        err = lcbcrypto_decrypt_fields(instance, &dcmd);
+        if (err != LCB_SUCCESS) {
+            die(instance, "Couldn't decrypt field 'message'", err);
+        }
+        if (dcmd.out == NULL) {
+            die(instance, "Crypto provider returned success, but document is NULL", LCB_EINVAL);
+        }
+        /* chop trailing LF for nicer look */
+        if (dcmd.out[dcmd.nout - 1] == '\n') {
+            dcmd.out[dcmd.nout - 1] = ' ';
+        }
+        printf("PLAIN:  %.*s\n", (int)dcmd.nout, dcmd.out);
+        free(dcmd.out); // NOTE: it should be compatible with what providers use to allocate memory
+        printf("CAS:    0x%" PRIx64 "\n", rb->cas);
+    } else {
+        die(instance, lcb_strcbtype(cbtype), rb->rc);
+    }
+}
+
+static void get_encrypted(lcb_t instance, const char *key)
+{
+    lcb_CMDGET cmd = {};
+    lcb_error_t err;
+    LCB_CMD_SET_KEY(&cmd, key, strlen(key));
+    printf("KEY:    %s\n", key);
+    err = lcb_get3(instance, NULL, &cmd);
+    if (err != LCB_SUCCESS) {
+        die(instance, "Couldn't schedule get operation", err);
+    }
+    lcb_wait(instance);
+}
+
+int main(int argc, char *argv[])
+{
+    lcb_error_t err;
+    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_GET, op_callback);
+    }
+
+    lcbcrypto_register(instance, "AES-256-HMAC-SHA256", osp_create());
+
+    get_encrypted(instance, "secret-1");
+    printf("\n");
+    get_encrypted(instance, "secret-2");
+    printf("\n");
+    get_encrypted(instance, "secret-3");
+    printf("\n");
+    get_encrypted(instance, "secret-4");
+    printf("\n");
+    get_encrypted(instance, "secret-5");
+
+    lcb_destroy(instance);
+    return 0;
+}

data/ext/libcouchbase/example/crypto/openssl_symmetric_encrypt.c

@@ -0,0 +1,146 @@
+/* -*- 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 <libcouchbase/couchbase.h>
+#include <libcouchbase/crypto.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_error_t err;
+    lcb_CMDSTORE cmd = {};
+    lcbcrypto_CMDENCRYPT ecmd = {};
+    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);
+    cmd.operation = LCB_SET;
+    cmd.datatype = LCB_DATATYPE_JSON;
+
+    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_error_t err;
+    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;
+}