SharkSSL.h

/*
 *     ____             _________                __                _
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
 *                                                       /____/
 *
 *                 SharkSSL Embedded SSL/TLS Stack
 ****************************************************************************
 *   PROGRAM MODULE
 *
 *   $Id: SharkSSL.h 6407 2026-10-12 21:41:24Z gianluca $
 *
 *   COPYRIGHT:  Real Time Logic LLC, 2010 - 2026
 *
 *   This software is copyrighted by and is the sole property of Real
 *   Time Logic LLC.  All rights, title, ownership, or other interests in
 *   the software remain the property of Real Time Logic LLC.  This
 *   software may only be used in accordance with the terms and
 *   conditions stipulated in the corresponding license agreement under
 *   which the software has been supplied.  Any unauthorized use,
 *   duplication, transmission, distribution, or disclosure of this
 *   software is expressly forbidden.
 *
 *   This Copyright notice may not be removed or modified without prior
 *   written consent of Real Time Logic LLC.
 *
 *   Real Time Logic LLC. reserves the right to modify this software
 *   without notice.
 *
 *               http://www.realtimelogic.com
 *               http://www.sharkssl.com
 ****************************************************************************
 *
 */
#ifndef _SharkSsl_h
#define _SharkSsl_h
 
#include "TargConfig.h"      /* platform dependencies  */
 
#if defined(SHARKDBG_ENABLE) && SHARKDBG_ENABLE
#define SHARKDBG_PRINTF(x) printf x
#else
#define SHARKDBG_PRINTF(x)
#endif
 
#ifndef SHARKSSL_API
#define SHARKSSL_API
#else  /* Barracuda */
#define SHARKSSL_BA 1
#include <ThreadLib.h>
#include <BaServerLib.h>
#endif
 
#include "SharkSSL_cfg.h"    /* SharkSSL configuration */
#if SHARKSSL_PSA_CONSUMER
#include <psa/crypto.h>
#endif
#include <stddef.h>          /* size_t */
 
#include "SharkSslCrypto.h"  /* Crypto API */
 
#ifndef sharkCertSerialNumber2NetworkEndian
typedef U64 SharkCertSerialNumber;
#ifdef B_BIG_ENDIAN
#define sharkCertSerialNumber2NetworkEndian(n)
#else
#define sharkCertSerialNumber2NetworkEndian(n)  \
   do {                                         \
      U64 nn=0;                                 \
      register U8 *t=(U8*)&nn;                  \
      register U8 *f=(U8*)&n;                   \
      t[7]=f[0];                                \
      t[6]=f[1];                                \
      t[5]=f[2];                                \
      t[4]=f[3];                                \
      t[3]=f[4];                                \
      t[2]=f[5];                                \
      t[1]=f[6];                                \
      t[0]=f[7];                                \
      n=nn;                                     \
   } while(0)
#endif
#endif
 
/* Forward decl. */
struct SharkSslCertDN;
struct SharkSslASN1Create;
struct SharkSslBitExtReq;
 
#define SHARKSSL_ALERT_LEVEL_WARNING               1
 
#define SHARKSSL_ALERT_LEVEL_FATAL                 2
 
#define SHARKSSL_ALERT_CLOSE_NOTIFY                0
#define SHARKSSL_ALERT_UNEXPECTED_MESSAGE          10
#define SHARKSSL_ALERT_BAD_RECORD_MAC              20
#define SHARKSSL_ALERT_DECRYPTION_FAILED           21
#define SHARKSSL_ALERT_RECORD_OVERFLOW             22
#define SHARKSSL_ALERT_DECOMPRESSION_FAILURE       30
#define SHARKSSL_ALERT_HANDSHAKE_FAILURE           40
#define SHARKSSL_ALERT_BAD_CERTIFICATE             42
#define SHARKSSL_ALERT_UNSUPPORTED_CERTIFICATE     43
#define SHARKSSL_ALERT_CERTIFICATE_REVOKED         44
#define SHARKSSL_ALERT_CERTIFICATE_EXPIRED         45
#define SHARKSSL_ALERT_CERTIFICATE_UNKNOWN         46
#define SHARKSSL_ALERT_ILLEGAL_PARAMETER           47
#define SHARKSSL_ALERT_UNKNOWN_CA                  48
#define SHARKSSL_ALERT_ACCESS_DENIED               49
#define SHARKSSL_ALERT_DECODE_ERROR                50
#define SHARKSSL_ALERT_DECRYPT_ERROR               51
#define SHARKSSL_ALERT_EXPORT_RESTRICTION          60
#define SHARKSSL_ALERT_PROTOCOL_VERSION            70
#define SHARKSSL_ALERT_INSUFFICIENT_SECURITY       71
#define SHARKSSL_ALERT_INTERNAL_ERROR              80
#define SHARKSSL_ALERT_USER_CANCELED               90
#define SHARKSSL_ALERT_NO_RENEGOTIATION            100
#define SHARKSSL_ALERT_MISSING_EXTENSION           109
#define SHARKSSL_ALERT_UNSUPPORTED_EXTENSION       110
#define SHARKSSL_ALERT_UNRECOGNIZED_NAME           112
#define SHARKSSL_ALERT_GENERAL_ERROR               117
#define SHARKSSL_ALERT_NO_APPLICATION_PROTOCOL     120  /* RFC 7301 */
 /* end group SharkSslAlertMsg */  /* end group SharkSslAlert */ 
 
 
