dtls.h

Go to the documentation of this file.

/*
 * dtls.h
 *
 * DTLS Developer API
 *
 * Copyright 2019-2024 DigiCert, Inc. All Rights Reserved.
 * Proprietary and Confidential Material.
 *
 */
#ifndef __DTLS_H__
#define __DTLS_H__

#if defined(__ENABLE_MOCANA_DTLS_SERVER__) || defined(__ENABLE_MOCANA_DTLS_CLIENT__)

#ifdef __cplusplus
extern "C" {
#endif

/*------------------------------------------------------------------*/

#ifndef DTLS_MAX_MUTEX
#define DTLS_MAX_MUTEX                      (10)
#endif

#ifndef TIMEOUT_DTLS_HELLO_VERIFY_COOKIE
#define TIMEOUT_DTLS_HELLO_VERIFY_COOKIE    (10000)  /* 10 seconds */
#endif

struct certStore;

/* common */
MOC_EXTERN struct  sslSettings* DTLS_dtlsSettings(void);

MOC_EXTERN sbyte4  DTLS_shutdown(void);

MOC_EXTERN sbyte4  DTLS_releaseTables(void);

MOC_EXTERN sbyte4  DTLS_getCookie(sbyte4 connectionInstance, void** pCookie);

MOC_EXTERN sbyte4  DTLS_setCookie(sbyte4 connectionInstance, void* cookie);

MOC_EXTERN sbyte4  DTLS_getPeerDescr(sbyte4 connectionInstance, const peerDescr **ppRetPeerDescr);

MOC_EXTERN sbyte4  DTLS_isSessionDTLS(sbyte4 connectionInstance);

MOC_EXTERN sbyte4  DTLS_getSessionFlags(sbyte4 connectionInstance, ubyte4 *pRetFlagsSSL);

MOC_EXTERN sbyte4  DTLS_getSessionStatus(sbyte4 connectionInstance, ubyte4 *pRetStatusSSL);

MOC_EXTERN sbyte4  DTLS_setSessionFlags(sbyte4 connectionInstance, ubyte4 flagsSSL);
MOC_EXTERN sbyte4  DTLS_ioctl(sbyte4 connectionInstance, ubyte4 setting, void *value);

MOC_EXTERN sbyte4  DTLS_lookupAlert(sbyte4 connectionInstance, sbyte4 lookupError, sbyte4 *pRetAlertId, sbyte4 *pAlertClass);

MOC_EXTERN sbyte4  DTLS_sendAlert(sbyte4 connectionInstance, sbyte4 alertId, sbyte4 alertClass);

MOC_EXTERN sbyte4  DTLS_enableCiphers(sbyte4 connectionInstance, ubyte2 *pCipherSuiteList, ubyte4 listLength);

#if (defined( __ENABLE_MOCANA_SSL_ECDH_SUPPORT__)   || \
        defined(__ENABLE_MOCANA_SSL_ECDHE_SUPPORT__)|| \
        defined(__ENABLE_MOCANA_SSL_ECDH_ANON_SUPPORT__) )

MOC_EXTERN sbyte4  DTLS_enableECCCurves(sbyte4 connectionInstance,
                                        enum tlsExtNamedCurves* pECCCurvesList,
                                        ubyte4 listLength);
#endif

MOC_EXTERN sbyte4  DTLS_getCipherInfo( sbyte4 connectionInstance, ubyte2* pCipherId, ubyte4* pPeerEcCurves);

MOC_EXTERN sbyte4  DTLS_initiateRehandshake(sbyte4 connectionInstance);

MOC_EXTERN sbyte4  DTLS_checkHandshakeTimer(sbyte4 connectionInstance);

#if (defined (__ENABLE_MOCANA_DTLS_SRTP__) && defined (__ENABLE_MOCANA_SRTP_PROFILES_SELECT__))

MOC_EXTERN sbyte4  DTLS_enableSrtpProfiles(sbyte4 connectionInstance, ubyte2 *pSrtpProfileList, ubyte4 listLength);
#endif

#if defined(__ENABLE_MOCANA_DTLS_CLIENT__)

/* ywang NOTE: temporarily use hard code number to pass compile time */

MOC_EXTERN sbyte4  DTLS_getClientSessionInfo(sbyte4 connectionInstance, ubyte* sessionIdLen, ubyte sessionId[32], ubyte masterSecret[48]);

MOC_EXTERN sbyte4  DTLS_setServerNameIndication(sbyte4 connectionInstance,
                                                const char* serverName);

#if defined(__ENABLE_MOCANA_MULTIPLE_COMMON_NAMES__)

