]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/AuthenticationInfo.h
MdePkg: Add definition for new warning code EFI_WARN_FILE_SYSTEM.
[mirror_edk2.git] / MdePkg / Include / Protocol / AuthenticationInfo.h
index b70ab9dafb7b8b96bd34c21aecd1236f388874cb..a69423fe5b266a80557a95ce0183fbed09153541 100644 (file)
@@ -3,7 +3,7 @@
   This protocol is used on any device handle to obtain authentication information \r
   associated with the physical or logical device.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -66,9 +66,9 @@ typedef struct {
   UINT8            NasIpAddr[16];            ///< IPv4 or IPv6 address.\r
 \r
   ///\r
-  /// Network Access Server Secret Length in bytes (OPTIONAL)\r
+  /// Network Access Server Secret Length in bytes (OPTIONAL).\r
   ///\r
-  UINT16           NasSecretLength; \r
+  UINT16           NasSecretLength;\r
 \r
   ///\r
   /// Network Access Server Secret (OPTIONAL).\r
@@ -76,11 +76,11 @@ typedef struct {
   UINT8            NasSecret[1];\r
 \r
   /// \r
-  /// CHAP Initiator Secret length in bytes on offset NasSecret + NasSecretLength.\r
+  /// CHAP Initiator Secret Length in bytes on offset NasSecret + NasSecretLength.\r
   ///\r
   /// UINT16           ChapSecretLength;\r
   ///\r
-  /// CHAP Initiator Secret\r
+  /// CHAP Initiator Secret.\r
   ///\r
   /// UINT8            ChapSecret[];\r
   ///\r
@@ -88,10 +88,26 @@ typedef struct {
   ///\r
   /// UINT16           ChapNameLength;\r
   ///\r
-  /// CHAP Initiator Name\r
+  /// CHAP Initiator Name.\r
   ///\r
   /// UINT8            ChapName[];\r
   ///\r
+  /// Reverse CHAP Name Length in bytes on offset ChapName + ChapNameLength.\r
+  ///\r
+  /// UINT16           ReverseChapNameLength;\r
+  ///\r
+  /// Reverse CHAP Name.\r
+  ///\r
+  /// UINT8            ReverseChapName[];\r
+  ///\r
+  /// Reverse CHAP Secret Length in bytes on offseet ReverseChapName + ReverseChapNameLength.\r
+  ///\r
+  /// UINT16           ReverseChapSecretLength;\r
+  ///\r
+  /// Reverse CHAP Secret.\r
+  ///\r
+  /// UINT8            ReverseChapSecret[];\r
+  ///\r
 } CHAP_RADIUS_AUTH_NODE;\r
 \r
 typedef struct {\r
@@ -117,25 +133,41 @@ typedef struct {
   ///\r
   /// UINT16           UserNameLength;\r
   ///\r
-  /// User Name\r
+  /// User Name.\r
   ///\r
-  /// UINT8            *UserName;\r
+  /// UINT8            UserName[];\r
   ///\r
-  /// CHAP Initiator Secret length in bytes on offset UserName + UserNameLength\r
+  /// CHAP Initiator Secret Length in bytes on offset UserName + UserNameLength.\r
   ///\r
   /// UINT16           ChapSecretLength;\r
   ///\r
-  /// CHAP Initiator Secret\r
+  /// CHAP Initiator Secret.\r
   ///\r
-  /// UINT8            *ChapSecret;\r
+  /// UINT8            ChapSecret[];\r
   ///\r
-  /// CHAP Initiator Name Length in bytes on offset ChapSecret + ChapSecretLength\r
+  /// CHAP Initiator Name Length in bytes on offset ChapSecret + ChapSecretLength.\r
   ///\r
   /// UINT16           ChapNameLength;\r
   ///\r
-  /// CHAP Initiator Name\r
+  /// CHAP Initiator Name.\r
+  ///\r
+  /// UINT8            ChapName[];\r
+  ///\r
+  /// Reverse CHAP Name Length in bytes on offset ChapName + ChapNameLength.\r
+  ///\r
+  /// UINT16           ReverseChapNameLength;\r
+  ///\r
+  /// Reverse CHAP Name.\r
+  ///\r
+  /// UINT8            ReverseChapName[];\r
+  ///\r
+  /// Reverse CHAP Secret Length in bytes on offset ReverseChapName + ReverseChapNameLength.\r
+  ///\r
+  /// UINT16           ReverseChapSecretLength;\r
+  ///\r
+  /// Reverse CHAP Secret.\r
   ///\r
-  /// UINT8            *ChapName;\r
+  /// UINT8            ReverseChapSecret[];\r
   ///\r
 } CHAP_LOCAL_AUTH_NODE;\r
 #pragma pack()\r
@@ -145,7 +177,9 @@ typedef struct {
 \r
   @param[in]  This                  The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL.\r
   @param[in]  ControllerHandle      The handle to the Controller.\r
-  @param[out] Buffer                The pointer to the authentication information.\r
+  @param[out] Buffer                The pointer to the authentication information. This function is\r
+                                    responsible for allocating the buffer and it is the caller's\r
+                                    responsibility to free buffer when the caller is finished with buffer.\r
 \r
   @retval EFI_SUCCESS           Successfully retrieved authentication information \r
                                 for the given ControllerHandle.\r
@@ -157,10 +191,10 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_GET)(\r
+(EFIAPI *EFI_AUTHENTICATION_INFO_PROTOCOL_GET)(\r
   IN  EFI_AUTHENTICATION_INFO_PROTOCOL *This,\r
-  IN  EFI_HANDLE                       *ControllerHandle,\r
-  OUT VOID                             *Buffer\r
+  IN  EFI_HANDLE                       ControllerHandle,\r
+  OUT VOID                             **Buffer\r
   );\r
 \r
 /**\r
@@ -181,9 +215,9 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_SET)(\r
+(EFIAPI *EFI_AUTHENTICATION_INFO_PROTOCOL_SET)(\r
   IN EFI_AUTHENTICATION_INFO_PROTOCOL  *This,\r
-  IN EFI_HANDLE                        *ControllerHandle,\r
+  IN EFI_HANDLE                        ControllerHandle,\r
   IN VOID                              *Buffer\r
   );  \r
 \r
@@ -192,8 +226,8 @@ EFI_STATUS
 /// information associated with the physical or logical device.\r
 ///\r
 struct _EFI_AUTHENTICATION_INFO_PROTOCOL {\r
-  EFI_AUTHENTICATION_PROTOCOL_INFO_GET Get;\r
-  EFI_AUTHENTICATION_PROTOCOL_INFO_SET Set;\r
+  EFI_AUTHENTICATION_INFO_PROTOCOL_GET Get;\r
+  EFI_AUTHENTICATION_INFO_PROTOCOL_SET Set;\r
 };\r
 \r
 extern EFI_GUID gEfiAuthenticationInfoProtocolGuid;\r