#if SHARKSSL_TLS_1_3
#define TLS_AES_128_GCM_SHA256                              0x1301
#define TLS_AES_256_GCM_SHA384                              0x1302
#define TLS_CHACHA20_POLY1305_SHA256                        0x1303
#endif
#if SHARKSSL_TLS_1_2
#define TLS_DHE_RSA_WITH_AES_128_GCM_SHA256                 0x009E
#define TLS_DHE_RSA_WITH_AES_256_GCM_SHA384                 0x009F
#define TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256             0xC02B
#define TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384             0xC02C
#define TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256               0xC02F
#define TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384               0xC030
#define TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256         0xCCA8
#define TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256       0xCCA9
#define TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256           0xCCAA
#endif
 /* end group SharkSslCiphers */ 
 
 
#define SHARKSSL_PROTOCOL_UNKNOWN                  0x00
#define SHARKSSL_PROTOCOL_TLS_1_2                  0x33
#define SHARKSSL_PROTOCOL_TLS_1_3                  0x34
 
/* internal use, with SHARKSSL_PROTOCOL_TLS_1_x as parameter */
#define SHARKSSL_PROTOCOL_MAJOR(p)                 (p >> 4)
#define SHARKSSL_PROTOCOL_MINOR(p)                 (p & 0xF)
 /* end group SharkSslProtocol */ 
 
 
#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
#ifndef BA_API  /* standalone SharkSSL */
#define BA_API SHARKSSL_API
#ifdef _SHARKSSL_C_
#define SingleListCode 1
#endif
#endif
#include "SingleList.h"
#endif
 
 
#if SHARKSSL_ENABLE_SESSION_CACHE || SHARKSSL_NOPACK
 
typedef struct SharkSslSession SharkSslSession;
 /* end group SharkSslSessionApi */ 
 
#ifndef _DOXYGEN
typedef struct SharkSslSessionCache
{
   SharkSslSession *cache;
   ThreadMutexBase  cacheMutex;
   U16 cacheSize;
} SharkSslSessionCache;
#endif
#endif
 
 
typedef enum
{
   SharkSsl_Unspecified,  
   SharkSsl_Server,       
   SharkSsl_Client        
} SharkSsl_Role;
 /* end group SharkSslInfoAndCodes */
 
 
#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
typedef U8* SharkSslKey;
 
 
typedef const U8 *SharkSslCert;
 
#ifdef __cplusplus
extern "C" {
#endif
 
SHARKSSL_API U16 SharkSslCert_len(SharkSslCert cert);
 
#ifdef __DOXYGEN__
U32 baGetUnixTime(void);
#endif
 
#if SHARKSSL_ENABLE_CSR_CREATION
SHARKSSL_API int
SharkSslASN1Create_CSR(struct SharkSslASN1Create *o,
                       SharkSslKey privKey,
                       U8 hashID,
                       struct SharkSslCertDN *certDN,
                       const char *SAN,
                       struct SharkSslBitExtReq *keyUsage,
                       struct SharkSslBitExtReq *nsCertType);
#endif
 
#if SHARKSSL_ENABLE_CSR_SIGNING
#endif
 
#if SHARKSSL_ENABLE_ASN1_KEY_CREATION
SHARKSSL_API int
SharkSslASN1Create_key(struct SharkSslASN1Create *o, const SharkSslKey key);
#endif
 
 
#ifdef __cplusplus
}
#endif
 
 
#if SHARKSSL_ENABLE_CA_LIST
typedef const U8 *SharkSslCAList;
#endif
 /* end group SharkSslInfoAndCodes */
#endif
 
#ifndef _DOXYGEN
struct SharkSsl;
#endif
 
 
/* Non documented API used by SharkSslSCMgr when used indirectly by
   Lua code in the Barracuda Application Server. The code manages
   automatic destruction of SharkSslSCMgr.
 */
#ifndef _DOXYGEN
struct SharkSslIntf;
typedef void (*SharkSslIntf_Terminate)(struct SharkSslIntf *o,
                                       struct SharkSsl *ssl); 
typedef struct SharkSslIntf
{
   SharkSslIntf_Terminate terminate;
} SharkSslIntf;
#define SharkSslIntf_constructor(o,terminateFunc) (o)->terminate=terminateFunc
#endif
 
 
typedef struct SharkSslCon SharkSslCon;
 
 
#ifdef __cplusplus
extern "C" {
SHARKSSL_API void *sharkssl_mallocObject(size_t size);
SHARKSSL_API void sharkssl_freeObject(void *object);
}
#endif
 
 
typedef struct
SharkSsl
{
#ifdef __cplusplus
   void *operator new(size_t s) { return sharkssl_mallocObject(s); }
   void operator delete(void *d) { sharkssl_freeObject(d); }
   void *operator new(size_t, void *place) { return place; }
   void operator delete(void*, void *) { }
 
   SharkSsl() {};
 
   SharkSsl(SharkSsl_Role role,
            U16 cacheSize         = 0,
            U16 inBufStartSize    = 4096,
            U16 outBufSize        = 4096
            );
 
   ~SharkSsl();
   SharkSslCon *createCon(void);
   U8 setCAList(SharkSslCAList list);
   U8 setCAListEx(SharkSslCAList list, U32 caListLen);
   U8 addCertificate(SharkSslCert cert);
   void terminateCon(SharkSslCon *sslCon);
#endif
   #if (SHARKSSL_SSL_SERVER_CODE && SHARKSSL_SSL_CLIENT_CODE) || SHARKSSL_NOPACK
   SharkSsl_Role role;
   #endif
   U16 outBufSize;
   U16 inBufStartSize;
   U16 nCon;
   #if (SHARKSSL_ENABLE_RSA || (SHARKSSL_ENABLE_ECDSA))  || SHARKSSL_NOPACK
   SingleList certList;
   #if SHARKSSL_ENABLE_CA_LIST || SHARKSSL_NOPACK
   SharkSslCAList caList;
   #endif
   #endif
   #if SHARKSSL_ENABLE_SESSION_CACHE  || SHARKSSL_NOPACK
   SharkSslSessionCache sessionCache;
   /* Reserved for use with one SharkSslSCMgr object  */
   SharkSslIntf *intf;
   #endif
} SharkSsl;
 /* end group SharkSslInfoAndCodes */
 