MOC_EXTERN sbyte4  DTLS_setDNSNames( sbyte4 connectionInstance, const CNMatchInfo* cnMatchInfo);
#endif
#endif

MOC_EXTERN sbyte4 DTLS_init(sbyte4 numServerConnections, sbyte4 numClientConnections);

#if defined(__ENABLE_MOCANA_SSL_CUSTOM_RNG__)

MOC_EXTERN sbyte4 DTLS_initEx(sbyte4 numServerConnections, sbyte4 numClientConnections,
                              RNGFun rngFun, void* arg);
#endif

MOC_EXTERN sbyte4 DTLS_recvMessage(sbyte4 connectionInstance, ubyte *pBytesReceived, ubyte4 numBytesReceived,
                       ubyte **ppRetBytesReceived, ubyte4 *pRetNumRxBytesRemaining);

MOC_EXTERN sbyte4 DTLS_sendMessage(sbyte4 connectionInstance, sbyte *pBuffer, sbyte4 bufferSize, sbyte4 *pBytesSent);

MOC_EXTERN sbyte4 DTLS_closeConnection(sbyte4 connectionInstance);

MOC_EXTERN sbyte4 DTLS_getSendBuffer(sbyte4 connectionInstance, ubyte *data, ubyte4 *len);

MOC_EXTERN sbyte4 DTLS_getRecvBuffer(sbyte4 connectionInstance, ubyte **data, ubyte4 *len, ubyte4 *pRetProtocol);

#if defined(__ENABLE_MOCANA_TLS13__)

#if defined(__ENABLE_MOCANA_SSL_MUTUAL_AUTH_SUPPORT__) && defined(__ENABLE_MOCANA_DTLS_SERVER__)

MOC_EXTERN MSTATUS DTLS_sendPosthandshakeAuthCertificateRequest(sbyte4 connectionInstance);
#endif

MOC_EXTERN MSTATUS DTLS_sendKeyUpdateRequest(sbyte4 connectionInstance, ubyte updateRequest);

#if (defined(__ENABLE_MOCANA_TLS13_PSK__) && defined(__ENABLE_MOCANA_TLS13_0RTT__))

MOC_EXTERN sbyte4 DTLS_setRecvEarlyDataSize(sbyte4 connectionInstance,
                                            sbyte4 recvEarlyDataSize);

MOC_EXTERN sbyte4 DTLS_setMaxEarlyDataSize(sbyte4 connectionInstance,
                                           sbyte4 earlyDataSize);

MOC_EXTERN sbyte4 DTLS_setEarlyData(sbyte4 connectionInstance, 
                                    ubyte* pEarlyData, ubyte4 earlyDataSize);

MOC_EXTERN sbyte4
DTLS_setReceiveApplicationDataCallback(sbyte4 (*funcPtrTLS13ApplicationDataCallback)(sbyte4 connectionInstance,
                                                                                     ubyte *pData, ubyte4 dataLen,
                                                                                     dataState state));
#endif
#endif /* __ENABLE_MOCANA_TLS13__ */

/* client */
#ifdef __ENABLE_MOCANA_DTLS_CLIENT__

MOC_EXTERN sbyte4  DTLS_connect(peerDescr *pPeerDescr, ubyte sessionIdLen, ubyte * sessionId, ubyte * masterSecret,
                                const sbyte* dnsName, struct certStore* pCertStore);

MOC_EXTERN sbyte4  DTLS_start(sbyte4 connectionInstance);
#endif

#if defined(__ENABLE_MOCANA_DTLS_SERVER__)

MOC_EXTERN sbyte4 DTLS_acceptConnection(peerDescr *pPeerDescr,
                                        struct certStore* pCertStore);

MOC_EXTERN sbyte4 DTLS_getConnectionInstance(MOC_IP_ADDRESS srcAddr, ubyte2 srcPort, MOC_IP_ADDRESS peerAddr, ubyte2 peerPort);

MOC_EXTERN sbyte4 DTLS_getNextConnectionInstance(ubyte4 *pCookie, sbyte4 *pConnectionInstance, const peerDescr **ppRetPeerDescr);

MOC_EXTERN sbyte4 DTLS_verifyClientHelloCookie(MOC_IP_ADDRESS peerAddr, ubyte *pReceived, ubyte4 length, ubyte *pToSend, ubyte4 *pToSendLen);
#endif
#ifdef __cplusplus
}
#endif

#endif /* defined(__ENABLE_MOCANA_DTLS_SERVER__) || defined(__ENABLE_MOCANA_DTLS_CLIENT__) */
#endif /* __DTLS_H__ */