NetworkPkg/IScsiDxe: distinguish "maximum" and "selected" CHAP digest sizes

[mirror_edk2.git] / NetworkPkg / IScsiDxe / IScsiCHAP.h

/** @file\r
  The header file of CHAP configuration.\r
\r
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _ISCSI_CHAP_H_\r
#define _ISCSI_CHAP_H_\r
\r
#define ISCSI_AUTH_METHOD_CHAP                    "CHAP"\r
\r
#define ISCSI_KEY_CHAP_ALGORITHM                  "CHAP_A"\r
#define ISCSI_KEY_CHAP_IDENTIFIER                 "CHAP_I"\r
#define ISCSI_KEY_CHAP_CHALLENGE                  "CHAP_C"\r
#define ISCSI_KEY_CHAP_NAME                       "CHAP_N"\r
#define ISCSI_KEY_CHAP_RESPONSE                   "CHAP_R"\r
\r
//\r
// Identifiers of supported CHAP hash algorithms:\r
// https://www.iana.org/assignments/ppp-numbers/ppp-numbers.xhtml#ppp-numbers-9\r
//\r
#define ISCSI_CHAP_ALGORITHM_MD5                  5\r
\r
//\r
// Byte count of the largest digest over the above-listed\r
// ISCSI_CHAP_ALGORITHM_* hash algorithms.\r
//\r
#define ISCSI_CHAP_MAX_DIGEST_SIZE                MD5_DIGEST_SIZE\r
\r
#define ISCSI_CHAP_STEP_ONE                       1\r
#define ISCSI_CHAP_STEP_TWO                       2\r
#define ISCSI_CHAP_STEP_THREE                     3\r
#define ISCSI_CHAP_STEP_FOUR                      4\r
\r
\r
#pragma pack(1)\r
\r
typedef struct _ISCSI_CHAP_AUTH_CONFIG_NVDATA {\r
  UINT8 CHAPType;\r
  CHAR8 CHAPName[ISCSI_CHAP_NAME_STORAGE];\r
  CHAR8 CHAPSecret[ISCSI_CHAP_SECRET_STORAGE];\r
  CHAR8 ReverseCHAPName[ISCSI_CHAP_NAME_STORAGE];\r
  CHAR8 ReverseCHAPSecret[ISCSI_CHAP_SECRET_STORAGE];\r
} ISCSI_CHAP_AUTH_CONFIG_NVDATA;\r
\r
#pragma pack()\r
\r
///\r
/// ISCSI CHAP Authentication Data\r
///\r
typedef struct _ISCSI_CHAP_AUTH_DATA {\r
  ISCSI_CHAP_AUTH_CONFIG_NVDATA *AuthConfig;\r
  UINT32                        InIdentifier;\r
  UINT8                         InChallenge[1024];\r
  UINT32                        InChallengeLength;\r
  //\r
  // Calculated CHAP Response (CHAP_R) value.\r
  //\r
  UINT8                         CHAPResponse[ISCSI_CHAP_MAX_DIGEST_SIZE];\r
\r
  //\r
  // Auth-data to be sent out for mutual authentication.\r
  //\r
  // While the challenge size is technically independent of the hashing\r
  // algorithm, it is good practice to avoid hashing *fewer bytes* than the\r
  // digest size. In other words, it's good practice to feed *at least as many\r
  // bytes* to the hashing algorithm as the hashing algorithm will output.\r
  //\r
  UINT32                        OutIdentifier;\r
  UINT8                         OutChallenge[ISCSI_CHAP_MAX_DIGEST_SIZE];\r
} ISCSI_CHAP_AUTH_DATA;\r
\r
/**\r
  This function checks the received iSCSI Login Response during the security\r
  negotiation stage.\r
\r
  @param[in] Conn             The iSCSI connection.\r
\r
  @retval EFI_SUCCESS          The Login Response passed the CHAP validation.\r
  @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
  @retval EFI_PROTOCOL_ERROR   Some kind of protocol error occurred.\r
  @retval Others               Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
IScsiCHAPOnRspReceived (\r
  IN ISCSI_CONNECTION  *Conn\r
  );\r
/**\r
  This function fills the CHAP authentication information into the login PDU\r
  during the security negotiation stage in the iSCSI connection login.\r
\r
  @param[in]       Conn        The iSCSI connection.\r
  @param[in, out]  Pdu         The PDU to send out.\r
\r
  @retval EFI_SUCCESS           All check passed and the phase-related CHAP\r
                                authentication info is filled into the iSCSI\r
                                PDU.\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory.\r
  @retval EFI_PROTOCOL_ERROR    Some kind of protocol error occurred.\r
\r
**/\r
EFI_STATUS\r
IScsiCHAPToSendReq (\r
  IN      ISCSI_CONNECTION  *Conn,\r
  IN OUT  NET_BUF           *Pdu\r
  );\r
\r
#endif\r