]>
Commit | Line | Data |
---|---|---|
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 | |
6 | Copyright (c) 2006, Intel Corporation \r | |
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 | |
15 | Module Name: AuthenticationInfo.h\r | |
16 | \r | |
17 | **/\r | |
18 | \r | |
19 | #ifndef __AUTHENTICATION_INFO_H__\r | |
20 | #define __AUTHENTICATION_INFO_H__\r | |
21 | \r | |
22 | #define EFI_AUTHENTICATION_INFO_PROTOCOL_GUID \\r | |
23 | { \\r | |
24 | 0x7671d9d0, 0x53db, 0x4173, {0xaa, 0x69, 0x23, 0x27, 0xf2, 0x1f, 0x0b, 0xc7 } \\r | |
25 | }\r | |
26 | \r | |
27 | #define EFI_AUTHENTICATION_CHAP_RADIUS_GUID \\r | |
28 | { \\r | |
29 | 0xd6062b50, 0x15ca, 0x11da, {0x92, 0x19, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \\r | |
30 | }\r | |
31 | \r | |
32 | #define EFI_AUTHENTICATION_CHAP_LOCAL_GUID \\r | |
33 | { \\r | |
34 | 0xc280c73e, 0x15ca, 0x11da, {0xb0, 0xca, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \\r | |
35 | }\r | |
36 | \r | |
37 | typedef struct _EFI_AUTHENTICATION_INFO_PROTOCOL EFI_AUTHENTICATION_INFO_PROTOCOL;\r | |
38 | \r | |
39 | typedef struct {\r | |
40 | EFI_GUID Guid;\r | |
41 | UINT16 Length;\r | |
42 | } AUTH_NODE_HEADER;\r | |
43 | \r | |
44 | typedef struct {\r | |
45 | AUTH_NODE_HEADER Header;\r | |
46 | EFI_IPv6_ADDRESS RadiusIpAddr; // IPv4 or IPv6 address\r | |
47 | UINT16 Reserved;\r | |
48 | EFI_IPv6_ADDRESS NasIpAddr; // IPv4 or IPv6 address\r | |
49 | UINT16 NasSecretLength; \r | |
50 | UINT8 *NasSecret; \r | |
51 | UINT16 ChapSecretLength;\r | |
52 | UINT8 *ChapSecret;\r | |
53 | UINT16 ChapNameLength;\r | |
54 | UINT8 *ChapName;\r | |
55 | } CHAP_RADIUS_AUTH_NODE;\r | |
56 | \r | |
57 | typedef struct {\r | |
58 | AUTH_NODE_HEADER Header;\r | |
59 | UINT16 Reserved;\r | |
60 | UINT16 UserSecretLength;\r | |
61 | UINT8 *UserSecret; \r | |
62 | UINT16 UserNameLength;\r | |
63 | UINT8 *UserName;\r | |
64 | UINT16 ChapSecretLength;\r | |
65 | UINT8 *ChapSecret;\r | |
66 | UINT16 ChapNameLength;\r | |
67 | UINT8 *ChapName;\r | |
68 | } CHAP_LOCAL_AUTH_NODE;\r | |
69 | \r | |
70 | /**\r | |
71 | Retrieves the Authentication information associated with a particular controller handle.\r | |
72 | \r | |
73 | @param This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r | |
74 | @param ControllerHandle Handle to the Controller\r | |
75 | @param Buffer Pointer to the authentication information.\r | |
76 | \r | |
77 | @retval EFI_SUCCESS Successfully retrieved Authentication information for the given ControllerHandle\r | |
78 | @retval EFI_INVALID_PARAMETER No matching Authentication information found for the given ControllerHandle\r | |
79 | @retval EFI_DEVICE_ERROR The authentication information could not be retrieved due to a\r | |
80 | hardware error.\r | |
81 | \r | |
82 | **/\r | |
83 | typedef\r | |
84 | EFI_STATUS\r | |
85 | (EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_GET) (\r | |
86 | IN EFI_AUTHENTICATION_INFO_PROTOCOL *This,\r | |
87 | IN EFI_HANDLE *ControllerHandle,\r | |
88 | OUT VOID *Buffer\r | |
89 | )\r | |
90 | ; \r | |
91 | \r | |
92 | /**\r | |
93 | Set the Authentication information for a given controller handle.\r | |
94 | \r | |
95 | @param This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r | |
96 | @param ControllerHandle Handle to the Controller\r | |
97 | @param Buffer Pointer to the authentication information.\r | |
98 | \r | |
99 | @retval EFI_SUCCESS Successfully set Authentication information for the given ControllerHandle\r | |
100 | @retval EFI_UNSUPPORTED If the platform policies do not allow setting of the Authentication\r | |
101 | information.\r | |
102 | @retval EFI_DEVICE_ERROR The authentication information could not be configured due to a\r | |
103 | hardware error.\r | |
104 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.\r | |
105 | \r | |
106 | **/\r | |
107 | typedef\r | |
108 | EFI_STATUS\r | |
109 | (EFIAPI *EFI_AUTHENTICATION_PROTOCOL_INFO_SET) (\r | |
110 | IN EFI_AUTHENTICATION_INFO_PROTOCOL *This,\r | |
111 | IN EFI_HANDLE *ControllerHandle,\r | |
112 | IN VOID *Buffer\r | |
113 | )\r | |
114 | ; \r | |
115 | \r | |
116 | struct _EFI_AUTHENTICATION_INFO_PROTOCOL {\r | |
117 | EFI_AUTHENTICATION_PROTOCOL_INFO_GET Get;\r | |
118 | EFI_AUTHENTICATION_PROTOCOL_INFO_SET Set;\r | |
119 | };\r | |
120 | \r | |
121 | extern EFI_GUID gEfiAuthenticationInfoProtocolGuid;\r | |
122 | extern EFI_GUID gEfiAuthenticationChapRadiusGuid;\r | |
123 | extern EFI_GUID gEfiAuthenticationChapLocalGuid;\r | |
124 | \r | |
125 | #endif\r |