c4Certificate.h

Go to the documentation of this file.

//
// c4Certificate.h
//
// Copyright 2019-Present Couchbase, Inc.
//
// Use of this software is governed by the Business Source License included
// in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
// in that file, in accordance with the Business Source License, use of this
// software will be governed by the Apache License, Version 2.0, included in
// the file licenses/APL2.txt.
//
 
#pragma once
 
#include "c4CertificateTypes.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
/*
 * NOTE: All functions in this section are thread-safe because objects of C4Cert are immutable.
 */
 
CBL_CORE_API void c4cert_getValidTimespan(C4Cert* cert, C4Timestamp* C4NULLABLE outCreated,
                                          C4Timestamp* C4NULLABLE outExpires);
 
#ifdef COUCHBASE_ENTERPRISE
 
NODISCARD CBL_CORE_API C4Cert* c4cert_fromData(C4Slice certData, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4SliceResult c4cert_copyData(C4Cert*, bool pemEncoded) C4API;
 
CBL_CORE_API C4StringResult c4cert_summary(C4Cert*) C4API;
 
CBL_CORE_API C4StringResult c4cert_subjectName(C4Cert*) C4API;
 
CBL_CORE_API C4StringResult c4cert_subjectNameComponent(C4Cert*, C4CertNameAttributeID) C4API;
 
NODISCARD CBL_CORE_API bool c4cert_subjectNameAtIndex(C4Cert* cert, unsigned index, C4CertNameInfo* outInfo) C4API;
 
 
CBL_CORE_API C4CertUsage c4cert_usages(C4Cert*) C4API;
 
CBL_CORE_API bool c4cert_isSelfSigned(C4Cert*) C4API;
 
NODISCARD CBL_CORE_API C4KeyPair* c4cert_getPublicKey(C4Cert*) C4API;
 
NODISCARD CBL_CORE_API C4KeyPair* c4cert_loadPersistentPrivateKey(C4Cert*, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Cert* c4cert_createRequest(const C4CertNameComponent* nameComponents, size_t nameCount,
                                                    C4CertUsage certUsages, C4KeyPair* subjectKey,
                                                    C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Cert* c4cert_requestFromData(C4Slice certRequestData, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API bool c4cert_isSigned(C4Cert*) C4API;
 
typedef void (*C4CertSigningCallback)(void* context, C4Cert* signedCert, C4Error error);
 
NODISCARD CBL_CORE_API bool c4cert_sendSigningRequest(C4Cert* certRequest, C4Address address, C4Slice optionsDictFleece,
                                                      C4CertSigningCallback callback, void* C4NULLABLE context,
                                                      C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Cert* c4cert_signRequest(C4Cert* certRequest, const C4CertIssuerParameters* C4NULLABLE params,
                                                  C4KeyPair* issuerPrivateKey, C4Cert* C4NULLABLE issuerCert,
                                                  C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4Cert* C4NULLABLE c4cert_nextInChain(C4Cert*) C4API;
 
CBL_CORE_API C4SliceResult c4cert_copyChainData(C4Cert*) C4API;
 
NODISCARD CBL_CORE_API bool c4cert_save(C4Cert* C4NULLABLE cert, bool entireChain, C4String name,
                                        C4Error* C4NULLABLE outError);
 
NODISCARD CBL_CORE_API C4Cert* c4cert_load(C4String name, C4Error* C4NULLABLE outError);
 
NODISCARD CBL_CORE_API bool c4cert_exists(C4String name, C4Error* C4NULLABLE outError);
 
NODISCARD CBL_CORE_API C4KeyPair* c4keypair_generate(C4KeyPairAlgorithm algorithm, unsigned sizeInBits, bool persistent,
                                                     C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4KeyPair* c4keypair_fromPublicKeyData(C4Slice             publicKeyData,
                                                              C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4KeyPair* c4keypair_fromPrivateKeyData(C4Slice privateKeyData, C4Slice passwordOrNull,
                                                               C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API bool c4keypair_hasPrivateKey(C4KeyPair*) C4API;
 
CBL_CORE_API C4SliceResult c4keypair_publicKeyDigest(C4KeyPair*) C4API;
 
CBL_CORE_API C4SliceResult c4keypair_publicKeyData(C4KeyPair*) C4API;
 
CBL_CORE_API C4SliceResult c4keypair_privateKeyData(C4KeyPair*) C4API;
 
CBL_CORE_API bool c4keypair_isPersistent(C4KeyPair*) C4API;
 
NODISCARD CBL_CORE_API C4KeyPair* c4keypair_persistentWithPublicKey(C4KeyPair*, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4keypair_removePersistent(C4KeyPair*, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4KeyPair* c4keypair_fromExternal(C4KeyPairAlgorithm algorithm, size_t keySizeInBits,
                                                         void* externalKey, C4ExternalKeyCallbacks callbacks,
                                                         C4Error* C4NULLABLE outError);
 
#endif  // COUCHBASE_ENTERPRISE
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END