typedef enum
{
   SharkSslCon_Error = 1, 
 
   SharkSslCon_AllocationError,
 
   SharkSslCon_Decrypted,
 
   SharkSslCon_Handshake,
 
   SharkSslCon_NeedMoreData,
 
   SharkSslCon_AlertSend,
 
   SharkSslCon_AlertRecv,
 
   SharkSslCon_Encrypted,
 
   SharkSslCon_HandshakeNotComplete,
 
   SharkSslCon_CertificateError
 
} SharkSslCon_RetVal;
 /* end group SharkSslCoreApi */
 
#if (SHARKSSL_MAX_HANDSHAKE_LENGTH > 0xFFFFUL)
typedef U32 SharkSslSANLen;
#else
typedef U16 SharkSslSANLen;
#endif
 
#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
 
#if SHARKSSL_ENABLE_CERT_KEYUSAGE
#define SHARKSSL_CERT_KEYUSAGE_DIGITALSIGNATURE     0x00000001
#define SHARKSSL_CERT_KEYUSAGE_NONREPUDIATION       0x00000002
#define SHARKSSL_CERT_KEYUSAGE_KEYENCIPHERMENT      0x00000004
#define SHARKSSL_CERT_KEYUSAGE_DATAENCIPHERMENT     0x00000008
#define SHARKSSL_CERT_KEYUSAGE_KEYAGREEMENT         0x00000010
#define SHARKSSL_CERT_KEYUSAGE_KEYCERTSIGN          0x00000020
#define SHARKSSL_CERT_KEYUSAGE_CRLSIGN              0x00000040
#define SHARKSSL_CERT_KEYUSAGE_ENCIPHERONLY         0x00000080 
#define SHARKSSL_CERT_KEYUSAGE_DECIPHERONLY         0x00000100
#define SHARKSSL_CERT_KEYUSAGE_PRESENT              0x00000200
#define SHARKSSL_CERT_KEYUSAGE_CRITICAL             0x00000400
 
#define SHARKSSL_CERT_KEYPURPOSE_SERVERAUTH         0x00010000
#define SHARKSSL_CERT_KEYPURPOSE_CLIENTAUTH         0x00020000
#define SHARKSSL_CERT_KEYPURPOSE_CODESIGNING        0x00040000
#define SHARKSSL_CERT_KEYPURPOSE_EMAILPROTECTION    0x00080000
#define SHARKSSL_CERT_KEYPURPOSE_TIMESTAMPING       0x00100000
#define SHARKSSL_CERT_KEYPURPOSE_OCSPSIGNING        0x00200000
 
#define SharkSslCertInfo_KeyFlagSet(o,f)            ((o)->keyUsagePurposes & f)
 
#define SharkSslCertInfo_isKeyUsagePresent(o)       SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_PRESENT)
#define SharkSslCertInfo_isKeyUsageCritical(o)      SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_CRITICAL)
#define SharkSslCertInfo_KU_digitalSignature(o)     SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_DIGITALSIGNATURE)
#define SharkSslCertInfo_KU_nonRepudiation(o)       SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_NONREPUDIATION)
#define SharkSslCertInfo_KU_keyEncipherment(o)      SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_KEYENCIPHERMENT)
#define SharkSslCertInfo_KU_dataEncipherment(o)     SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_DATAENCIPHERMENT)
#define SharkSslCertInfo_KU_keyAgreement(o)         SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_KEYAGREEMENT)
#define SharkSslCertInfo_KU_keyCertSign(o)          SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_KEYCERTSIGN)
#define SharkSslCertInfo_KU_cRLSign(o)              SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_CRLSIGN)
#define SharkSslCertInfo_KU_encipherOnly(o)         SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_ENCIPHERONLY)
#define SharkSslCertInfo_KU_decipherOnly(o)         SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_DECIPHERONLY)
 
#define SharkSslCertInfo_kp_serverAuth(o)           SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_SERVERAUTH)
#define SharkSslCertInfo_kp_clientAuth(o)           SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_CLIENTAUTH)
#define SharkSslCertInfo_kp_codeSigning(o)          SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_CODESIGNING)
#define SharkSslCertInfo_kp_emailProtection(o)      SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_EMAILPROTECTION)
#define SharkSslCertInfo_kp_timeStamping(o)         SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_TIMESTAMPING)
#define SharkSslCertInfo_kp_OCSPSigning(o)          SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_OCSPSIGNING)
#endif
 
 
typedef struct SharkSslCertDN
{
   const U8 *countryName; 
   const U8 *province;  
   const U8 *locality; 
   const U8 *organization; 
   const U8 *unit; 
   const U8 *commonName;
   const U8 *emailAddress;
 
   U8 countryNameLen;   
   U8 provinceLen;      
   U8 localityLen;      
   U8 organizationLen;  
   U8 unitLen;          
   U8 commonNameLen;    
   U8 emailAddressLen;  
} SharkSslCertDN;
 
#define SharkSslCertDN_constructor(o) memset(o,0,sizeof(SharkSslCertDN))
#define SharkSslCertDN_setCountryName(o, countryNameMA) \
   (o)->countryName=(const U8*)countryNameMA,(o)->countryNameLen=(U8)strlen(countryNameMA)
#define SharkSslCertDN_setProvince(o, provinceMA) \
   (o)->province=(const U8*)provinceMA,(o)->provinceLen=(U8)strlen(provinceMA)
