SharkTrustX.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/
 *                                                       /____/
 *
 *                  Barracuda Embedded Web-Server
 ****************************************************************************
 *   PROGRAM MODULE
 *
 *   $Id: SharkTrustX.h 6657 2026-10-28 18:19:39Z wini $
 *
 *   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.
 *
 *               https://realtimelogic.com
 ****************************************************************************
 */
 
#ifndef SharkTrustX_h
#define SharkTrustX_h
 
#include <HttpServer.h>
#include <BaTimer.h>
#include <IoIntf.h>
#include <SharkSSL.h>
#include <stddef.h>
 
#if SHARKSSL_PSA_CONSUMER
/* Reserve three consecutive persistent IDs exclusively for this client's
 * private IoIntf store: account, certificate A, certificate B. Override for
 * a platform's key allocation. Do not share this range with another store. */
#ifndef SHARKTRUSTX_PSA_KEY_BASE
#define SHARKTRUSTX_PSA_KEY_BASE 0x23545800
#endif
#if SHARKTRUSTX_PSA_KEY_BASE < 1 || SHARKTRUSTX_PSA_KEY_BASE > 0x3ffffffd
#error SharkTrustX requires three application PSA key IDs
#endif
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum SharkTrustX_Code
{
   SharkTrustX_Ready = 1, 
   SharkTrustX_Retry = 2, 
   SharkTrustX_Busy = -1, 
   SharkTrustX_Identity = -2, 
   SharkTrustX_Storage = -3, 
   SharkTrustX_Portal = -4, 
   SharkTrustX_Acme = -5, 
   SharkTrustX_Trust = -6, 
   SharkTrustX_Crypto = -7, 
   SharkTrustX_Terms = -9 
} SharkTrustX_Code;
 
typedef int (*SharkTrustX_Proof)(const unsigned char* message,
                               size_t messageLen, unsigned char proof[32]);
 
typedef void (*SharkTrustX_Event)(void* context, int code);
 
typedef void (*SharkTrustX_Name)(void* context, const char* name, size_t length);
 
typedef struct SharkTrustX_Config
{
   HttpServer* server; 
   BaTimer* timer; 
   IoIntf* io; 
   SharkSsl* clientSsl; 
   const char* portalDomain; 
   const unsigned char* zoneKey; 
   SharkTrustX_Proof proof; 
   const char* name; 
   const char* directoryUrl; 
   const char* email; 
   BaBool acceptTerms; 
   const char* interfaceName; 
   U16 port; 
   SharkTrustX_Event onEvent; 
   SharkTrustX_Name onName; 
   void* context; 
} SharkTrustX_Config;
 
BA_API int SharkTrustX_start(const SharkTrustX_Config* config);
 
typedef struct SharkTrustX_Status
{
   BaBool ready; 
   BaTime expires; 
   BaTime renew; 
} SharkTrustX_Status;
 
BA_API BaBool SharkTrustX_getStatus(SharkTrustX_Status* status);
 
BA_API int SharkTrustX_setIpAddress(const char* address);
 
BA_API int SharkTrustX_clean(IoIntf* io, BaBool all,
                           SharkTrustX_Event onClean, void* context);
 
#ifdef __cplusplus
}
#endif
#endif