CBLTLSIdentity.h

Go to the documentation of this file.

//
//  CBLTLSIdentity.h
//
// Copyright (c) 2025 Couchbase, Inc All rights reserved.
//
// 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.
//
 
#pragma once
#include "CBLBase.h"
 
#ifdef COUCHBASE_ENTERPRISE
 
#ifdef __OBJC__
#import <Foundation/Foundation.h>
#import <Security/Security.h>
#endif
 
CBL_CAPI_BEGIN


 
// Certificate Attribute Keys:
CBL_PUBLIC extern const FLString kCBLCertAttrKeyCommonName;        // "CN",              e.g. "Jane Doe", (or "jane.example.com")
CBL_PUBLIC extern const FLString kCBLCertAttrKeyPseudonym;         // "pseudonym",       e.g. "plainjane837"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyGivenName;         // "GN",              e.g. "Jane"
CBL_PUBLIC extern const FLString kCBLCertAttrKeySurname;           // "SN",              e.g. "Doe"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyOrganization;      // "O",               e.g. "Example Corp."
CBL_PUBLIC extern const FLString kCBLCertAttrKeyOrganizationUnit;  // "OU",              e.g. "Marketing"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyPostalAddress;     // "postalAddress",   e.g. "123 Example Blvd #2A"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyLocality;          // "L",               e.g. "Boston"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyPostalCode;        // "postalCode",      e.g. "02134"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyStateOrProvince;   // "ST",              e.g. "Massachusetts" (or "Quebec", ...)
CBL_PUBLIC extern const FLString kCBLCertAttrKeyCountry;           // "C",               e.g. "us" (2-letter ISO country code)
 
// Certificate Subject Alternative Name attribute Keys:
CBL_PUBLIC extern const FLString kCBLCertAttrKeyEmailAddress;      // "rfc822Name",      e.g. "jane@example.com"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyHostname;          // "dNSName",         e.g. "www.example.com"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyURL;               // "uniformResourceIdentifier", e.g. "https://example.com/jane"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyIPAddress;         // "iPAddress",       e.g. An IP Address in binary format e.g. "\x0A\x00\x01\x01"
CBL_PUBLIC extern const FLString kCBLCertAttrKeyRegisteredID;      // "registeredID",    e.g. A domain-specific identifier encoded as an ASN.1 Object Identifier (OID) in DER format.

typedef struct CBLCert CBLCert;
CBL_REFCOUNTED(CBLCert*, Cert);

typedef struct CBLKeyPair CBLKeyPair;
CBL_REFCOUNTED(CBLKeyPair*, KeyPair);

_cbl_warn_unused
CBLCert* _cbl_nullable CBLCert_CreateWithData(FLSlice certData, CBLError* _cbl_nullable outError) CBLAPI;

_cbl_warn_unused
CBLCert* _cbl_nullable CBLCert_CertNextInChain(CBLCert* cert) CBLAPI;

_cbl_warn_unused
FLSliceResult CBLCert_Data(CBLCert* cert, bool pemEncoded) CBLAPI;

_cbl_warn_unused
FLSliceResult CBLCert_SubjectName(CBLCert* cert) CBLAPI;

_cbl_warn_unused
FLSliceResult CBLCert_SubjectNameComponent(CBLCert* cert, FLString attributeKey) CBLAPI;

void CBLCert_ValidTimespan(CBLCert* cert,
                           CBLTimestamp* _cbl_nullable outCreated,
                           CBLTimestamp* _cbl_nullable outExpires) CBLAPI;

_cbl_warn_unused
CBLKeyPair* CBLCert_PublicKey(CBLCert*) CBLAPI;



typedef CBL_ENUM(int, CBLSignatureDigestAlgorithm) {
    kCBLSignatureDigestNone = 0,   
    kCBLSignatureDigestSHA1 = 4,   
    kCBLSignatureDigestSHA224,     
    kCBLSignatureDigestSHA256,     
    kCBLSignatureDigestSHA384,     
    kCBLSignatureDigestSHA512,     
    kCBLSignatureDigestRIPEMD160,  
};

