2 The header file of CHAP configuration
4 Copyright (c) 2004 - 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 the header file for CHAP
21 #ifndef _ISCSI_CHAP_H_
22 #define _ISCSI_CHAP_H_
24 #define ISCSI_CHAP_AUTH_INFO_GUID \
26 0x786ec0ac, 0x65ae, 0x4d1b, {0xb1, 0x37, 0xd, 0x11, 0xa, 0x48, 0x37, 0x97} \
29 extern EFI_GUID mIScsiCHAPAuthInfoGuid
;
31 #define ISCSI_AUTH_METHOD_CHAP "CHAP"
33 #define ISCSI_KEY_CHAP_ALGORITHM "CHAP_A"
34 #define ISCSI_KEY_CHAP_IDENTIFIER "CHAP_I"
35 #define ISCSI_KEY_CHAP_CHALLENGE "CHAP_C"
36 #define ISCSI_KEY_CHAP_NAME "CHAP_N"
37 #define ISCSI_KEY_CHAP_RESPONSE "CHAP_R"
39 #define ISCSI_CHAP_ALGORITHM_MD5 5
41 #define ISCSI_CHAP_AUTH_MAX_LEN 1024
42 #define ISCSI_CHAP_RSP_LEN 16 // == MD5_HASHSIZE
47 ISCSI_CHAP_STEP_THREE
,
53 typedef struct _ISCSI_CHAP_AUTH_CONFIG_NVDATA
{
55 CHAR8 CHAPName
[ISCSI_CHAP_NAME_MAX_LEN
];
56 CHAR8 CHAPSecret
[ISCSI_CHAP_SECRET_MAX_LEN
];
57 CHAR8 ReverseCHAPName
[ISCSI_CHAP_NAME_MAX_LEN
];
58 CHAR8 ReverseCHAPSecret
[ISCSI_CHAP_SECRET_MAX_LEN
];
59 } ISCSI_CHAP_AUTH_CONFIG_NVDATA
;
64 // ISCSI CHAP Authentication Data
66 typedef struct _ISCSI_CHAP_AUTH_DATA
{
67 ISCSI_CHAP_AUTH_CONFIG_NVDATA AuthConfig
;
69 UINT8 InChallenge
[ISCSI_CHAP_AUTH_MAX_LEN
];
70 UINT32 InChallengeLength
;
72 // Calculated CHAP Response (CHAP_R) value
74 UINT8 CHAPResponse
[ISCSI_CHAP_RSP_LEN
];
77 // Auth-data to be sent out for mutual authentication
80 UINT8 OutChallenge
[ISCSI_CHAP_AUTH_MAX_LEN
];
81 UINT32 OutChallengeLength
;
82 } ISCSI_CHAP_AUTH_DATA
;
85 This function checks the received iSCSI Login Response during the security
88 @param Conn[in] The iSCSI connection.
90 @param Transit[in] The transit flag of the latest iSCSI Login Response.
92 @retval EFI_SUCCESS The Login Response passed the CHAP validation.
94 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
96 @retval EFI_PROTOCOL_ERROR Some kind of protocol error happend.
100 IScsiCHAPOnRspReceived (
101 IN ISCSI_CONNECTION
*Conn
,
106 This function fills the CHAP authentication information into the login PDU
107 during the security negotiation stage in the iSCSI connection login.
109 @param Conn[in] The iSCSI connection.
111 @param Pdu[in] The PDU to send out.
113 @retval EFI_SUCCESS All check passed and the phase-related CHAP
114 authentication info is filled into the iSCSI PDU.
116 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
118 @retval EFI_PROTOCOL_ERROR Some kind of protocol error happend.
123 IN ISCSI_CONNECTION
*Conn
,