crypto.h

Go to the documentation of this file.

/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2018-2020 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 LCB_CRYPTO_H
#define LCB_CRYPTO_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct lcbcrypto_SIGV {
    const uint8_t *data; 
    size_t len;          
} lcbcrypto_SIGV;
 
struct lcbcrypto_PROVIDER;
typedef struct lcbcrypto_PROVIDER {
    uint16_t version;                                        
    int16_t _refcnt;                                         
    uint64_t flags;                                          
    void *cookie;                                            
    void (*destructor)(struct lcbcrypto_PROVIDER *provider); 
    union {
        struct {
            void (*release_bytes)(struct lcbcrypto_PROVIDER *provider, void *bytes);
            lcb_STATUS (*generate_iv)(struct lcbcrypto_PROVIDER *provider, uint8_t **iv, size_t *iv_len);
            lcb_STATUS (*sign)(struct lcbcrypto_PROVIDER *provider, const lcbcrypto_SIGV *inputs, size_t input_num,
                               uint8_t **sig, size_t *sig_len);
            lcb_STATUS (*verify_signature)(struct lcbcrypto_PROVIDER *provider, const lcbcrypto_SIGV *inputs,
                                           size_t input_num, uint8_t *sig, size_t sig_len);
            lcb_STATUS (*encrypt)(struct lcbcrypto_PROVIDER *provider, const uint8_t *input, size_t input_len,
                                  const uint8_t *iv, size_t iv_len, uint8_t **output, size_t *output_len);
            lcb_STATUS (*decrypt)(struct lcbcrypto_PROVIDER *provider, const uint8_t *input, size_t input_len,
                                  const uint8_t *iv, size_t iv_len, uint8_t **output, size_t *output_len);
            const char *(*get_key_id)(struct lcbcrypto_PROVIDER *provider);
        } v1;
    } v;
} lcbcrypto_PROVIDER;
 
typedef struct lcbcrypto_FIELDSPEC {
    const char *name; 
    const char *alg;  
    LCB_DEPRECATED2(const char *kid,
                    "Do not use kid field. Encryption keys have to be part of the provider implementation");
} lcbcrypto_FIELDSPEC;
 
typedef struct lcbcrypto_CMDENCRYPT {
    uint16_t version;   
    const char *prefix; 
    const char *doc;    
    size_t ndoc;        
    char *out;   
    size_t nout; 
    lcbcrypto_FIELDSPEC *fields; 
    size_t nfields;              
} lcbcrypto_CMDENCRYPT;
 
typedef struct lcbcrypto_CMDDECRYPT {
    uint16_t version;   
    const char *prefix; 
    const char *doc;    
    size_t ndoc;        
    char *out;   
    size_t nout; 
    lcbcrypto_FIELDSPEC *fields; 
    size_t nfields;              
} lcbcrypto_CMDDECRYPT;
 
LIBCOUCHBASE_API void lcbcrypto_register(lcb_INSTANCE *instance, const char *name, lcbcrypto_PROVIDER *provider);
 
LIBCOUCHBASE_API void lcbcrypto_unregister(lcb_INSTANCE *instance, const char *name);
 
LIBCOUCHBASE_API void lcbcrypto_ref(lcbcrypto_PROVIDER *provider);
 
LIBCOUCHBASE_API void lcbcrypto_unref(lcbcrypto_PROVIDER *provider);
 
#define LCBCRYPTO_DEFAULT_FIELD_PREFIX "__crypt_"
 
LIBCOUCHBASE_API lcb_STATUS lcbcrypto_encrypt_fields(lcb_INSTANCE *instance, lcbcrypto_CMDENCRYPT *cmd);
 
LIBCOUCHBASE_API lcb_STATUS lcbcrypto_decrypt_fields(lcb_INSTANCE *instance, lcbcrypto_CMDDECRYPT *cmd);
#ifdef __cplusplus
}
#endif
#endif /* LCB_CRYPTO_H */