#define SharkSslCertDN_setLocality(o, localityMA) \
   (o)->locality=(const U8*)localityMA,(o)->localityLen=(U8)strlen(localityMA)
#define SharkSslCertDN_setOrganization(o, organizationMA) \
   (o)->organization=(const U8*)organizationMA,(o)->organizationLen=(U8)strlen(organizationMA)
#define SharkSslCertDN_setUnit(o, unitMA) \
   (o)->unit=(const U8*)unitMA,(o)->unitLen=(U8)strlen(unitMA)
#define SharkSslCertDN_setCommonName(o, commonNameMA) \
   (o)->commonName=(const U8*)commonNameMA,(o)->commonNameLen=(U8)strlen(commonNameMA)
#define SharkSslCertDN_setEmailAddress(o, emailAddressMA) \
   (o)->emailAddress=(const U8*)emailAddressMA,(o)->emailAddressLen=(U8)strlen(emailAddressMA)
 
 
typedef struct SharkSslCertInfo
{
   U16 snLen;
 
   U8  version; 
 
   U8 CAflag;
 
   U8 *sn;
 
   U8 *timeFrom;  /* declaration of U8 timeFromLen below */
 
   U8 *timeTo;    /* declaration of U8 timeToLen below */
 
   SharkSslCertDN issuer;
 
   SharkSslCertDN subject;
 
   U8 *subjectAltNamesPtr;
   SharkSslSANLen subjectAltNamesLen;
 
   U8  timeFromLen;
 
   U8  timeToLen;
 
   #if SHARKSSL_ENABLE_CERT_KEYUSAGE
   U32 keyUsagePurposes; 
   #endif
 
   struct SharkSslCertInfo *parent;
} SharkSslCertInfo;
 /* end group SharkSslCertInfo */ 
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
SHARKSSL_API void  SharkSsl_constructor(
                      SharkSsl *o,
                      SharkSsl_Role role,
                      U16 cacheSize,
                      U16 inBufStartSize,
                      U16 outBufSize
                      );
 
SHARKSSL_API void  SharkSsl_destructor(SharkSsl *o);
 
 
SharkSslCon *SharkSsl_createCon(SharkSsl *o);
 
 
void SharkSsl_terminateCon(const SharkSsl *o, SharkSslCon *con);
 
 
#if SHARKSSL_ENABLE_SESSION_CACHE
 
SHARKSSL_API U16   SharkSsl_getCacheSize(SharkSsl *o);
 
#define SharkSsl_setIntf(o, sharkSslIntf) (o)->intf=sharkSslIntf
#define SharkSsl_getIntf(o) (o)->intf
 
#endif
 
 
#define SharkSslCon_terminate(o) SharkSsl_terminateCon(0, o)
 
SharkSslCon_RetVal SharkSslCon_decrypt(SharkSslCon *o, U16 readLen);
 
 
SharkSslCon_RetVal SharkSslCon_encrypt(SharkSslCon *o, U8 *buf, U16 maxLen);
 
 
SHARKSSL_API SharkSslCon_RetVal SharkSslCon_close(SharkSslCon *o);
 
 
#if (SHARKSSL_TLS_1_3 && SHARKSSL_ENABLE_KEY_UPDATE)
#define SHARKSSL_KEY_UPDATE_NOT_REQUESTED          0
 
#define SHARKSSL_KEY_UPDATE_REQUESTED              1
 
SHARKSSL_API U8 SharkSslCon_keyUpdate(SharkSslCon *o, U8 requestUpdate);
#if SHARKSSL_ENABLE_AES_GCM
SHARKSSL_API int SharkSslCon_proactiveKeyUpdate(SharkSslCon *o);
#endif
#endif
 
 
U8 SharkSslCon_isHandshakeComplete(SharkSslCon *o);
 
 
U8  SharkSslCon_encryptMore(SharkSslCon *o);
 
 
U8  SharkSslCon_decryptMore(SharkSslCon *o);
 
U8 *SharkSslCon_getBuf(SharkSslCon *o);
 
 
U16 SharkSslCon_getBufLen(SharkSslCon *o);
 
U16 SharkSslCon_copyDecData(SharkSslCon *o, U8 *buf, U16 maxLen);
 
 
SHARKSSL_API U16 SharkSslCon_getDecData(SharkSslCon *o, U8 **bufPtr);
 
 
U8 *SharkSslCon_getHandshakeData(SharkSslCon *o);
 
 
U16 SharkSslCon_getHandshakeDataLen(SharkSslCon *o);
 
 
U16 SharkSslCon_setHandshakeDataSent(SharkSslCon *o, U16 length);
 
 
U8 *SharkSslCon_getEncData(SharkSslCon *o);
 
 
U16 SharkSslCon_getEncDataLen(SharkSslCon *o);
 
 
U8 *SharkSslCon_getEncBufPtr(SharkSslCon *o);
 
 
U16 SharkSslCon_getEncBufSize(SharkSslCon *o);
 
 
U8  SharkSslCon_getAlertLevel(SharkSslCon *o);
 
 
U8  SharkSslCon_getAlertDescription(SharkSslCon *o);
 
 
#define SharkSslCon_getAlertData(o)    SharkSslCon_getEncData(o)
 
 
#define SharkSslCon_getAlertDataLen(o) SharkSslCon_getEncDataLen(o)
 /* end group SharkSslCoreApi */ 
 
 
#if SHARKSSL_ENABLE_INFO_API
 
SHARKSSL_API U16 SharkSslCon_getCiphersuite(SharkSslCon *o);
 
#if (SHARKSSL_TLS_1_3 && SHARKSSL_TLS_1_2)
SHARKSSL_API U8  SharkSslCon_getProtocol(SharkSslCon *o);
#elif SHARKSSL_TLS_1_3
#define SharkSslCon_getProtocol(o) (SHARKSSL_PROTOCOL_TLS_1_3)
#elif SHARKSSL_TLS_1_2
#define SharkSslCon_getProtocol(o) (SHARKSSL_PROTOCOL_TLS_1_2)
#else
#error please enable at least one of SHARKSSL_TLS_1_3, SHARKSSL_TLS_1_2
#endif
 
#endif
 
 
#if SHARKSSL_ENABLE_SNI
 
#if SHARKSSL_SSL_CLIENT_CODE
SHARKSSL_API U8  SharkSslCon_setSNI(SharkSslCon *o, const char *name, U16 length); 
#endif
 
#endif
 
 
#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
#if (SHARKSSL_SSL_CLIENT_CODE && SHARKSSL_ENABLE_CLIENT_AUTH)
U8  SharkSslCon_certificateRequested(SharkSslCon *o);
#endif
 
SHARKSSL_API SharkSslCertInfo  *SharkSslCon_getCertInfo(SharkSslCon *o);
 
 
#if (SHARKSSL_ENABLE_CERTINFO_PARSE_API && (SHARKSSL_SSL_CLIENT_CODE || SHARKSSL_SSL_SERVER_CODE || SHARKSSL_ENABLE_CSR_SIGNING || SHARKSSL_SSL_TOOLS_CODE))
SHARKSSL_API int SharkSslCertInfo_parseCert(SharkSslCertInfo *o, const U8 *der, U32 len);
#endif
 
 
SHARKSSL_API U8 SharkSsl_addCertificate(SharkSsl *o, SharkSslCert cert);
 
#if SHARKSSL_PSA_CONSUMER
SHARKSSL_API U8 SharkSsl_addCertificatePSA(SharkSsl *o, SharkSslCert cert, psa_key_id_t psaKey);
#endif
 
#if SHARKSSL_ENABLE_CA_LIST
 
SHARKSSL_API U8 SharkSsl_setCAListEx(SharkSsl *o, SharkSslCAList caList, U32 caListLen);
#define SharkSsl_setCAList(o, caList) SharkSsl_setCAListEx((o), (caList), 0)
 
SHARKSSL_API U8  SharkSslCon_trustedCA(SharkSslCon *o);
 
U8  SharkSslCon_isCAListEmpty(SharkSslCon *o);
#else
 
#define  SharkSslCon_trustedCA(o)   0
#endif  /* SHARKSSL_ENABLE_CA_LIST */
 
#if (SHARKSSL_SSL_SERVER_CODE && SHARKSSL_ENABLE_RSA)
#define SHARKSSL_SET_FAVOR_RSA      1  
#define SHARKSSL_CLEAR_FAVOR_RSA    0
 
U8  SharkSslCon_favorRSA(SharkSslCon *o, U8 flag);
#endif  /* SHARKSSL_SSL_SERVER_CODE */
#endif  /* SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA */
 
U8  SharkSslCon_selectProtocol(SharkSslCon *o, U8 protocol);
 
#if SHARKSSL_ENABLE_SESSION_CACHE
 
#if SHARKSSL_ENABLE_INFO_API
SHARKSSL_API U8    SharkSslCon_isResumed(SharkSslCon *o);
#endif
 
SHARKSSL_API U8    SharkSslSession_release(SharkSslSession *o, SharkSsl *s);
 
#if SHARKSSL_SSL_SERVER_CODE
SHARKSSL_API U8    SharkSslCon_releaseSession(SharkSslCon *o);
#endif
 
#if SHARKSSL_SSL_CLIENT_CODE 
 
SHARKSSL_API SharkSslSession *SharkSslCon_acquireSession(SharkSslCon *o);
 
 
SHARKSSL_API U8 SharkSslCon_resumeSession(SharkSslCon *o, SharkSslSession *s); 
 
SHARKSSL_API U32   SharkSslSession_getLatestAccessTime(SharkSslSession *o);
#endif
#endif
 /* end group SharkSslSessionApi */
 
#if (SHARKSSL_SSL_SERVER_CODE && SHARKSSL_ENABLE_CLIENT_AUTH && \
    (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA))
SHARKSSL_API U8 SharkSslCon_requestClientCertEx(SharkSslCon *o, const void *caList, U32 caListLen);
#define SharkSslCon_requestClientCert(o, caList) SharkSslCon_requestClientCertEx((o), (caList), 0)
#endif
 
#if (SHARKSSL_TLS_1_3 && SHARKSSL_SSL_CLIENT_CODE && SHARKSSL_ENABLE_CA_EXTENSION && \
    (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA))
SHARKSSL_API U8 SharkSslCon_setCertificateAuthoritiesEx(SharkSslCon *o, const void *caList, U32 caListLen);
#define SharkSslCon_setCertificateAuthorities(o, caList) SharkSslCon_setCertificateAuthoritiesEx((o), (caList), 0)
#endif
 
#if SHARKSSL_ENABLE_ALPN_EXTENSION
#if SHARKSSL_SSL_CLIENT_CODE
SHARKSSL_API U8 SharkSslCon_setALPNProtocols(SharkSslCon *o, const char *protList);
 
SHARKSSL_API const char *SharkSslCon_getALPNProtocol(SharkSslCon *o);
#endif
#if SHARKSSL_SSL_SERVER_CODE
typedef int(*ALPNFunction)(SharkSslCon*, const char*, void*);
SHARKSSL_API U8 SharkSslCon_setALPNFunction(
   SharkSslCon *o, ALPNFunction func, void *pvoid);
#endif
#endif  /* SHARKSSL_ENABLE_ALPN_EXTENSION */
 
#if ((SHARKSSL_SSL_SERVER_CODE || SHARKSSL_SSL_CLIENT_CODE) && \
     SHARKSSL_ENABLE_SELECT_CIPHERSUITE)
SHARKSSL_API U8 SharkSslCon_selectCiphersuite(SharkSslCon *o, U16 cipherSuite);
 
SHARKSSL_API U8 SharkSslCon_clearCiphersuiteSelection(SharkSslCon *o); 
#endif
 
#if (SHARKSSL_SSL_SERVER_CODE && SHARKSSL_ENABLE_SECURE_RENEGOTIATION)
SHARKSSL_API U8 SharkSslCon_renegotiate(SharkSslCon *o);
#endif
 /* end group SharkSslApi */ 
 
 
#if SHARKSSL_ENABLE_PEM_API
typedef enum
{
   SHARKSSL_PEM_OK = 0,
 
   SHARKSSL_PEM_OK_PUBLIC = 1,
 
   SHARKSSL_PEM_ALLOCATION_ERROR = - 3000,
 
   SHARKSSL_PEM_KEY_PARSE_ERROR,
 
   SHARKSSL_PEM_KEY_WRONG_IV,
 
   SHARKSSL_PEM_KEY_WRONG_LENGTH,
 
   SHARKSSL_PEM_KEY_PASSPHRASE_REQUIRED,
 
   SHARKSSL_PEM_KEY_UNRECOGNIZED_FORMAT,
 
   SHARKSSL_PEM_KEY_UNSUPPORTED_FORMAT,
 
   SHARKSSL_PEM_KEY_UNSUPPORTED_MODULUS_LENGTH,
 
   SHARKSSL_PEM_KEY_UNSUPPORTED_EXPONENT_LENGTH,
 
   SHARKSSL_PEM_KEY_UNSUPPORTED_ENCRYPTION_TYPE,
 
   SHARKSSL_PEM_KEY_CERT_MISMATCH,
 
   SHARKSSL_PEM_CERT_UNRECOGNIZED_FORMAT,
 
   SHARKSSL_PEM_CERT_UNSUPPORTED_TYPE,
 
   SHARKSSL_PEM_KEY_UNSUPPORTED_VERSION,
 
   SHARKSSL_PEM_KEY_REQUIRED,
 
   SHARKSSL_PEM_KEY_PRIVATE_KEY_REQUIRED,
 
   SHARKSSL_PEM_INTERNAL_ERROR
} sharkssl_PEM_RetVal;
 
 
SHARKSSL_API sharkssl_PEM_RetVal sharkssl_PEM(
   const char *certPEM, const char *keyPEM, 
   const char *passphrase, SharkSslCert *sharkSslCert);
 
#if SHARKSSL_ENABLE_ENCRYPTED_PKCS8_SUPPORT
SHARKSSL_API int sharkssl_PEM_PBKDF2(
   U8 *dk, const char *passphrase, 
   const char *salt, U32 saltLen, 
   U32 iterations, U16 dkLen, U8 hashID);
#endif
 /* end group RayCryptoApi */
#endif
 
#if SHARKSSL_ENABLE_RSA
 
#define SHARKSSL_RSA_NO_PADDING      0
 
 
#define SHARKSSL_RSA_PKCS1_PADDING   1
 
 
typedef enum
{
   SHARKSSL_RSA_OK = 0,
 
   SHARKSSL_RSA_ALLOCATION_ERROR = -3000,
 
   SHARKSSL_RSA_INTERNAL_ERROR = -3100,
 
   SHARKSSL_RSA_WRONG_PARAMETERS,
 
   SHARKSSL_RSA_WRONG_KEY_FORMAT,
 
   SHARKSSL_RSA_WRONG_KEY_LENGTH,
 
   SHARKSSL_RSA_INPUT_DATA_LENGTH_TOO_BIG,
 
   SHARKSSL_RSA_INPUT_DATA_LENGTH_AND_KEY_LENGTH_MISMATCH,
 
   SHARKSSL_RSA_PKCS1_PADDING_ERROR,
 
   SHARKSSL_RSA_KEY_NOT_PRIVATE,
 
   SHARKSSL_RSA_VERIFICATION_FAIL,
 
   SHARKSSL_RSA_WRONG_SIGNATURE,
 
   SHARKSSL_RSA_WRONG_LABEL_LENGTH
} sharkssl_RSA_RetVal;
#endif
 /* end group SharkSslInfoAndCodes */ 
 
#if SHARKSSL_ENABLE_RSA_API
 
typedef U8* SharkSslRSAKey;
 
#if SHARKSSL_ENABLE_PEM_API
SHARKSSL_API SharkSslRSAKey sharkssl_PEM_to_RSAKey(
   const char *PEMKey, const char *passphrase);
 
SHARKSSL_API SharkSslKey
sharkssl_PEM_extractPublicKey(const char *certPEM);
 
SHARKSSL_API SharkSslKey
sharkssl_PEM_extractPublicKey_ext(const char *certPEM, U8 *keyType);
#endif  /* SHARKSSL_ENABLE_PEM_API */
 
#if (SHARKSSL_ENABLE_PEM_API || (SHARKSSL_ENABLE_RSA && SHARKSSL_ENABLE_RSAKEY_CREATE))
SHARKSSL_API void SharkSslRSAKey_free(SharkSslRSAKey key);
#define _SHARKSSLRSAKEY_FREE 1
#endif
 
#if SHARKSSL_ENABLE_RSA
#if SHARKSSL_ENABLE_RSAKEY_CREATE
SHARKSSL_API int SharkSslRSAKey_create(SharkSslRSAKey *privKey, U16 keyLength);
 
SHARKSSL_API U8 *SharkSslRSAKey_getPublic(SharkSslRSAKey privKey);
#endif 
 
