SharkSslCSR.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / /  __/ /___/ /_/ / /_/ / /__
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
 *                                                       /____/
 *
 *                 SharkSSL Embedded SSL/TLS Stack
 ****************************************************************************
 *   PROGRAM MODULE
 *
 *   COPYRIGHT:  Real Time Logic LLC, 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 _SharkSslCSR_h
#define _SharkSslCSR_h
 
#include "SharkSSL.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if (SHARKSSL_ENABLE_CSR_SIGNING)
#define SHARKSSL_CERT_PROFILE_ROOT_CA                 1
#define SHARKSSL_CERT_PROFILE_INTERMEDIATE_CA         2
#define SHARKSSL_CERT_PROFILE_TLS_SERVER              3
#define SHARKSSL_CERT_PROFILE_TLS_CLIENT              4
#define SHARKSSL_CERT_PROFILE_OPCUA_SERVER            5
#define SHARKSSL_CERT_PROFILE_OPCUA_CLIENT            6
#define SHARKSSL_CERT_PROFILE_TLS_SERVER_SELF_SIGNED  7
 
#define SHARKSSL_CERT_SAN_DNS                         2
#define SHARKSSL_CERT_SAN_URI                         6
#define SHARKSSL_CERT_SAN_IP                          7
 
typedef struct SharkSslCertSAN
{
   const U8 *value;
   U16 length;
   U8 type;
} SharkSslCertSAN;
 
typedef struct SharkSslCertProfile
{
   int (*approveSANs)(void *context, const SharkSslCertSAN *names, U16 count);
   void *context;
   U16 pathLenConstraint;
   U8 type;
} SharkSslCertProfile;
 
typedef struct SharkSslCertDER
{
   const U8 *data;
   U16 length;
} SharkSslCertDER;
 
SHARKSSL_API int
SharkSslCert_validateCAChain(const SharkSslCertDER *chain,
                            const SharkSslCertDER *trustedRoot,
                            const SharkSslKey expectedKey,
                            const char *utcNow,
                            U16 count);
 
SHARKSSL_API int
SharkSslCert_validateIssuedIdentity(const SharkSslCertDER *issued,
                                    const SharkSslCertDER *issuer,
                                    const SharkSslKey expectedKey,
                                    const SharkSslCertSAN *approvedSANs,
                                    const char *validFrom,
                                    const char *validTo,
                                    const char *utcNow,
                                    U16 sanCount);
 
SHARKSSL_API int
SharkSslCert_signCSR(SharkSslCert *signedCSR,
                    const SharkSslCertProfile *profile,
                    const U8 *csrData,
                    const SharkSslCert caCert,
                    const SharkSslKey privKey,
                    const char *validFrom,
                    const char *validTo,
                    int csrDataLen,
                    SharkCertSerialNumber serialNumber,
                    U8 hashID);
#if SHARKSSL_PSA_CONSUMER
SHARKSSL_API int SharkSslCert_signCSRWithPSAKey(SharkSslCert *signedCSR,
                                               const SharkSslCertProfile *profile,
                                               const U8 *csrData,
                                               const SharkSslCert caCert,
                                               const char *validFrom,
                                               const char *validTo,
                                               int csrDataLen,
                                               SharkCertSerialNumber serialNumber,
                                               psa_key_id_t psaSignKey,
                                               U8 hashID);
#if SHARKSSL_ENABLE_EDDSA
SHARKSSL_API int
SharkSslCert_signCSRWithPSAEdDSAKey(SharkSslCert *signedCSR,
                                    const SharkSslCertProfile *profile,
                                    const U8 *csrData,
                                    const SharkSslCert caCert,
                                    const char *validFrom,
                                    const char *validTo,
                                    int csrDataLen,
                                    SharkCertSerialNumber serialNumber,
                                    psa_key_id_t psaSignKey);
#endif
#endif
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif