]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
2 | EFI_AUTHENTICATION_INFO_PROTOCOL as defined in UEFI 2.0.\r | |
3 | This protocol is used on any device handle to obtain authentication information \r | |
4 | associated with the physical or logical device.\r | |
5 | \r | |
4ca9b6c4 | 6 | Copyright (c) 2006 - 2008, Intel Corporation \r |
d1f95000 | 7 | All rights reserved. This program and the accompanying materials \r |
8 | are licensed and made available under the terms and conditions of the BSD License \r | |
9 | which accompanies this distribution. The full text of the license may be found at \r | |
10 | http://opensource.org/licenses/bsd-license.php \r | |
11 | \r | |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
14 | \r | |
d1f95000 | 15 | **/\r |
16 | \r | |
17 | #ifndef __AUTHENTICATION_INFO_H__\r | |
18 | #define __AUTHENTICATION_INFO_H__\r | |
19 | \r | |
20 | #define EFI_AUTHENTICATION_INFO_PROTOCOL_GUID \\r | |
21 | { \\r | |
22 | 0x7671d9d0, 0x53db, 0x4173, {0xaa, 0x69, 0x23, 0x27, 0xf2, 0x1f, 0x0b, 0xc7 } \\r | |
23 | }\r | |
24 | \r | |
25 | #define EFI_AUTHENTICATION_CHAP_RADIUS_GUID \\r | |
26 | { \\r | |
27 | 0xd6062b50, 0x15ca, 0x11da, {0x92, 0x19, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \\r | |
28 | }\r | |
29 | \r | |
30 | #define EFI_AUTHENTICATION_CHAP_LOCAL_GUID \\r | |
31 | { \\r | |
32 | 0xc280c73e, 0x15ca, 0x11da, {0xb0, 0xca, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \\r | |
33 | }\r | |
34 | \r | |
35 | typedef struct _EFI_AUTHENTICATION_INFO_PROTOCOL EFI_AUTHENTICATION_INFO_PROTOCOL;\r | |
36 | \r | |
37 | typedef struct {\r | |
38 | EFI_GUID Guid;\r | |
39 | UINT16 Length;\r | |
40 | } AUTH_NODE_HEADER;\r | |
41 | \r | |
42 | typedef struct {\r | |
43 | AUTH_NODE_HEADER Header;\r | |
107ffdc9 | 44 | EFI_IPv6_ADDRESS RadiusIpAddr; ///< IPv4 or IPv6 address\r |
d1f95000 | 45 | UINT16 Reserved;\r |
107ffdc9 | 46 | EFI_IPv6_ADDRESS NasIpAddr; ///< IPv4 or IPv6 address\r |
d1f95000 | 47 | UINT16 NasSecretLength; \r |
48 | UINT8 *NasSecret; \r | |
49 | UINT16 ChapSecretLength;\r | |
50 | UINT8 *ChapSecret;\r | |
51 | UINT16 ChapNameLength;\r | |
52 | UINT8 *ChapName;\r | |
53 | } CHAP_RADIUS_AUTH_NODE;\r | |
54 | \r | |
55 | typedef struct {\r | |
56 | AUTH_NODE_HEADER Header;\r | |
57 | UINT16 Reserved;\r | |
58 | UINT16 UserSecretLength;\r | |
59 | UINT8 *UserSecret; \r | |
60 | UINT16 UserNameLength;\r | |
61 | UINT8 *UserName;\r | |
62 | UINT16 ChapSecretLength;\r | |
63 | UINT8 *ChapSecret;\r | |
64 | UINT16 ChapNameLength;\r | |
65 | UINT8 *ChapName;\r | |
66 | } CHAP_LOCAL_AUTH_NODE;\r | |
67 | \r | |
68 | /**\r | |
69 | Retrieves the Authentication information associated with a particular controller handle.\r | |
70 | \r | |
4ca9b6c4 LG |
71 | @param This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r |
72 | @param ControllerHandle Handle to the Controller\r | |
73 | @param Buffer Pointer to the authentication information.\r | |
d1f95000 | 74 | \r |
75 | @retval EFI_SUCCESS Successfully retrieved Authentication information for the given ControllerHandle\r | |
76 | @retval EFI_INVALID_PARAMETER No matching Authentication information found for the given ControllerHandle\r | |
77 | @retval EFI_DEVICE_ERROR The authentication information could not be retrieved due to a\r | |
78 | hardware error.\r | |
79 | \r | |
80 | **/\r | |
81 | typedef\r | |
82 | EFI_STATUS\r | |
8b13229b | 83 | (EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_GET)(\r |
d1f95000 | 84 | IN EFI_AUTHENTICATION_INFO_PROTOCOL *This,\r |
85 | IN EFI_HANDLE *ControllerHandle,\r | |
86 | OUT VOID *Buffer\r | |
ed66e1bc | 87 | ); \r |
d1f95000 | 88 | \r |
89 | /**\r | |
90 | Set the Authentication information for a given controller handle.\r | |
91 | \r | |
4ca9b6c4 LG |
92 | @param This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r |
93 | @param ControllerHandle Handle to the Controller\r | |
94 | @param Buffer Pointer to the authentication information.\r | |
d1f95000 | 95 | \r |
96 | @retval EFI_SUCCESS Successfully set Authentication information for the given ControllerHandle\r | |
97 | @retval EFI_UNSUPPORTED If the platform policies do not allow setting of the Authentication\r | |
98 | information.\r | |
99 | @retval EFI_DEVICE_ERROR The authentication information could not be configured due to a\r | |
100 | hardware error.\r | |
101 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.\r | |
102 | \r | |
103 | **/\r | |
104 | typedef\r | |
105 | EFI_STATUS\r | |
8b13229b | 106 | (EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_SET)(\r |
d1f95000 | 107 | IN EFI_AUTHENTICATION_INFO_PROTOCOL *This,\r |
108 | IN EFI_HANDLE *ControllerHandle,\r | |
109 | IN VOID *Buffer\r | |
ed66e1bc | 110 | ); \r |
d1f95000 | 111 | \r |
4ca9b6c4 LG |
112 | /**\r |
113 | @par Protocol Description:\r | |
114 | This protocol is used on any device handle to obtain authentication \r | |
115 | information associated with the physical or logical device.\r | |
4ca9b6c4 | 116 | **/ \r |
d1f95000 | 117 | struct _EFI_AUTHENTICATION_INFO_PROTOCOL {\r |
118 | EFI_AUTHENTICATION_PROTOCOL_INFO_GET Get;\r | |
119 | EFI_AUTHENTICATION_PROTOCOL_INFO_SET Set;\r | |
120 | };\r | |
121 | \r | |
122 | extern EFI_GUID gEfiAuthenticationInfoProtocolGuid;\r | |
123 | extern EFI_GUID gEfiAuthenticationChapRadiusGuid;\r | |
124 | extern EFI_GUID gEfiAuthenticationChapLocalGuid;\r | |
125 | \r | |
126 | #endif\r |