SHARKSSL_API U16 SharkSslRSAKey_size(SharkSslRSAKey key);
 
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_public_encrypt(
    SharkSslRSAKey pubkey, const U8 *in, int len, U8 *out, int padding);
 
 
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_private_decrypt(
   SharkSslRSAKey privkey, const U8 *in, int len, U8 *out, int padding);
 
 
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_PKCS1V1_5_sign_hash(
   SharkSslRSAKey privkey, U8 *sig, U16 *siglen, const U8 *hash, U8 hashID);
 
 
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_PKCS1V1_5_verify_hash(
   SharkSslRSAKey pubkey, U8 *sig, U16 siglen, const U8 *hash, U8 hashID);
 
 
#if SHARKSSL_ENABLE_RSA_OAEP
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_private_decrypt_OAEP(
   SharkSslRSAKey privkey, U8 *in, int len, U8 hashID, U8 *out, const char *label, U16 labelLen);
 
 
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_public_encrypt_OAEP(
   SharkSslRSAKey pubkey, const U8 *in, int len, U8 hashID, U8 *out, const char *label, U16 labelLen);
#endif
 
 
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_private_encrypt(
   SharkSslRSAKey privkey, const U8 *in, int len, U8 *out, int padding);
 
 
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_public_decrypt(
   SharkSslRSAKey pubkey, const U8 *in, int len, U8 *out, int padding);
 
#endif
 /* end group RSA */
#endif
 
 
#if SHARKSSL_USE_ECC
/*
 * NamedCurve, use as curveID parameter
 * SECPxxxR1       - RFC 4492 section 5.1.1
 * BRAINPOOLPxxxR1 - RFC 7027 section 2
 * CURVE25519,448  - RFC 8446 section 4.2.7
 */
#define SHARKSSL_EC_CURVE_ID_SECP256R1        23
#define SHARKSSL_EC_CURVE_ID_SECP384R1        24
#define SHARKSSL_EC_CURVE_ID_SECP521R1        25
#define SHARKSSL_EC_CURVE_ID_BRAINPOOLP256R1  26
#define SHARKSSL_EC_CURVE_ID_BRAINPOOLP384R1  27
#define SHARKSSL_EC_CURVE_ID_BRAINPOOLP512R1  28
#define SHARKSSL_EC_CURVE_ID_CURVE25519       29
#define SHARKSSL_EC_CURVE_ID_CURVE448         30
 
#define SHARKSSL_X25519_KEY_LEN               32
 
 
#if (SHARKSSL_ECC_USE_CURVE25519 && SHARKSSL_ENABLE_X25519_API)
SHARKSSL_API int sharkssl_X25519_createKeyPair(
   U8 privateKey[SHARKSSL_X25519_KEY_LEN],
   U8 publicKey[SHARKSSL_X25519_KEY_LEN]);
 
 
SHARKSSL_API int sharkssl_X25519_sharedSecret(
   const U8 privateKey[SHARKSSL_X25519_KEY_LEN],
   const U8 peerPublicKey[SHARKSSL_X25519_KEY_LEN],
   U8 sharedSecret[SHARKSSL_X25519_KEY_LEN]);
#endif
 
 
typedef U8* SharkSslECCKey;
 
#if SHARKSSL_ENABLE_PEM_API
SHARKSSL_API SharkSslECCKey sharkssl_PEM_to_ECCKey(
   const char *PEMKey, const char *passphrase);
#endif  /* SHARKSSL_ENABLE_PEM_API */
 
 
#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
SHARKSSL_API U16 SharkSslKey_vectSize(const SharkSslKey key);
#define SharkSslCert_vectSize(c) SharkSslKey_vectSize((const SharkSslCert)c)
#define SharkSslCert_vectSize_keyInfo(c, t, p, a, b, x, y) SharkSslKey_vectSize_keyInfo((const SharkSslKey)c, t, p, a, b, x, y)
#if SHARKSSL_ENABLE_RSA
#define SharkSslRSAKey_vectSize(k) SharkSslKey_vectSize(k)
#define SharkSslRSAKey_vectSize_keyInfo(k, t, p, a, b, x, y) SharkSslKey_vectSize_keyInfo((const SharkSslKey)k, t, p, a, b, x, y)
#endif
#if SHARKSSL_ENABLE_ECDSA
#define SharkSslECCKey_vectSize(k) SharkSslKey_vectSize(k)
#define SharkSslECCKey_vectSize_keyInfo(k, t, p, a, b, x, y) SharkSslKey_vectSize_keyInfo((const SharkSslKey)k, t, p, a, b, x, y)
#endif
 
/* return values of function SharkSslKey_vectSize_keyInfo for the parameter keyType */
#define SHARKSSL_KEYTYPE_RSA     0x00 
#define SHARKSSL_KEYTYPE_EC      0x02
 
SHARKSSL_API U16 SharkSslKey_vectSize_keyInfo(const SharkSslKey key, U8 *keyType, U8 *isKeyPrivate, U8 **d1, U16 *d1Len, U8 **d2, U16 *d2Len);
#endif
 
#if SHARKSSL_ENABLE_ECCKEY_CREATE
 
typedef int (*sharkssl_rngfunc)(void *handle, U8 *ptr, U16 len);
 
 
#define SharkSslECCKey_create(privKey, curveID) SharkSslECCKey_createEx((privKey), (curveID), 0, 0)
 
 
SHARKSSL_API int SharkSslECCKey_createEx(SharkSslECCKey *privKey, U16 curveID, void *rngHandle, sharkssl_rngfunc rngFunc);
#endif
 
 
#if (SHARKSSL_ENABLE_PEM_API || SHARKSSL_ENABLE_ECCKEY_CREATE)
SHARKSSL_API void SharkSslECCKey_free(SharkSslECCKey key);
#define _SHARKSSLECCKEY_FREE 1
#endif
 
 
/*
 *-----------------------------------------------------------------------------
 * To free up the memory allocated by SharkSslECCKey_create and 
 * SharkSslRSAKey_create, the following macro is provided
 * For instance, this function could be called after saving the key to a file
 *-----------------------------------------------------------------------------
 * key: input parameter, points to a buffer allocated by either 
 *    SharkSslECCKey_create or SharkSslRSAKey_create
 */