typedef struct CBLExternalKeyCallbacks {
    bool (*publicKeyData)(void* externalKey, void* output, size_t outputMaxLen, size_t* outputLen);
    
    bool (*decrypt)(void* externalKey, FLSlice input, void* output, size_t outputMaxLen, size_t* outputLen);
    
    bool (*sign)(void* externalKey, CBLSignatureDigestAlgorithm digestAlgorithm, FLSlice inputData, void* outSignature);
    
    void (*_cbl_nullable free)(void* externalKey);
} CBLExternalKeyCallbacks;

_cbl_warn_unused
CBLKeyPair* _cbl_nullable CBLKeyPair_CreateWithExternalKey(size_t keySizeInBits,
                                                           void* externalKey,
                                                           CBLExternalKeyCallbacks callbacks,
                                                           CBLError* _cbl_nullable outError) CBLAPI;

_cbl_warn_unused
CBLKeyPair* _cbl_nullable CBLKeyPair_CreateWithPrivateKeyData(FLSlice privateKeyData,
                                                              FLSlice passwordOrNull,
                                                              CBLError* _cbl_nullable outError) CBLAPI;
 

_cbl_warn_unused
FLSliceResult CBLKeyPair_PublicKeyDigest(CBLKeyPair* keyPair) CBLAPI;

_cbl_warn_unused
FLSliceResult CBLKeyPair_PublicKeyData(CBLKeyPair* keyPair) CBLAPI;

_cbl_warn_unused
FLSliceResult CBLKeyPair_PrivateKeyData(CBLKeyPair* keyPair) CBLAPI;



typedef struct CBLTLSIdentity CBLTLSIdentity;
CBL_REFCOUNTED(CBLTLSIdentity*, TLSIdentity);
 

_cbl_warn_unused
CBLCert* CBLTLSIdentity_Certificates(CBLTLSIdentity* identity) CBLAPI;


CBLTimestamp CBLTLSIdentity_Expiration(CBLTLSIdentity* identity) CBLAPI;

typedef CBL_OPTIONS(uint16_t, CBLKeyUsages) {
    kCBLKeyUsagesClientAuth = 0x80, 
    kCBLKeyUsagesServerAuth = 0x40  
};

_cbl_warn_unused
CBLTLSIdentity* _cbl_nullable CBLTLSIdentity_CreateIdentity(CBLKeyUsages keyUsages,
                                                            FLDict attributes,
                                                            int64_t validityInMilliseconds,
                                                            FLString label,
                                                            CBLError* _cbl_nullable outError) CBLAPI;

_cbl_warn_unused
CBLTLSIdentity* _cbl_nullable CBLTLSIdentity_CreateIdentityWithKeyPair(CBLKeyUsages keyUsages,
                                                                       CBLKeyPair* keypair,
                                                                       FLDict attributes,
                                                                       int64_t validityInMilliseconds,
                                                                       CBLError* _cbl_nullable outError) CBLAPI;
 
#if !defined(__linux__) && !defined(__ANDROID__)

bool CBLTLSIdentity_DeleteIdentityWithLabel(FLString label,
                                            CBLError* _cbl_nullable outError) CBLAPI;
 
_cbl_warn_unused
CBLTLSIdentity* _cbl_nullable CBLTLSIdentity_IdentityWithLabel(FLString label,
                                                               CBLError* _cbl_nullable outError) CBLAPI;
 
#endif //#if !defined(__linux__) && !defined(__ANDROID__)

_cbl_warn_unused
CBLTLSIdentity* _cbl_nullable CBLTLSIdentity_IdentityWithKeyPairAndCerts(CBLKeyPair* keypair,
                                                                         CBLCert* cert,
                                                                         CBLError* _cbl_nullable outError) CBLAPI;
 
#if !defined(__linux__) && !defined(__ANDROID__)

_cbl_warn_unused
CBLTLSIdentity* _cbl_nullable CBLTLSIdentity_IdentityWithCerts(CBLCert* cert,
                                                               CBLError* _cbl_nullable outError) CBLAPI;
 
#endif //#if !defined(__linux__) && !defined(__ANDROID__)
 
#ifdef __OBJC__

CBLTLSIdentity* _cbl_nullable CBLTLSIdentity_IdentityWithSecIdentity(SecIdentityRef secIdentity,
                                                                     NSArray* _cbl_nullable certs,
                                                                     CBLError* _cbl_nullable outError) CBLAPI;
 
#endif //#ifdef __OBJC__

   // end of outer \defgroup
 
CBL_CAPI_END
 
#endif // #ifdef COUCHBASE_ENTERPRISE