TlsDriver.h

Go to the documentation of this file.

 
#ifndef __EFI_TLS_DRIVER_H__
#define __EFI_TLS_DRIVER_H__
 
#include <Uefi.h>
 
//
// Driver Protocols
//
#include <Protocol/ServiceBinding.h>
 
//
// Driver Version
//
#define TLS_VERSION  0x00000000
 
#define TLS_SERVICE_SIGNATURE  SIGNATURE_32 ('T', 'L', 'S', 'S')
 
#define TLS_INSTANCE_SIGNATURE  SIGNATURE_32 ('T', 'L', 'S', 'I')
 
typedef struct _TLS_SERVICE TLS_SERVICE;
 
typedef struct _TLS_INSTANCE TLS_INSTANCE;
 
struct _TLS_SERVICE {
  UINT32                          Signature;
  EFI_SERVICE_BINDING_PROTOCOL    ServiceBinding;
 
  UINT16                          TlsChildrenNum;
  LIST_ENTRY                      TlsChildrenList;
 
  //
  // Handle to install TlsServiceBinding protocol.
  //
  EFI_HANDLE                      Handle;
  EFI_HANDLE                      ImageHandle;
 
  //
  // Main SSL Context object which is created by a server or client once per program
  // life-time and which holds mainly default values for the SSL object which are later
  // created for the connections.
  //
  VOID                            *TlsCtx;
};
 
struct _TLS_INSTANCE {
  UINT32                            Signature;
  LIST_ENTRY                        Link;
 
  BOOLEAN                           InDestroy;
 
  TLS_SERVICE                       *Service;
  EFI_HANDLE                        ChildHandle;
 
  EFI_TLS_PROTOCOL                  Tls;
  EFI_TLS_CONFIGURATION_PROTOCOL    TlsConfig;
 
  EFI_TLS_SESSION_STATE             TlsSessionState;
 
  //
  // Main SSL Connection which is created by a server or a client
  // per established connection.
  //
  VOID                              *TlsConn;
};
 
#define TLS_SERVICE_FROM_THIS(a)   \
  CR (a, TLS_SERVICE, ServiceBinding, TLS_SERVICE_SIGNATURE)
 
#define TLS_INSTANCE_FROM_PROTOCOL(a)  \
  CR (a, TLS_INSTANCE, Tls, TLS_INSTANCE_SIGNATURE)
 
#define TLS_INSTANCE_FROM_CONFIGURATION(a)  \
  CR (a, TLS_INSTANCE, TlsConfig, TLS_INSTANCE_SIGNATURE)
 
VOID
TlsCleanInstance (
  IN TLS_INSTANCE  *Instance
  );
 
EFI_STATUS
TlsCreateInstance (
  IN  TLS_SERVICE   *Service,
  OUT TLS_INSTANCE  **Instance
  );
 
VOID
TlsCleanService (
  IN TLS_SERVICE  *Service
  );
 
EFI_STATUS
TlsCreateService (
  IN  EFI_HANDLE   Image,
  OUT TLS_SERVICE  **Service
  );
 
EFI_STATUS
EFIAPI
TlsUnload (
  IN EFI_HANDLE  ImageHandle
  );
 
EFI_STATUS
EFIAPI
TlsDriverEntryPoint (
  IN EFI_HANDLE        ImageHandle,
  IN EFI_SYSTEM_TABLE  *SystemTable
  );
 
EFI_STATUS
EFIAPI
TlsServiceBindingCreateChild (
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                    *ChildHandle
  );
 
EFI_STATUS
EFIAPI
TlsServiceBindingDestroyChild (
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                    ChildHandle
  );
 
#endif