#if defined(_SHARKSSLRSAKEY_FREE)
#define SharkSslKey_free SharkSslRSAKey_free
#elif defined (_SHARKSSLECCKEY_FREE)
#define SharkSslKey_free SharkSslECCKey_free
#else
#define SharkSslKey_free
#endif
#undef _SHARKSSLRSAKEY_FREE
#undef _SHARKSSLECCKEY_FREE
 
 
#if SHARKSSL_ENABLE_ECDSA 
/* ECDSA API and also internal sharkssl_ECDSA_signASN1 */
typedef enum
{
   SHARKSSL_ECDSA_OK = 0,
 
   SHARKSSL_ECDSA_ALLOCATION_ERROR = -3200,
 
   SHARKSSL_ECDSA_INTERNAL_ERROR = -3300,
 
   SHARKSSL_ECDSA_WRONG_PARAMETERS,
 
   SHARKSSL_ECDSA_WRONG_KEY_FORMAT,
 
   SHARKSSL_ECDSA_KEY_NOT_PRIVATE,
 
   SHARKSSL_ECDSA_KEY_NOT_PUBLIC,
 
   SHARKSSL_ECDSA_SIGLEN_TOO_SMALL,
 
   SHARKSSL_ECDSA_VERIFICATION_FAIL,
 
   SHARKSSL_ECDSA_WRONG_SIGNATURE
} sharkssl_ECDSA_RetVal;
 /* end group SharkSslInfoAndCodes */ 
 
#if SHARKSSL_ENABLE_ECDSA_API
#if (!SHARKSSL_ECDSA_ONLY_VERIFY)
SHARKSSL_API U16 sharkssl_ECDSA_siglen(SharkSslECCKey privkey);
 
SHARKSSL_API sharkssl_ECDSA_RetVal sharkssl_ECDSA_sign_hash(
   SharkSslECCKey privkey, U8 *sig, U16 *siglen, const U8 *hash, U8 hashID);
#endif
 
SHARKSSL_API sharkssl_ECDSA_RetVal sharkssl_ECDSA_verify_hash(
   SharkSslECCKey pubkey, U8 *sig, U16 siglen, const U8 *hash, U8 hashID);
 
#endif  /* SHARKSSL_ENABLE_ECDSA_API */
#endif  /* SHARKSSL_ENABLE_ECDSA */
 /* end group ECC */
#endif
 
 
#if (SHARKSSL_ENABLE_CA_LIST && SHARKSSL_ENABLE_CERTSTORE_API)
 
#ifndef BA_API  /* standalone SharkSSL */
#define BA_API SHARKSSL_API
typedef U8 BaBool;
#endif
#include "DoubleList.h"
 
typedef struct SharkSslCertStore
{
   DoubleList certList;
   SharkSslCAList caList;
   U16 elements;  /* number of elements in list */
} SharkSslCertStore;
 
SHARKSSL_API void  SharkSslCertStore_constructor(SharkSslCertStore *o);
 
SHARKSSL_API void  SharkSslCertStore_destructor(SharkSslCertStore *o);
 
#define            SharkSslCertStore_release(o) SharkSslCertStore_destructor(o)
 
SHARKSSL_API U16   SharkSslCertStore_add(
   SharkSslCertStore *o, const char *cert, U32 certlen);
 
SHARKSSL_API U8  SharkSslCertStore_assemble(
   SharkSslCertStore *o, SharkSslCAList *outList);
 /* end group SharkSslCertApi */ 
#endif  /* SHARKSSL_ENABLE_CA_LIST && SHARKSSL_ENABLE_CERTSTORE_API */
 
#if ((SHARKSSL_ENABLE_PEM_API) || (SHARKSSL_ENABLE_CERTSTORE_API))
SHARKSSL_API U32 sharkssl_B64Decode(
   U8 *outStr, U32 outStrSize, const char *b64beg, const char *b64end);
#endif
 
 
 
#ifdef __cplusplus
}
 
inline SharkSsl::SharkSsl(
   SharkSsl_Role role, U16 cacheSize, U16 inBufStartSize, U16 outBufSize) {
   SharkSsl_constructor(this, role, cacheSize, inBufStartSize, outBufSize);
}
inline SharkSsl::~SharkSsl() {
   SharkSsl_destructor(this);
}
inline SharkSslCon *SharkSsl::createCon(void) {
   return SharkSsl_createCon(this);
}
inline void SharkSsl::terminateCon(SharkSslCon *sslCon) {
   SharkSsl_terminateCon(this, sslCon);
}
 
#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
inline U8 SharkSsl::addCertificate(SharkSslCert cert) {
   return SharkSsl_addCertificate(this, cert);
}
#if SHARKSSL_ENABLE_CA_LIST
inline U8 SharkSsl::setCAList(SharkSslCAList list) {
   return SharkSsl_setCAListEx(this, list, 0);
}
inline U8 SharkSsl::setCAListEx(SharkSslCAList list, U32 caListLen) {
   return SharkSsl_setCAListEx(this, list, caListLen);
}
#endif  /* SHARKSSL_ENABLE_CA_LIST */
#endif  /* SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA */
 
#endif  /* __cplusplus */
 
 
#endif