AuthVariableLib.h

Go to the documentation of this file.

 
#ifndef _AUTH_VARIABLE_LIB_H_
#define _AUTH_VARIABLE_LIB_H_
 
#include <Protocol/VarCheck.h>
 
#define AUTHINFO_SIZE  ((OFFSET_OF (EFI_VARIABLE_AUTHENTICATION, AuthInfo)) +\
                       (OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID, CertData)) + \
                       sizeof (EFI_CERT_BLOCK_RSA_2048_SHA256))
 
#define AUTHINFO2_SIZE(VarAuth2)  ((OFFSET_OF (EFI_VARIABLE_AUTHENTICATION_2, AuthInfo)) +\
                                  (UINTN) ((EFI_VARIABLE_AUTHENTICATION_2 *) (VarAuth2))->AuthInfo.Hdr.dwLength)
 
#define OFFSET_OF_AUTHINFO2_CERT_DATA  ((OFFSET_OF (EFI_VARIABLE_AUTHENTICATION_2, AuthInfo)) +\
                                       (OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID, CertData)))
 
typedef struct {
  CHAR16      *VariableName;
  EFI_GUID    *VendorGuid;
  UINT32      Attributes;
  UINTN       DataSize;
  VOID        *Data;
  UINT32      PubKeyIndex;
  UINT64      MonotonicCount;
  EFI_TIME    *TimeStamp;
} AUTH_VARIABLE_INFO;
 
typedef
EFI_STATUS
(EFIAPI *AUTH_VAR_LIB_FIND_VARIABLE)(
  IN  CHAR16                *VariableName,
  IN  EFI_GUID              *VendorGuid,
  OUT AUTH_VARIABLE_INFO    *AuthVariableInfo
  );
 
typedef
EFI_STATUS
(EFIAPI *AUTH_VAR_LIB_FIND_NEXT_VARIABLE)(
  IN  CHAR16                *VariableName,
  IN  EFI_GUID              *VendorGuid,
  OUT AUTH_VARIABLE_INFO    *AuthVariableInfo
  );
 
typedef
EFI_STATUS
(EFIAPI *AUTH_VAR_LIB_UPDATE_VARIABLE)(
  IN AUTH_VARIABLE_INFO     *AuthVariableInfo
  );
 
typedef
EFI_STATUS
(EFIAPI *AUTH_VAR_LIB_GET_SCRATCH_BUFFER)(
  IN OUT UINTN      *ScratchBufferSize,
  OUT    VOID       **ScratchBuffer
  );
 
typedef
BOOLEAN
(EFIAPI *AUTH_VAR_LIB_CHECK_REMAINING_SPACE)(
  IN UINT32                     Attributes,
  ...
  );
 
typedef
BOOLEAN
(EFIAPI *AUTH_VAR_LIB_AT_RUNTIME)(
  VOID
  );
 
#define AUTH_VAR_LIB_CONTEXT_IN_STRUCT_VERSION  0x01
 
typedef struct {
  UINTN                                 StructVersion;
  UINTN                                 StructSize;
  //
  // Reflect the overhead associated with the saving
  // of a single EFI authenticated variable with the exception
  // of the overhead associated with the length
  // of the string name of the EFI variable.
  //
  UINTN                                 MaxAuthVariableSize;
  AUTH_VAR_LIB_FIND_VARIABLE            FindVariable;
  AUTH_VAR_LIB_FIND_NEXT_VARIABLE       FindNextVariable;
  AUTH_VAR_LIB_UPDATE_VARIABLE          UpdateVariable;
  AUTH_VAR_LIB_GET_SCRATCH_BUFFER       GetScratchBuffer;
  AUTH_VAR_LIB_CHECK_REMAINING_SPACE    CheckRemainingSpaceForConsistency;
  AUTH_VAR_LIB_AT_RUNTIME               AtRuntime;
} AUTH_VAR_LIB_CONTEXT_IN;
 
#define AUTH_VAR_LIB_CONTEXT_OUT_STRUCT_VERSION  0x01
 
typedef struct {
  UINTN                      StructVersion;
  UINTN                      StructSize;
  //
  // Caller needs to set variable property for the variables.
  //
  VARIABLE_ENTRY_PROPERTY    *AuthVarEntry;
  UINTN                      AuthVarEntryCount;
  //
  // Caller needs to ConvertPointer() for the pointers.
  //
  VOID                       ***AddressPointer;
  UINTN                      AddressPointerCount;
} AUTH_VAR_LIB_CONTEXT_OUT;
 
EFI_STATUS
EFIAPI
AuthVariableLibInitialize (
  IN  AUTH_VAR_LIB_CONTEXT_IN   *AuthVarLibContextIn,
  OUT AUTH_VAR_LIB_CONTEXT_OUT  *AuthVarLibContextOut
  );
 
EFI_STATUS
EFIAPI
AuthVariableLibProcessVariable (
  IN CHAR16    *VariableName,
  IN EFI_GUID  *VendorGuid,
  IN VOID      *Data,
  IN UINTN     DataSize,
  IN UINT32    Attributes
  );
 
#endif