SharkSSL™ Embedded SSL/TLS Stack
SharkSSL.h
1/*
2 * ____ _________ __ _
3 * / __ \___ ____ _/ /_ __(_)___ ___ ___ / / ____ ____ _(_)____
4 * / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ / / __ \/ __ `/ / ___/
5 * / _, _/ __/ /_/ / / / / / / / / / / / __/ /___/ /_/ / /_/ / / /__
6 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
7 * /____/
8 *
9 * SharkSSL Embedded SSL/TLS Stack
10 ****************************************************************************
11 * PROGRAM MODULE
12 *
13 * $Id: SharkSSL.h 5968 2026-09-11 08:28:22Z gianluca $
14 *
15 * COPYRIGHT: Real Time Logic LLC, 2010 - 2026
16 *
17 * This software is copyrighted by and is the sole property of Real
18 * Time Logic LLC. All rights, title, ownership, or other interests in
19 * the software remain the property of Real Time Logic LLC. This
20 * software may only be used in accordance with the terms and
21 * conditions stipulated in the corresponding license agreement under
22 * which the software has been supplied. Any unauthorized use,
23 * duplication, transmission, distribution, or disclosure of this
24 * software is expressly forbidden.
25 *
26 * This Copyright notice may not be removed or modified without prior
27 * written consent of Real Time Logic LLC.
28 *
29 * Real Time Logic LLC. reserves the right to modify this software
30 * without notice.
31 *
32 * http://www.realtimelogic.com
33 * http://www.sharkssl.com
34 ****************************************************************************
35 *
36 */
37#ifndef _SharkSsl_h
38#define _SharkSsl_h
39
40#include "TargConfig.h" /* platform dependencies */
41
42#if defined(SHARKDBG_ENABLE) && SHARKDBG_ENABLE
43#define SHARKDBG_PRINTF(x) printf x
44#else
45#define SHARKDBG_PRINTF(x)
46#endif
47
48#ifndef SHARKSSL_API
49#define SHARKSSL_API
50#else /* Barracuda */
51#define SHARKSSL_BA 1
52#include <ThreadLib.h>
53#include <BaServerLib.h>
54#endif
55
56#include "SharkSSL_cfg.h" /* SharkSSL configuration */
57#include <stddef.h> /* size_t */
58
59#include "SharkSslCrypto.h" /* Crypto API */
60
61#ifndef sharkCertSerialNumber2NetworkEndian
66typedef U64 SharkCertSerialNumber;
67#ifdef B_BIG_ENDIAN
68#define sharkCertSerialNumber2NetworkEndian(n)
69#else
70#define sharkCertSerialNumber2NetworkEndian(n) \
71 do { \
72 U64 nn=0; \
73 register U8 *t=(U8*)&nn; \
74 register U8 *f=(U8*)&n; \
75 t[7]=f[0]; \
76 t[6]=f[1]; \
77 t[5]=f[2]; \
78 t[4]=f[3]; \
79 t[3]=f[4]; \
80 t[2]=f[5]; \
81 t[1]=f[6]; \
82 t[0]=f[7]; \
83 n=nn; \
84 } while(0)
85#endif
86#endif
87
88/* Forward decl. */
89struct SharkSslCertDN;
92
114#define SHARKSSL_ALERT_LEVEL_WARNING 1
115
117#define SHARKSSL_ALERT_LEVEL_FATAL 2
118
131#define SHARKSSL_ALERT_CLOSE_NOTIFY 0
133#define SHARKSSL_ALERT_UNEXPECTED_MESSAGE 10
135#define SHARKSSL_ALERT_BAD_RECORD_MAC 20
137#define SHARKSSL_ALERT_DECRYPTION_FAILED 21
139#define SHARKSSL_ALERT_RECORD_OVERFLOW 22
141#define SHARKSSL_ALERT_DECOMPRESSION_FAILURE 30
143#define SHARKSSL_ALERT_HANDSHAKE_FAILURE 40
145#define SHARKSSL_ALERT_BAD_CERTIFICATE 42
147#define SHARKSSL_ALERT_UNSUPPORTED_CERTIFICATE 43
149#define SHARKSSL_ALERT_CERTIFICATE_REVOKED 44
151#define SHARKSSL_ALERT_CERTIFICATE_EXPIRED 45
153#define SHARKSSL_ALERT_CERTIFICATE_UNKNOWN 46
155#define SHARKSSL_ALERT_ILLEGAL_PARAMETER 47
157#define SHARKSSL_ALERT_UNKNOWN_CA 48
159#define SHARKSSL_ALERT_ACCESS_DENIED 49
161#define SHARKSSL_ALERT_DECODE_ERROR 50
163#define SHARKSSL_ALERT_DECRYPT_ERROR 51
165#define SHARKSSL_ALERT_EXPORT_RESTRICTION 60
167#define SHARKSSL_ALERT_PROTOCOL_VERSION 70
169#define SHARKSSL_ALERT_INSUFFICIENT_SECURITY 71
171#define SHARKSSL_ALERT_INTERNAL_ERROR 80
173#define SHARKSSL_ALERT_USER_CANCELED 90
175#define SHARKSSL_ALERT_NO_RENEGOTIATION 100
177#define SHARKSSL_ALERT_MISSING_EXTENSION 109
179#define SHARKSSL_ALERT_UNSUPPORTED_EXTENSION 110
181#define SHARKSSL_ALERT_UNRECOGNIZED_NAME 112
183#define SHARKSSL_ALERT_NO_APPLICATION_PROTOCOL 120 /* RFC 7301 */
184 /* end group SharkSslAlertMsg */ /* end group SharkSslAlert */
187
188
197#if SHARKSSL_TLS_1_3
199#define TLS_AES_128_GCM_SHA256 0x1301
201#define TLS_AES_256_GCM_SHA384 0x1302
203#define TLS_CHACHA20_POLY1305_SHA256 0x1303
204#endif
205#if SHARKSSL_TLS_1_2
207#define TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 0x009E
209#define TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 0x009F
211#define TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 0xC02B
213#define TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 0xC02C
215#define TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 0xC02F
217#define TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 0xC030
219#define TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA8
221#define TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 0xCCA9
223#define TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 0xCCAA
224#endif
225 /* end group SharkSslCiphers */
227
228
236#define SHARKSSL_PROTOCOL_UNKNOWN 0x00
238#define SHARKSSL_PROTOCOL_TLS_1_2 0x33
240#define SHARKSSL_PROTOCOL_TLS_1_3 0x34
241
242/* internal use, with SHARKSSL_PROTOCOL_TLS_1_x as parameter */
243#define SHARKSSL_PROTOCOL_MAJOR(p) (p >> 4)
244#define SHARKSSL_PROTOCOL_MINOR(p) (p & 0xF)
245 /* end group SharkSslProtocol */
247
248
249#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
250#ifndef BA_API /* standalone SharkSSL */
251#define BA_API SHARKSSL_API
252#ifdef _SHARKSSL_C_
253#define SingleListCode 1
254#endif
255#endif
256#include "SingleList.h"
257#endif
258
259
260#if SHARKSSL_ENABLE_SESSION_CACHE || SHARKSSL_NOPACK
261
270 /* end group SharkSslSessionApi */
272
273#ifndef _DOXYGEN
274typedef struct SharkSslSessionCache
275{
276 SharkSslSession *cache;
277 ThreadMutexBase cacheMutex;
278 U16 cacheSize;
279} SharkSslSessionCache;
280#endif
281#endif
282
283
295typedef enum
296{
301 /* end group SharkSslInfoAndCodes */
303
304
305#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
313typedef U8* SharkSslKey;
314
315
321typedef const U8 *SharkSslCert;
322
323#ifdef __cplusplus
324extern "C" {
325#endif
326
332SHARKSSL_API U16 SharkSslCert_len(SharkSslCert cert);
333
336#ifdef __DOXYGEN__
338#endif
339
340#if SHARKSSL_ENABLE_CSR_CREATION
403SHARKSSL_API int
405 SharkSslKey privKey,
406 U8 hashID,
407 struct SharkSslCertDN *certDN,
408 const char *SAN,
409 struct SharkSslBitExtReq *keyUsage,
410 struct SharkSslBitExtReq *nsCertType);
411#endif
412
413#if SHARKSSL_ENABLE_CSR_SIGNING
476SHARKSSL_API int
478 const U8 *csrData,
479 int csrDataLen,
480 const SharkSslCert caCert,
481 const SharkSslKey privKey,
482 const char *validFrom,
483 const char *validTo,
484 SharkCertSerialNumber serialNumber,
485 U8 hashID);
486#endif
487
488#if SHARKSSL_ENABLE_ASN1_KEY_CREATION
495SHARKSSL_API int
497#endif
498
499
500#ifdef __cplusplus
501}
502#endif
503
504
505#if SHARKSSL_ENABLE_CA_LIST
511typedef const U8 *SharkSslCAList;
512#endif
513 /* end group SharkSslInfoAndCodes */
515#endif
516
517#ifndef _DOXYGEN
518struct SharkSsl;
519#endif
520
521
522/* Non documented API used by SharkSslSCMgr when used indirectly by
523 Lua code in the Barracuda Application Server. The code manages
524 automatic destruction of SharkSslSCMgr.
525 */
526#ifndef _DOXYGEN
527struct SharkSslIntf;
528typedef void (*SharkSslIntf_Terminate)(struct SharkSslIntf *o,
529 struct SharkSsl *ssl);
530typedef struct SharkSslIntf
531{
532 SharkSslIntf_Terminate terminate;
533} SharkSslIntf;
534#define SharkSslIntf_constructor(o,terminateFunc) (o)->terminate=terminateFunc
535#endif
536
537
560
561
562#ifdef __cplusplus
563extern "C" {
564SHARKSSL_API void *sharkssl_mallocObject(size_t size);
565SHARKSSL_API void sharkssl_freeObject(void *object);
566}
567#endif
568
569
573typedef struct
575{
576#ifdef __cplusplus
577 void *operator new(size_t s) { return sharkssl_mallocObject(s); }
578 void operator delete(void *d) { sharkssl_freeObject(d); }
579 void *operator new(size_t, void *place) { return place; }
580 void operator delete(void*, void *) { }
581
582 SharkSsl() {};
583
585 U16 cacheSize = 0,
586 U16 inBufStartSize = 4096,
587 U16 outBufSize = 4096
588 );
589
590 ~SharkSsl();
591 SharkSslCon *createCon(void);
592 U8 setCAList(SharkSslCAList caList);
593 U8 addCertificate(SharkSslCert cert);
594 void terminateCon(SharkSslCon *sslCon);
595#endif
596 #if (SHARKSSL_SSL_SERVER_CODE && SHARKSSL_SSL_CLIENT_CODE) || SHARKSSL_NOPACK
597 SharkSsl_Role role;
598 #endif
599 U16 outBufSize;
600 U16 inBufStartSize;
601 U16 nCon;
602 #if (SHARKSSL_ENABLE_RSA || (SHARKSSL_ENABLE_ECDSA)) || SHARKSSL_NOPACK
603 SingleList certList;
604 #if SHARKSSL_ENABLE_CA_LIST || SHARKSSL_NOPACK
605 SharkSslCAList caList;
606 #endif
607 #endif
608 #if SHARKSSL_ENABLE_SESSION_CACHE || SHARKSSL_NOPACK
609 SharkSslSessionCache sessionCache;
610 /* Reserved for use with one SharkSslSCMgr object */
611 SharkSslIntf *intf;
612 #endif
614 /* end group SharkSslInfoAndCodes */
616
623typedef enum
624{
628
632
643
656
669
683
692
704
710
714
716 /* end group SharkSslCoreApi */
718
719#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
720
732#if SHARKSSL_ENABLE_CERT_KEYUSAGE
733#define SHARKSSL_CERT_KEYUSAGE_DIGITALSIGNATURE 0x00000001
734#define SHARKSSL_CERT_KEYUSAGE_NONREPUDIATION 0x00000002
735#define SHARKSSL_CERT_KEYUSAGE_KEYENCIPHERMENT 0x00000004
736#define SHARKSSL_CERT_KEYUSAGE_DATAENCIPHERMENT 0x00000008
737#define SHARKSSL_CERT_KEYUSAGE_KEYAGREEMENT 0x00000010
738#define SHARKSSL_CERT_KEYUSAGE_KEYCERTSIGN 0x00000020
739#define SHARKSSL_CERT_KEYUSAGE_CRLSIGN 0x00000040
740#define SHARKSSL_CERT_KEYUSAGE_ENCIPHERONLY 0x00000080
741#define SHARKSSL_CERT_KEYUSAGE_DECIPHERONLY 0x00000100
742#define SHARKSSL_CERT_KEYUSAGE_PRESENT 0x00000200
743#define SHARKSSL_CERT_KEYUSAGE_CRITICAL 0x00000400
744
745#define SHARKSSL_CERT_KEYPURPOSE_SERVERAUTH 0x00010000
746#define SHARKSSL_CERT_KEYPURPOSE_CLIENTAUTH 0x00020000
747#define SHARKSSL_CERT_KEYPURPOSE_CODESIGNING 0x00040000
748#define SHARKSSL_CERT_KEYPURPOSE_EMAILPROTECTION 0x00080000
749#define SHARKSSL_CERT_KEYPURPOSE_TIMESTAMPING 0x00100000
750#define SHARKSSL_CERT_KEYPURPOSE_OCSPSIGNING 0x00200000
751
752#define SharkSslCertInfo_KeyFlagSet(o,f) ((o)->keyUsagePurposes & f)
753
757#define SharkSslCertInfo_isKeyUsagePresent(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_PRESENT)
758#define SharkSslCertInfo_isKeyUsageCritical(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_CRITICAL)
759#define SharkSslCertInfo_KU_digitalSignature(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_DIGITALSIGNATURE)
760#define SharkSslCertInfo_KU_nonRepudiation(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_NONREPUDIATION)
761#define SharkSslCertInfo_KU_keyEncipherment(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_KEYENCIPHERMENT)
762#define SharkSslCertInfo_KU_dataEncipherment(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_DATAENCIPHERMENT)
763#define SharkSslCertInfo_KU_keyAgreement(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_KEYAGREEMENT)
764#define SharkSslCertInfo_KU_keyCertSign(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_KEYCERTSIGN)
765#define SharkSslCertInfo_KU_cRLSign(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_CRLSIGN)
766#define SharkSslCertInfo_KU_encipherOnly(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_ENCIPHERONLY)
767#define SharkSslCertInfo_KU_decipherOnly(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYUSAGE_DECIPHERONLY)
768
769#define SharkSslCertInfo_kp_serverAuth(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_SERVERAUTH)
770#define SharkSslCertInfo_kp_clientAuth(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_CLIENTAUTH)
771#define SharkSslCertInfo_kp_codeSigning(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_CODESIGNING)
772#define SharkSslCertInfo_kp_emailProtection(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_EMAILPROTECTION)
773#define SharkSslCertInfo_kp_timeStamping(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_TIMESTAMPING)
774#define SharkSslCertInfo_kp_OCSPSigning(o) SharkSslCertInfo_KeyFlagSet(o, SHARKSSL_CERT_KEYPURPOSE_OCSPSIGNING)
775#endif
776
777
789typedef struct SharkSslCertDN
790{
791 const U8 *countryName;
792 const U8 *province;
793 const U8 *locality;
794 const U8 *organization;
795 const U8 *unit;
799 const U8 *commonName;
800 const U8 *emailAddress;
801
802 U8 countryNameLen;
810
813#define SharkSslCertDN_constructor(o) memset(o,0,sizeof(SharkSslCertDN))
816#define SharkSslCertDN_setCountryName(o, countryNameMA) \
817 (o)->countryName=(const U8*)countryNameMA,(o)->countryNameLen=(U8)strlen(countryNameMA)
820#define SharkSslCertDN_setProvince(o, provinceMA) \
821 (o)->province=(const U8*)provinceMA,(o)->provinceLen=(U8)strlen(provinceMA)
824#define SharkSslCertDN_setLocality(o, localityMA) \
825 (o)->locality=(const U8*)localityMA,(o)->localityLen=(U8)strlen(localityMA)
828#define SharkSslCertDN_setOrganization(o, organizationMA) \
829 (o)->organization=(const U8*)organizationMA,(o)->organizationLen=(U8)strlen(organizationMA)
832#define SharkSslCertDN_setUnit(o, unitMA) \
833 (o)->unit=(const U8*)unitMA,(o)->unitLen=(U8)strlen(unitMA)
836#define SharkSslCertDN_setCommonName(o, commonNameMA) \
837 (o)->commonName=(const U8*)commonNameMA,(o)->commonNameLen=(U8)strlen(commonNameMA)
840#define SharkSslCertDN_setEmailAddress(o, emailAddressMA) \
841 (o)->emailAddress=(const U8*)emailAddressMA,(o)->emailAddressLen=(U8)strlen(emailAddressMA)
842
843
847typedef struct SharkSslCertInfo
848{
850 U16 snLen;
851
856
861
864 U8 *sn;
865
869 U8 *timeFrom; /* declaration of U8 timeFromLen below */
870
875 U8 *timeTo; /* declaration of U8 timeToLen below */
876
882
888
901 U16 subjectAltNamesLen;
902
905
908
909 #if SHARKSSL_ENABLE_CERT_KEYUSAGE
932 U32 keyUsagePurposes;
933 #endif
934
940 /* end group SharkSslCertInfo */
942#endif
943
949#ifdef __cplusplus
950extern "C" {
951#endif
952
980SHARKSSL_API void SharkSsl_constructor(
981 SharkSsl *o,
982 SharkSsl_Role role,
983 U16 cacheSize,
984 U16 inBufStartSize,
985 U16 outBufSize
986 );
987
995SHARKSSL_API void SharkSsl_destructor(SharkSsl *o);
996
997
1018
1019
1035
1036
1037#if SHARKSSL_ENABLE_SESSION_CACHE
1038
1043SHARKSSL_API U16 SharkSsl_getCacheSize(SharkSsl *o);
1044
1045#define SharkSsl_setIntf(o, sharkSslIntf) (o)->intf=sharkSslIntf
1046#define SharkSsl_getIntf(o) (o)->intf
1047
1048#endif
1049
1050
1057#define SharkSslCon_terminate(o) SharkSsl_terminateCon(0, o)
1058
1081
1082
1108
1109
1119
1120
1138
1139
1150
1162
1163
1178
1209U16 SharkSslCon_copyDecData(SharkSslCon *o, U8 *buf, U16 maxLen);
1210
1211
1221SHARKSSL_API U16 SharkSslCon_getDecData(SharkSslCon *o, U8 **bufPtr);
1222
1223
1236
1237
1251
1252
1268
1269
1280
1281
1294
1295
1303
1304
1308
1309
1320
1321
1332
1333
1343#define SharkSslCon_getAlertData(o) SharkSslCon_getEncData(o)
1344
1345
1355#define SharkSslCon_getAlertDataLen(o) SharkSslCon_getEncDataLen(o)
1356 /* end group SharkSslCoreApi */
1358
1359
1360#if SHARKSSL_ENABLE_INFO_API
1361
1365
1368#if (SHARKSSL_TLS_1_3 && SHARKSSL_TLS_1_2)
1370#elif SHARKSSL_TLS_1_3
1371#define SharkSslCon_getProtocol(o) (SHARKSSL_PROTOCOL_TLS_1_3)
1372#elif SHARKSSL_TLS_1_2
1373#define SharkSslCon_getProtocol(o) (SHARKSSL_PROTOCOL_TLS_1_2)
1374#else
1375#error please enable at least one of SHARKSSL_TLS_1_3, SHARKSSL_TLS_1_2
1376#endif
1377
1378#endif
1379
1380
1381#if SHARKSSL_ENABLE_SNI
1382
1383#if SHARKSSL_SSL_CLIENT_CODE
1386SHARKSSL_API U8 SharkSslCon_setSNI(SharkSslCon *o, const char *name, U16 length);
1387#endif
1388
1389#endif
1390
1391
1392#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
1393#if (SHARKSSL_SSL_CLIENT_CODE && SHARKSSL_ENABLE_CLIENT_AUTH)
1398#endif
1399
1404
1416
1417#if SHARKSSL_ENABLE_CA_LIST
1418
1439SHARKSSL_API U8 SharkSsl_setCAList(SharkSsl *o, SharkSslCAList caList);
1440
1455
1456U8 SharkSslCon_isCAListEmpty(SharkSslCon *o);
1457#else
1458
1459#define SharkSslCon_trustedCA(o) 0
1460#endif /* SHARKSSL_ENABLE_CA_LIST */
1461
1462#if (SHARKSSL_SSL_SERVER_CODE && SHARKSSL_ENABLE_RSA)
1466/* to be used as 'flag' param */
1467#define SHARKSSL_SET_FAVOR_RSA 1
1468#define SHARKSSL_CLEAR_FAVOR_RSA 0
1469
1488#endif /* SHARKSSL_SSL_SERVER_CODE */
1489#endif /* SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA */
1490
1491U8 SharkSslCon_selectProtocol(SharkSslCon *o, U8 protocol);
1492
1497#if SHARKSSL_ENABLE_SESSION_CACHE
1498
1499#if SHARKSSL_ENABLE_INFO_API
1503#endif
1504
1508
1509#if SHARKSSL_SSL_SERVER_CODE
1513#endif
1514
1515#if SHARKSSL_SSL_CLIENT_CODE
1516
1525
1526
1534
1540#endif
1541#endif
1542 /* end group SharkSslSessionApi */
1544
1545#if (SHARKSSL_SSL_SERVER_CODE && SHARKSSL_ENABLE_CLIENT_AUTH && \
1546 (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA))
1579 SharkSslCon *o, const void *caList);
1580#endif
1581
1582#if (SHARKSSL_TLS_1_3 && SHARKSSL_SSL_CLIENT_CODE && SHARKSSL_ENABLE_CA_EXTENSION && \
1583 (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA))
1611 SharkSslCon *o, const void *caList);
1612#endif
1613
1614#if SHARKSSL_ENABLE_ALPN_EXTENSION
1615#if SHARKSSL_SSL_CLIENT_CODE
1635SHARKSSL_API U8 SharkSslCon_setALPNProtocols(SharkSslCon *o, const char *protList);
1636
1650SHARKSSL_API const char *SharkSslCon_getALPNProtocol(SharkSslCon *o);
1651#endif
1652#if SHARKSSL_SSL_SERVER_CODE
1653typedef int(*ALPNFunction)(SharkSslCon*, const char*, void*);
1654SHARKSSL_API U8 SharkSslCon_setALPNFunction(
1655 SharkSslCon *o, ALPNFunction func, void *pvoid);
1656#endif
1657#endif /* SHARKSSL_ENABLE_ALPN_EXTENSION */
1658
1659#if ((SHARKSSL_SSL_SERVER_CODE || SHARKSSL_SSL_CLIENT_CODE) && \
1660 SHARKSSL_ENABLE_SELECT_CIPHERSUITE)
1690SHARKSSL_API U8 SharkSslCon_selectCiphersuite(SharkSslCon *o, U16 cipherSuite);
1691
1695#endif
1696
1697#if (SHARKSSL_SSL_SERVER_CODE && SHARKSSL_ENABLE_SECURE_RENEGOTIATION)
1718#endif
1719 /* end group SharkSslApi */
1721
1722
1723#if SHARKSSL_ENABLE_PEM_API
1731typedef enum
1732{
1735
1738
1741
1744
1747
1750
1753
1756
1759
1762
1765
1768
1771
1774
1777
1780
1783
1786
1790
1791
1821 const char *certPEM, const char *keyPEM,
1822 const char *passphrase, SharkSslCert *sharkSslCert);
1823
1824#if SHARKSSL_ENABLE_ENCRYPTED_PKCS8_SUPPORT
1842SHARKSSL_API int sharkssl_PEM_PBKDF2(
1843 U8 *dk, const char *passphrase,
1844 const char *salt, U32 saltLen,
1845 U32 iterations, U16 dkLen, U8 hashID);
1846#endif
1847 /* end group RayCryptoApi */
1849#endif
1850
1851#if SHARKSSL_ENABLE_RSA
1852
1859#define SHARKSSL_RSA_NO_PADDING 0
1860
1861
1865#define SHARKSSL_RSA_PKCS1_PADDING 1
1866
1867
1873typedef enum
1874{
1877
1880
1883
1886
1889
1892
1895
1898
1901
1904
1907
1910
1914#endif
1915 /* end group SharkSslInfoAndCodes */
1917
1918#if SHARKSSL_ENABLE_RSA_API
1919
1930typedef U8* SharkSslRSAKey;
1931
1932#if SHARKSSL_ENABLE_PEM_API
1957 const char *PEMKey, const char *passphrase);
1958
1982SHARKSSL_API SharkSslKey
1984
1985SHARKSSL_API SharkSslKey
1986sharkssl_PEM_extractPublicKey_ext(const char *certPEM, U8 *keyType);
1987#endif /* SHARKSSL_ENABLE_PEM_API */
1988
1989#if (SHARKSSL_ENABLE_PEM_API || (SHARKSSL_ENABLE_RSA && SHARKSSL_ENABLE_RSAKEY_CREATE))
1994#define _SHARKSSLRSAKEY_FREE 1
1995#endif
1996
1997#if SHARKSSL_ENABLE_RSA
1998#if SHARKSSL_ENABLE_RSAKEY_CREATE
2020SHARKSSL_API int SharkSslRSAKey_create(SharkSslRSAKey *privKey, U16 keyLength);
2021
2036#endif
2037
2043
2067 SharkSslRSAKey pubkey, const U8 *in, int len, U8 *out, int padding);
2068
2069
2088 SharkSslRSAKey privkey, const U8 *in, int len, U8 *out, int padding);
2089
2090
2109 SharkSslRSAKey privkey, U8 *sig, U16 *siglen, const U8 *hash, U8 hashID);
2110
2111
2130 SharkSslRSAKey pubkey, U8 *sig, U16 siglen, const U8 *hash, U8 hashID);
2131
2132
2133#if SHARKSSL_ENABLE_RSA_OAEP
2158SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_private_decrypt_OAEP(
2159 SharkSslRSAKey privkey, U8 *in, int len, U8 hashID, U8 *out, const char *label, U16 labelLen);
2160
2161
2187SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_public_encrypt_OAEP(
2188 SharkSslRSAKey pubkey, const U8 *in, int len, U8 hashID, U8 *out, const char *label, U16 labelLen);
2189#endif
2190
2191
2213 SharkSslRSAKey privkey, const U8 *in, int len, U8 *out, int padding);
2214
2215
2237 SharkSslRSAKey pubkey, const U8 *in, int len, U8 *out, int padding);
2238
2239#endif
2240 /* end group RSA */
2242#endif
2243
2244
2257#if SHARKSSL_USE_ECC
2258/*
2259 * NamedCurve, use as curveID parameter
2260 * SECPxxxR1 - RFC 4492 section 5.1.1
2261 * BRAINPOOLPxxxR1 - RFC 7027 section 2
2262 * CURVE25519,448 - RFC 8446 section 4.2.7
2263 */
2264#define SHARKSSL_EC_CURVE_ID_SECP256R1 23
2265#define SHARKSSL_EC_CURVE_ID_SECP384R1 24
2266#define SHARKSSL_EC_CURVE_ID_SECP521R1 25
2267#define SHARKSSL_EC_CURVE_ID_BRAINPOOLP256R1 26
2268#define SHARKSSL_EC_CURVE_ID_BRAINPOOLP384R1 27
2269#define SHARKSSL_EC_CURVE_ID_BRAINPOOLP512R1 28
2270#define SHARKSSL_EC_CURVE_ID_CURVE25519 29
2271#define SHARKSSL_EC_CURVE_ID_CURVE448 30
2272
2273#define SHARKSSL_X25519_KEY_LEN 32
2274
2275
2276#if (SHARKSSL_ECC_USE_CURVE25519 && SHARKSSL_ENABLE_X25519_API)
2294 U8 privateKey[SHARKSSL_X25519_KEY_LEN],
2295 U8 publicKey[SHARKSSL_X25519_KEY_LEN]);
2296
2297
2311 const U8 privateKey[SHARKSSL_X25519_KEY_LEN],
2312 const U8 peerPublicKey[SHARKSSL_X25519_KEY_LEN],
2313 U8 sharedSecret[SHARKSSL_X25519_KEY_LEN]);
2314#endif
2315
2316
2323typedef U8* SharkSslECCKey;
2324
2325#if SHARKSSL_ENABLE_PEM_API
2352 const char *PEMKey, const char *passphrase);
2353
2354
2355#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
2364SHARKSSL_API U16 SharkSslKey_vectSize(const SharkSslKey key);
2365#define SharkSslCert_vectSize(c) SharkSslKey_vectSize((const SharkSslCert)c)
2366#define SharkSslCert_vectSize_keyInfo(c, t, p, a, b, x, y) SharkSslKey_vectSize_keyInfo((const SharkSslKey)c, t, p, a, b, x, y)
2367#if SHARKSSL_ENABLE_RSA
2368#define SharkSslRSAKey_vectSize(k) SharkSslKey_vectSize(k)
2369#define SharkSslRSAKey_vectSize_keyInfo(k, t, p, a, b, x, y) SharkSslKey_vectSize_keyInfo((const SharkSslKey)k, t, p, a, b, x, y)
2370#endif
2371#if SHARKSSL_ENABLE_ECDSA
2372#define SharkSslECCKey_vectSize(k) SharkSslKey_vectSize(k)
2373#define SharkSslECCKey_vectSize_keyInfo(k, t, p, a, b, x, y) SharkSslKey_vectSize_keyInfo((const SharkSslKey)k, t, p, a, b, x, y)
2374#endif
2375
2376/* return values of function SharkSslKey_vectSize_keyInfo for the parameter keyType */
2377#define SHARKSSL_KEYTYPE_RSA 0x00
2378#define SHARKSSL_KEYTYPE_EC 0x02
2379
2396SHARKSSL_API U16 SharkSslKey_vectSize_keyInfo(const SharkSslKey key, U8 *keyType, U8 *isKeyPrivate, U8 **d1, U16 *d1Len, U8 **d2, U16 *d2Len);
2397#endif
2398#endif
2399
2400#if SHARKSSL_ENABLE_ECCKEY_CREATE
2401
2402typedef int (*sharkssl_rngfunc)(void *handle, U8 *ptr, U16 len);
2403
2404
2423#define SharkSslECCKey_create(privKey, curveID) SharkSslECCKey_createEx((privKey), (curveID), 0, 0)
2424
2425
2475SHARKSSL_API int SharkSslECCKey_createEx(SharkSslECCKey *privKey, U16 curveID, void *rngHandle, sharkssl_rngfunc rngFunc);
2476#endif
2477
2478
2479#if (SHARKSSL_ENABLE_PEM_API || SHARKSSL_ENABLE_ECCKEY_CREATE)
2486#define _SHARKSSLECCKEY_FREE 1
2487#endif
2488
2489
2490/*
2491 *-----------------------------------------------------------------------------
2492 * To free up the memory allocated by SharkSslECCKey_create and
2493 * SharkSslRSAKey_create, the following macro is provided
2494 * For instance, this function could be called after saving the key to a file
2495 *-----------------------------------------------------------------------------
2496 * key: input parameter, points to a buffer allocated by either
2497 * SharkSslECCKey_create or SharkSslRSAKey_create
2498 */
2499#if defined(_SHARKSSLRSAKEY_FREE)
2500#define SharkSslKey_free SharkSslRSAKey_free
2501#elif defined (_SHARKSSLECCKEY_FREE)
2502#define SharkSslKey_free SharkSslECCKey_free
2503#else
2504#define SharkSslKey_free
2505#endif
2506#undef _SHARKSSLRSAKEY_FREE
2507#undef _SHARKSSLECCKEY_FREE
2508
2509
2515#if SHARKSSL_ENABLE_ECDSA
2519/* ECDSA API and also internal sharkssl_ECDSA_signASN1 */
2520typedef enum
2521{
2524
2527
2530
2533
2536
2539
2542
2545
2548
2552 /* end group SharkSslInfoAndCodes */
2554
2560#if SHARKSSL_ENABLE_ECDSA_API
2561#if (!SHARKSSL_ECDSA_ONLY_VERIFY)
2570SHARKSSL_API U16 sharkssl_ECDSA_siglen(SharkSslECCKey privkey);
2571
2599 SharkSslECCKey privkey, U8 *sig, U16 *siglen, const U8 *hash, U8 hashID);
2600#endif
2601
2624 SharkSslECCKey pubkey, U8 *sig, U16 siglen, const U8 *hash, U8 hashID);
2625
2626#endif /* SHARKSSL_ENABLE_ECDSA_API */
2627#endif /* SHARKSSL_ENABLE_ECDSA */
2628 /* end group ECC */
2630#endif
2631
2632
2633#if (SHARKSSL_ENABLE_CA_LIST && SHARKSSL_ENABLE_CERTSTORE_API)
2634
2640#ifndef BA_API /* standalone SharkSSL */
2641#define BA_API SHARKSSL_API
2642typedef U8 BaBool;
2643#endif
2644#include "DoubleList.h"
2645
2665typedef struct SharkSslCertStore
2666{
2667 DoubleList certList;
2668 SharkSslCAList caList;
2669 U16 elements; /* number of elements in list */
2671
2681
2685
2687#define SharkSslCertStore_release(o) SharkSslCertStore_destructor(o)
2688
2701SHARKSSL_API U16 SharkSslCertStore_add(
2702 SharkSslCertStore *o, const char *cert, U32 certlen);
2703
2715 SharkSslCertStore *o, SharkSslCAList *outList);
2716 /* end group SharkSslCertApi */
2718#endif /* SHARKSSL_ENABLE_CA_LIST && SHARKSSL_ENABLE_CERTSTORE_API */
2719
2720#if ((SHARKSSL_ENABLE_PEM_API) || (SHARKSSL_ENABLE_CERTSTORE_API))
2721SHARKSSL_API U32 sharkssl_B64Decode(
2722 U8 *outStr, U32 outStrSize, const char *b64beg, const char *b64end);
2723#endif
2724
2725
2726
2727#ifdef __cplusplus
2728}
2729
2730inline SharkSsl::SharkSsl(
2731 SharkSsl_Role role, U16 cacheSize, U16 inBufStartSize, U16 outBufSize) {
2732 SharkSsl_constructor(this, role, cacheSize, inBufStartSize, outBufSize);
2733}
2734inline SharkSsl::~SharkSsl() {
2735 SharkSsl_destructor(this);
2736}
2737inline SharkSslCon *SharkSsl::createCon(void) {
2738 return SharkSsl_createCon(this);
2739}
2740inline void SharkSsl::terminateCon(SharkSslCon *sslCon) {
2741 SharkSsl_terminateCon(this, sslCon);
2742}
2743
2744#if (SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA)
2745inline U8 SharkSsl::addCertificate(SharkSslCert cert) {
2746 return SharkSsl_addCertificate(this, cert);
2747}
2748#if SHARKSSL_ENABLE_CA_LIST
2749inline U8 SharkSsl::setCAList(SharkSslCAList caList) {
2750 return SharkSsl_setCAList(this, caList);
2751}
2752#endif /* SHARKSSL_ENABLE_CA_LIST */
2753#endif /* SHARKSSL_ENABLE_RSA || SHARKSSL_ENABLE_ECDSA */
2754
2755#endif /* __cplusplus */
2756
2757
2758#endif
SHARKSSL_API SharkSslECCKey sharkssl_PEM_to_ECCKey(const char *PEMKey, const char *passphrase)
Convert an ECC private or public key in PEM format to the SharkSslECCKey format.
SHARKSSL_API sharkssl_ECDSA_RetVal sharkssl_ECDSA_verify_hash(SharkSslECCKey pubkey, U8 *sig, U16 siglen, const U8 *hash, U8 hashID)
Verify a message using the ECC public key and a hash algorithm.
SHARKSSL_API U16 sharkssl_ECDSA_siglen(SharkSslECCKey privkey)
Returns the maximum length (in bytes) of a DER-encoded ECDSA signature generated with the private key...
SHARKSSL_API sharkssl_ECDSA_RetVal sharkssl_ECDSA_sign_hash(SharkSslECCKey privkey, U8 *sig, U16 *siglen, const U8 *hash, U8 hashID)
Generate the signature using the ECC private key and a hash.
U8 * SharkSslECCKey
SharkSslECCKey is an alias for the SharkSslCert type and is a private/public key converted by sharkss...
Definition: SharkSSL.h:2323
SHARKSSL_API SharkSslRSAKey sharkssl_PEM_to_RSAKey(const char *PEMKey, const char *passphrase)
Convert an RSA private or public key in PEM format to the SharkSslRSAKey format.
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_PKCS1V1_5_verify_hash(SharkSslRSAKey pubkey, U8 *sig, U16 siglen, const U8 *hash, U8 hashID)
Verify a signature hash using a public RSA key.
SHARKSSL_API SharkSslKey sharkssl_PEM_extractPublicKey(const char *certPEM)
Extract the public key form a certificate in PEM format.
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_private_encrypt(SharkSslRSAKey privkey, const U8 *in, int len, U8 *out, int padding)
Sign a message digest using the private key.
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_private_decrypt(SharkSslRSAKey privkey, const U8 *in, int len, U8 *out, int padding)
Decrypt ciphertext using the private key.
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_public_encrypt(SharkSslRSAKey pubkey, const U8 *in, int len, U8 *out, int padding)
Encrypt data using the public key or private key.
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_PKCS1V1_5_sign_hash(SharkSslRSAKey privkey, U8 *sig, U16 *siglen, const U8 *hash, U8 hashID)
Sign a hash using a private RSA key.
SHARKSSL_API void SharkSslRSAKey_free(SharkSslRSAKey key)
Release a SharkSslRSAKey allocated by functions sharkssl_PEM_to_RSAKey and sharkssl_PEM_extractPublic...
SHARKSSL_API sharkssl_RSA_RetVal sharkssl_RSA_public_decrypt(SharkSslRSAKey pubkey, const U8 *in, int len, U8 *out, int padding)
Bring back a message digest using the public key or private key.
U8 * SharkSslRSAKey
SharkSslRSAKey is an alias for the SharkSslCert type and is a private/public key converted by sharkss...
Definition: SharkSSL.h:1930
sharkssl_PEM_RetVal
Return values from function sharkssl_PEM.
Definition: SharkSSL.h:1732
SHARKSSL_API sharkssl_PEM_RetVal sharkssl_PEM(const char *certPEM, const char *keyPEM, const char *passphrase, SharkSslCert *sharkSslCert)
Create a SharkSslCert certificate by using a certificate and key in PEM format.
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])
Calculate an X25519 shared secret.
SHARKSSL_API int sharkssl_PEM_PBKDF2(U8 *dk, const char *passphrase, const char *salt, U32 saltLen, U32 iterations, U16 dkLen, U8 hashID)
sharkssl_PEM_PBKDF2 (output, passphrase, salt, salt_len, iterations, dkLen, hashID) Derives a key fro...
SHARKSSL_API int sharkssl_X25519_createKeyPair(U8 privateKey[SHARKSSL_X25519_KEY_LEN], U8 publicKey[SHARKSSL_X25519_KEY_LEN])
Create an X25519 private/public key pair.
@ SHARKSSL_PEM_CERT_UNSUPPORTED_TYPE
CERT_UNSUPPORTED_TYPE.
Definition: SharkSSL.h:1776
@ SHARKSSL_PEM_KEY_UNSUPPORTED_ENCRYPTION_TYPE
KEY_UNSUPPORTED_ENCRYPTION_TYPE.
Definition: SharkSSL.h:1767
@ SHARKSSL_PEM_OK
OK.
Definition: SharkSSL.h:1734
@ SHARKSSL_PEM_OK_PUBLIC
OK_PUBLIC.
Definition: SharkSSL.h:1737
@ SHARKSSL_PEM_KEY_PRIVATE_KEY_REQUIRED
A PRIVATE KEY IS REQUIRED.
Definition: SharkSSL.h:1785
@ SHARKSSL_PEM_KEY_UNSUPPORTED_EXPONENT_LENGTH
KEY_UNSUPPORTED_EXPONENT_LENGTH.
Definition: SharkSSL.h:1764
@ SHARKSSL_PEM_KEY_UNSUPPORTED_FORMAT
KEY_UNSUPPORTED_FORMAT.
Definition: SharkSSL.h:1758
@ SHARKSSL_PEM_KEY_UNRECOGNIZED_FORMAT
KEY_UNRECOGNIZED_FORMAT.
Definition: SharkSSL.h:1755
@ SHARKSSL_PEM_KEY_UNSUPPORTED_VERSION
KEY_UNSUPPORTED_VERSION.
Definition: SharkSSL.h:1779
@ SHARKSSL_PEM_KEY_PASSPHRASE_REQUIRED
KEY_PASSPHRASE_REQUIRED.
Definition: SharkSSL.h:1752
@ SHARKSSL_PEM_KEY_WRONG_LENGTH
KEY_WRONG_LENGTH.
Definition: SharkSSL.h:1749
@ SHARKSSL_PEM_KEY_PARSE_ERROR
KEY_PARSE_ERROR.
Definition: SharkSSL.h:1743
@ SHARKSSL_PEM_CERT_UNRECOGNIZED_FORMAT
CERT_UNRECOGNIZED_FORMAT.
Definition: SharkSSL.h:1773
@ SHARKSSL_PEM_KEY_REQUIRED
KEY_REQUIRED.
Definition: SharkSSL.h:1782
@ SHARKSSL_PEM_ALLOCATION_ERROR
ALLOCATION_ERROR.
Definition: SharkSSL.h:1740
@ SHARKSSL_PEM_KEY_WRONG_IV
KEY_WRONG_IV.
Definition: SharkSSL.h:1746
@ SHARKSSL_PEM_INTERNAL_ERROR
INTERNAL ERROR.
Definition: SharkSSL.h:1788
@ SHARKSSL_PEM_KEY_CERT_MISMATCH
KEY_CERT_MISMATCH.
Definition: SharkSSL.h:1770
@ SHARKSSL_PEM_KEY_UNSUPPORTED_MODULUS_LENGTH
KEY_UNSUPPORTED_MODULUS_LENGTH.
Definition: SharkSSL.h:1761
U8 SharkSslCon_favorRSA(SharkSslCon *o, U8 flag)
A SharkSSL server can have multiple certificates, such as RSA certificates with various strengths,...
SHARKSSL_API U16 SharkSsl_getCacheSize(SharkSsl *o)
Returns the SharkSsl session cache size.
SharkSslCon * SharkSsl_createCon(SharkSsl *o)
Create a SharkSslCon object.
SHARKSSL_API U8 SharkSslCon_setSNI(SharkSslCon *o, const char *name, U16 length)
set Server Name Indication for TLS client connections
SHARKSSL_API U8 SharkSslCon_trustedCA(SharkSslCon *o)
Returns TRUE if the certificate is valid and is signed with a root certificate trusted by SharkSSL.
SHARKSSL_API U8 SharkSslCon_requestClientCert(SharkSslCon *o, const void *caList)
This function is used by server solutions that require client SSL certificate authentication.
SHARKSSL_API void SharkSsl_destructor(SharkSsl *o)
Close the SharkSsl object.
SHARKSSL_API U8 SharkSslCon_setCertificateAuthorities(SharkSslCon *o, const void *caList)
This function is used by client solutions that require server SSL certificate authentication.
SHARKSSL_API U8 SharkSslCon_clearCiphersuiteSelection(SharkSslCon *o)
Clears the selection, thus enabling all ciphers.
SHARKSSL_API U8 SharkSslCon_getProtocol(SharkSslCon *o)
Returns the active session's protocol version.
SHARKSSL_API U8 SharkSslCon_setALPNProtocols(SharkSslCon *o, const char *protList)
This function is used by client solutions to specify a list of application layer protocols according ...
U8 SharkSslCon_certificateRequested(SharkSslCon *o)
Returns TRUE if the server requested a certificate from the client to verify that the client's identi...
SHARKSSL_API U8 SharkSsl_addCertificate(SharkSsl *o, SharkSslCert cert)
Add a certificate to the SharkSsl object.
SHARKSSL_API U8 SharkSslCon_selectCiphersuite(SharkSslCon *o, U16 cipherSuite)
This function enables you to limit the number of ciphers at runtime.
SHARKSSL_API U8 SharkSsl_setCAList(SharkSsl *o, SharkSslCAList caList)
Set a Certificate Authority (CA) list so the SharkSSL object can permform certificate validation on t...
void SharkSsl_terminateCon(const SharkSsl *o, SharkSslCon *con)
Terminate a SharkSslCon object created by function SharkSsl_createCon.
SHARKSSL_API SharkSslCertInfo * SharkSslCon_getCertInfo(SharkSslCon *o)
Returns the peer's certificate if the handshaking has completed.
SHARKSSL_API U8 SharkSslCon_renegotiate(SharkSslCon *o)
This function enables you to renegotiate an already established SSL/TLS connection.
SHARKSSL_API U16 SharkSslCon_getCiphersuite(SharkSslCon *o)
Returns the active session's chiper suite.
SHARKSSL_API const char * SharkSslCon_getALPNProtocol(SharkSslCon *o)
This function is used by client solutions to return the application layer protocol selected by the se...
SHARKSSL_API void SharkSsl_constructor(SharkSsl *o, SharkSsl_Role role, U16 cacheSize, U16 inBufStartSize, U16 outBufSize)
A SharkSsl object is the coordinator for managing SharkSslCon objects.
SHARKSSL_API int SharkSslECCKey_createEx(SharkSslECCKey *privKey, U16 curveID, void *rngHandle, sharkssl_rngfunc rngFunc)
Creates an ECC key using the SharkSSL library.
SHARKSSL_API int SharkSslRSAKey_create(SharkSslRSAKey *privKey, U16 keyLength)
RSA key creation.
SHARKSSL_API U16 SharkSslKey_vectSize_keyInfo(const SharkSslKey key, U8 *keyType, U8 *isKeyPrivate, U8 **d1, U16 *d1Len, U8 **d2, U16 *d2Len)
Returns the private or public key's "vector size" in bytes.
SHARKSSL_API int SharkSslASN1Create_CSR(struct SharkSslASN1Create *o, SharkSslKey privKey, U8 hashID, struct SharkSslCertDN *certDN, const char *SAN, struct SharkSslBitExtReq *keyUsage, struct SharkSslBitExtReq *nsCertType)
CSR creation (all parameters are input parameters)
SHARKSSL_API void SharkSslCertStore_constructor(SharkSslCertStore *o)
Initialize a SharkSslCertStore object.
SHARKSSL_API int SharkSslCert_signCSR(SharkSslCert *signedCSR, const U8 *csrData, int csrDataLen, const SharkSslCert caCert, const SharkSslKey privKey, const char *validFrom, const char *validTo, SharkCertSerialNumber serialNumber, U8 hashID)
CSR signing (if not specified, parameters are input parameters)
SHARKSSL_API U16 SharkSslRSAKey_size(SharkSslRSAKey key)
Returns the private or public key's modulus size in bytes.
SHARKSSL_API void SharkSslECCKey_free(SharkSslECCKey key)
Release a SharkSslECCKey allocated by functions sharkssl_PEM_to_ECCKey or SharkSslECCKey_create.
SHARKSSL_API U16 SharkSslCertStore_add(SharkSslCertStore *o, const char *cert, U32 certlen)
add a certificate in PEM or p7b format to the CA store.
SHARKSSL_API U8 SharkSslCertStore_assemble(SharkSslCertStore *o, SharkSslCAList *outList)
Assemble all certificates added by calling SharkSslCertStore_add.
struct SharkSslCertStore SharkSslCertStore
SharkSslCertStore is a container object used when assembling a SharkSslCAList.
SHARKSSL_API void SharkSslCertStore_destructor(SharkSslCertStore *o)
Cleanup all memory used by the SharkSslCAList object.
SHARKSSL_API U16 SharkSslCert_len(SharkSslCert cert)
Get certificate length.
SHARKSSL_API U16 SharkSslKey_vectSize(const SharkSslKey key)
Returns the private or public key's "vector size" in bytes.
SHARKSSL_API U8 * SharkSslRSAKey_getPublic(SharkSslRSAKey privKey)
RSA public key extraction from a private key.
struct SharkSslCertInfo SharkSslCertInfo
The peer's certificate information returned by SharkSslCon_getCertInfo.
struct SharkSslCertDN SharkSslCertDN
Certificate KeyUsage and ExtendedKeyUsage flags and relative pseudofunctions.
U8 * SharkSslCon_getEncData(SharkSslCon *o)
This function is used in conjunction with state SharkSslCon_Encrypted returned by function SharkSslCo...
U16 SharkSslCon_getHandshakeDataLen(SharkSslCon *o)
This function is used in conjunction with state SharkSslCon_Handshake returned by function SharkSslCo...
U16 SharkSslCon_getEncDataLen(SharkSslCon *o)
This function is used in conjunction with state SharkSslCon_Encrypted returned by function SharkSslCo...
U16 SharkSslCon_getBufLen(SharkSslCon *o)
Returns the length of the SharkSslCon input buffer.
SharkSslCon_RetVal
The SharkSslCon_decrypt and SharkSslCon_encrypt return values.
Definition: SharkSSL.h:624
SharkSslCon_RetVal SharkSslCon_decrypt(SharkSslCon *o, U16 readLen)
Decrypt the received data copied into the SharkSslCon receive buffer (the buffer returned by SharkSsl...
U16 SharkSslCon_getEncBufSize(SharkSslCon *o)
Returns the length of the buffer returned by SharkSslCon_getEncBufPtr.
U8 SharkSslCon_encryptMore(SharkSslCon *o)
This function is used in conjunction with state SharkSslCon_Encrypted returned by function SharkSslCo...
U8 SharkSslCon_decryptMore(SharkSslCon *o)
This function is used in conjunction with state SharkSslCon_Decrypted returned by function SharkSslCo...
U8 * SharkSslCon_getBuf(SharkSslCon *o)
Returns a pointer to the SharkSslCon input/receive buffer.
SHARKSSL_API U16 SharkSslCon_getDecData(SharkSslCon *o, U8 **bufPtr)
Get a pointer to the decoded data.
U8 SharkSslCon_getAlertLevel(SharkSslCon *o)
This function is used in conjunction with state SharkSslCon_AlertSend returned by function SharkSslCo...
U16 SharkSslCon_copyDecData(SharkSslCon *o, U8 *buf, U16 maxLen)
Copy decoded data to 'buf'.
U8 * SharkSslCon_getEncBufPtr(SharkSslCon *o)
This function is used in conjunction with SharkSslCon_encrypt when using the zero copy send API.
U16 SharkSslCon_setHandshakeDataSent(SharkSslCon *o, U16 length)
This function is used in conjunction with SharkSslCon_getHandshakeData.
U8 SharkSslCon_getAlertDescription(SharkSslCon *o)
This function is used in conjunction with state SharkSslCon_AlertSend returned by function SharkSslCo...
U8 SharkSslCon_isHandshakeComplete(SharkSslCon *o)
Returns the following values:
U8 * SharkSslCon_getHandshakeData(SharkSslCon *o)
This function is used in conjunction with state SharkSslCon_Handshake returned by function SharkSslCo...
SharkSslCon_RetVal SharkSslCon_encrypt(SharkSslCon *o, U8 *buf, U16 maxLen)
Encrypt the data provided by parameter 'buf' or encrypt data in the SharkSslCon send buffer.
@ SharkSslCon_Encrypted
SharkSSL has successfully decrypted a chunk of data.
Definition: SharkSSL.h:703
@ SharkSslCon_Decrypted
Returned when a block of received data has been successfully decrypted.
Definition: SharkSSL.h:642
@ SharkSslCon_AlertSend
Returned when an SSL/TLS alert message must be sent to the peer side.
Definition: SharkSSL.h:682
@ SharkSslCon_AllocationError
The memory pool is too small.
Definition: SharkSSL.h:631
@ SharkSslCon_Error
Indicates general errors, including configuration errors.
Definition: SharkSSL.h:627
@ SharkSslCon_CertificateError
Unrecognized format of a provided certificate.
Definition: SharkSSL.h:713
@ SharkSslCon_AlertRecv
SharkSSL received an SSL/TLS alert message from the peer, which means that the peer either failed to ...
Definition: SharkSSL.h:691
@ SharkSslCon_HandshakeNotComplete
An error condition returned by function SharkSslCon_encrypt if the SSL handshake is not completed.
Definition: SharkSSL.h:709
@ SharkSslCon_Handshake
Returned when an SSL/TLS handshake message has been received or is to be sent.
Definition: SharkSSL.h:655
@ SharkSslCon_NeedMoreData
Returned when SharkSSL holds an incomplete SSL/TLS record or when the connection is initially establi...
Definition: SharkSSL.h:668
U32 baGetUnixTime(void)
Platform dependent function returning seconds since Jan 1 1970.
struct SharkSsl SharkSsl
A SharkSsl object is the coordinator for managing SharkSslCon objects (See SharkSsl_constructor for d...
const U8 * SharkSslCert
The SharkSSL Certificate is in a binary format optimized for speed and size.
Definition: SharkSSL.h:321
SHARKSSL_API int SharkSslASN1Create_key(struct SharkSslASN1Create *o, const SharkSslKey key)
Convert a SharkSslKey to ASN.1 representation.
const U8 * SharkSslCAList
The SharkSSL Certificate Authority (CA) List is in a binary format optimized for speed and size.
Definition: SharkSSL.h:511
struct SharkSslCon SharkSslCon
SharkSslCon is an opaque handle returned by function SharkSsl_createCon.
Definition: SharkSSL.h:559
SharkSsl_Role
Select one of client or server mode when creating a SharkSsl object.
Definition: SharkSSL.h:296
sharkssl_ECDSA_RetVal
Return values from functions sharkssl_ECDSA_sign_hash, sharkssl_ECDSA_verify_hash.
Definition: SharkSSL.h:2521
sharkssl_RSA_RetVal
Return values from functions sharkssl_RSA_public_encrypt, sharkssl_RSA_private_decrypt,...
Definition: SharkSSL.h:1874
U8 * SharkSslKey
The SharkSslKey type.
Definition: SharkSSL.h:313
@ SharkSsl_Unspecified
Definition: SharkSSL.h:297
@ SharkSsl_Client
Definition: SharkSSL.h:299
@ SharkSsl_Server
Definition: SharkSSL.h:298
@ SHARKSSL_ECDSA_ALLOCATION_ERROR
ALLOCATION_ERROR.
Definition: SharkSSL.h:2526
@ SHARKSSL_ECDSA_WRONG_KEY_FORMAT
WRONG_KEY_FORMAT.
Definition: SharkSSL.h:2535
@ SHARKSSL_ECDSA_WRONG_SIGNATURE
WRONG SIGNATURE.
Definition: SharkSSL.h:2550
@ SHARKSSL_ECDSA_WRONG_PARAMETERS
WRONG_PARAMETERS.
Definition: SharkSSL.h:2532
@ SHARKSSL_ECDSA_OK
OK.
Definition: SharkSSL.h:2523
@ SHARKSSL_ECDSA_VERIFICATION_FAIL
VERIFICATION_FAIL.
Definition: SharkSSL.h:2547
@ SHARKSSL_ECDSA_INTERNAL_ERROR
INTERNAL_ERROR.
Definition: SharkSSL.h:2529
@ SHARKSSL_ECDSA_KEY_NOT_PRIVATE
KEY_IS_NOT_PRIVATE.
Definition: SharkSSL.h:2538
@ SHARKSSL_ECDSA_KEY_NOT_PUBLIC
KEY_IS_NOT_PUBLIC.
Definition: SharkSSL.h:2541
@ SHARKSSL_ECDSA_SIGLEN_TOO_SMALL
SIGLEN_TOO_SMALL.
Definition: SharkSSL.h:2544
@ SHARKSSL_RSA_INPUT_DATA_LENGTH_TOO_BIG
INPUT_DATA_LENGTH_TOO_BIG.
Definition: SharkSSL.h:1894
@ SHARKSSL_RSA_WRONG_LABEL_LENGTH
WRONG_LABEL_LENGTH.
Definition: SharkSSL.h:1912
@ SHARKSSL_RSA_OK
OK.
Definition: SharkSSL.h:1876
@ SHARKSSL_RSA_INTERNAL_ERROR
INTERNAL_ERROR.
Definition: SharkSSL.h:1882
@ SHARKSSL_RSA_WRONG_PARAMETERS
WRONG_PARAMETERS.
Definition: SharkSSL.h:1885
@ SHARKSSL_RSA_WRONG_SIGNATURE
WRONG SIGNATURE.
Definition: SharkSSL.h:1909
@ SHARKSSL_RSA_ALLOCATION_ERROR
ALLOCATION_ERROR.
Definition: SharkSSL.h:1879
@ SHARKSSL_RSA_WRONG_KEY_FORMAT
WRONG_KEY_FORMAT.
Definition: SharkSSL.h:1888
@ SHARKSSL_RSA_PKCS1_PADDING_ERROR
PKCS1_PADDING_ERROR.
Definition: SharkSSL.h:1900
@ SHARKSSL_RSA_INPUT_DATA_LENGTH_AND_KEY_LENGTH_MISMATCH
INPUT_DATA_LENGTH_AND_KEY_LENGTH_MISMATCH.
Definition: SharkSSL.h:1897
@ SHARKSSL_RSA_WRONG_KEY_LENGTH
WRONG_KEY_LENGTH.
Definition: SharkSSL.h:1891
@ SHARKSSL_RSA_VERIFICATION_FAIL
VERIFICATION FAIL.
Definition: SharkSSL.h:1906
@ SHARKSSL_RSA_KEY_NOT_PRIVATE
KEY_IS_NOT_PRIVATE.
Definition: SharkSSL.h:1903
SHARKSSL_API SharkSslSession * SharkSslCon_acquireSession(SharkSslCon *o)
Request a SharkSslSession object from the client's session pool.
SHARKSSL_API U8 SharkSslCon_releaseSession(SharkSslCon *o)
experimental
struct SharkSslSession SharkSslSession
SharkSslSession is an opaque handle returned by function SharkSslCon_acquireSession.
Definition: SharkSSL.h:269
SHARKSSL_API U8 SharkSslCon_resumeSession(SharkSslCon *o, SharkSslSession *s)
Resume an existing session.
SHARKSSL_API U8 SharkSslCon_isResumed(SharkSslCon *o)
Returns 1 if the current session is a resumed one.
SHARKSSL_API U32 SharkSslSession_getLatestAccessTime(SharkSslSession *o)
Returns the last time the session was accessed.
SHARKSSL_API U8 SharkSslSession_release(SharkSslSession *o, SharkSsl *s)
Release a session created by function SharkSslCon_acquireSession.
Opaque object used when creating ASN.1 encoded data.
Definition: SharkSslASN1.h:232
https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/nss_tech_notes/nss_tech_note3 http://to...
Definition: SharkSslASN1.h:243
Certificate KeyUsage and ExtendedKeyUsage flags and relative pseudofunctions.
Definition: SharkSSL.h:790
U8 unitLen
length in bytes of the field "organization"
Definition: SharkSSL.h:806
U8 provinceLen
length in bytes of the field "country"
Definition: SharkSSL.h:803
const U8 * province
State or Province.
Definition: SharkSSL.h:792
U8 localityLen
length in bytes of the field "province"
Definition: SharkSSL.h:804
const U8 * unit
Organizational Unit (OU: department or organization unit)
Definition: SharkSSL.h:795
const U8 * organization
Organization Name (company or department)
Definition: SharkSSL.h:794
const U8 * commonName
Common Name is the Host + Domain Name (example: www.mycompany.com, where www is host and mycompany....
Definition: SharkSSL.h:799
const U8 * countryName
ISO3166 country code.
Definition: SharkSSL.h:791
U8 organizationLen
length in bytes of the field "locality"
Definition: SharkSSL.h:805
U8 commonNameLen
length in bytes of the field "unit"
Definition: SharkSSL.h:807
const U8 * locality
The city or town name.
Definition: SharkSSL.h:793
U8 emailAddressLen
length in bytes of the field "common name"
Definition: SharkSSL.h:808
The peer's certificate information returned by SharkSslCon_getCertInfo.
Definition: SharkSSL.h:848
U8 timeFromLen
Length of 'timeFrom'.
Definition: SharkSSL.h:904
U8 timeToLen
Length of 'timeTo'.
Definition: SharkSSL.h:907
U16 snLen
Length of 'sn' (serial number)
Definition: SharkSSL.h:850
U8 * timeTo
Certificate expiration date (in Time format: [YY]YYMMDDHHMMSSZ) UTCTime: 2-digit year; GeneralizedTim...
Definition: SharkSSL.h:875
U8 CAflag
The Certificate Authority flag (CA) is set to one if the certificate is a CA i.e.
Definition: SharkSSL.h:860
SharkSslCertDN issuer
The entity who has signed and issued the certificate (RFC 2459 4.1.2.4)
Definition: SharkSSL.h:881
SharkSslCertDN subject
The entity associated with the public key (RFC 2459 4.1.2.6).
Definition: SharkSSL.h:887
U8 * sn
Binary serial number.
Definition: SharkSSL.h:864
U8 * timeFrom
Certificate is valid from date (in Time format: [YY]YYMMDDHHMMSSZ) UTCTime: 2-digit year; Generalized...
Definition: SharkSSL.h:869
U8 * subjectAltNamesPtr
Subject Alternative Names subjectAltNamesPtr is a pointer to an ASN1 sequence, whose length is subjec...
Definition: SharkSSL.h:900
struct SharkSslCertInfo * parent
Pointer to parent node when the SharkSslCertInfo object is part of a certificate chain.
Definition: SharkSSL.h:938
U8 version
Certificate version is offset at 0 so add +1 for actual version number.
Definition: SharkSSL.h:855
SharkSslCertStore is a container object used when assembling a SharkSslCAList.
Definition: SharkSSL.h:2666
A SharkSsl object is the coordinator for managing SharkSslCon objects (See SharkSsl_constructor for d...
Definition: SharkSSL.h:575