ocs_login.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015, Emulex
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

/**
 * @file
 * Defines the iSCSI Login interface functions.
 *
 * This module will queue requests when insufficent resources exist to send
 * the request immediately.
 */

#ifndef _OCS_LOGIN_H
#define _OCS_LOGIN_H

/* Used as a bit mask to identify key flags */
#define KEY_FLAG_SEND_INI    (1 << 0)  /* specifies the sender of the key */
#define KEY_FLAG_SEND_TGT    (1 << 1)
#define KEY_FLAG_SEND_BOTH   (KEY_FLAG_SEND_INI | KEY_FLAG_SEND_TGT)
#define KEY_FLAG_PHASE_SEC   (1 << 2)  /* specifies the valid phases for the key */
#define KEY_FLAG_PHASE_OPER  (1 << 3)
#define KEY_FLAG_PHASE_FFP   (1 << 4)
#define KEY_FLAG_PHASE_SEC_OPER (KEY_FLAG_PHASE_SEC | KEY_FLAG_PHASE_OPER)
#define KEY_FLAG_PHASE_ALL (KEY_FLAG_PHASE_SEC | KEY_FLAG_PHASE_OPER | KEY_FLAG_PHASE_FFP)
#define KEY_FLAG_USE_LEADING (1 << 5)  /* Valid on leading login only */
#define KEY_FLAG_USE_LOGIN   (1 << 6)  /* Valid on any login */
#define KEY_FLAG_VALID_DISC  (1 << 7)  /* Valid on discovery sessions */
#define KEY_FLAG_NEGOTIATE   (1 << 8)  /* This code should automatically negotiate the key */
#define KEY_FLAG_DEFAULT     (1 << 9)  /* Value is default, negotiation not required */
#define KEY_FLAG_ALLOW_MULTI (1 << 10) /* do not error if key is sent multiple times */
#define KEY_FLAG_ALLOW_LARGE (1 << 11) /* do not error if key value is > 255 characters */

/**
 * @brief enum identifying valid login keys.
 */
typedef enum {
    /* Security Keys */
    KEY_SESSION_TYPE,
    KEY_INITIATOR_NAME,
    KEY_TARGET_NAME,
    KEY_TARGET_ADDRESS,
    KEY_INITIATOR_ALIAS,
    KEY_TARGET_ALIAS,
    KEY_TARGET_PORTAL_GROUP_TAG,
    KEY_AUTH_METHOD,

    /* Operational Keys */
    KEY_HEADER_DIGEST,
    KEY_DATA_DIGEST,
    KEY_MAX_CONNECTIONS,
    KEY_SEND_TARGETS,
    KEY_INITIAL_R2T,
    KEY_IMMEDIATE_DATA,
    KEY_MAX_RECV_DATA_SEGMENT_LEN,
    KEY_MAX_BURST_LENGTH,
    KEY_FIRST_BURST_LENGTH,
    KEY_DEFAULT_TIME_2_WAIT,
    KEY_DEFAULT_TIME_2_RETAIN,
    KEY_MAX_OUTSTANDING_R2T,
    KEY_DATA_PDU_IN_ORDER,
    KEY_DATA_SEQUENCE_IN_ORDER,
    KEY_ERROR_RECOVERY_LEVEL,
    KEY_TASK_REPORTING,

    /* Steering Keys */
    KEY_OF_MARKER,
    KEY_IF_MARKER,
    KEY_OF_MARK_INT,
    KEY_IF_MARK_INT,

    /* Chap Keys */
    KEY_CHAP_ALGORITHM,
    KEY_CHAP_IDENTIFIER,
    KEY_CHAP_CHALLENGE,
    KEY_CHAP_NAME,
    KEY_CHAP_RESPONSE,

    KEY_MAX /* Must be last */
} ocs_login_key_t;

/**
 * @brief Defines the state of the CHAP negotiation.
 */
typedef enum {
    OCS_CHAP_STATE_NOT_SELECTED,
    OCS_CHAP_STATE_CHAP_SELECTED,
    OCS_CHAP_STATE_WAIT_FOR_ALGORITHIM,
    OCS_CHAP_STATE_SENT_CHALLENGE_REQ,
    OCS_CHAP_STATE_SENT_CHALLENGE_RSP,
    OCS_CHAP_STATE_COMPLETE
} ocs_chap_state_e;


/**
 * @brief Defines the fields required to track the login keys during negotiation.
 */
typedef struct {
    char         *key_name;
    uint32_t      flags;
} ocs_login_key_def_t;

extern const ocs_login_key_def_t ocs_login_key_defs[];

#define OCS_LOGIN_ERROR_WRONG_STATE     -10
#define OCS_LOGIN_ERROR_VIRT_ARRAY_TOO_SMALL    -11
#define OCS_LOGIN_REQUEST_QUEUED        -12
#define OCS_LOGIN_NO_QUEUING_RESOURCES      -13

int32_t ocs_iscsi_login_initialize(ocs_iscsi_t *iscsi);
void ocs_iscsi_login_teardown(ocs_iscsi_t *iscsi);
ocs_hal_rtn_e ocs_iscsi_login_cxn_cleanup(ocs_cxn_t *cxn);
void ocs_iscsi_login_retry(ocs_cxn_t *cxn);

int32_t ocs_iscsi_send_login(ocs_cxn_t *cxn,
                 bool   is_discovery,
                 char      *tgt_name);

ocs_pdu_process_rtn_e ocs_iscsi_recv_login(ocs_cxn_t *cxn,
                       ocs_hal_rq_buffer_t *hdr,
                       uint32_t hdr_len,
                       ocs_hal_rq_buffer_t *data,
                       uint32_t data_len);

int32_t ocs_iscsi_send_login_rsp_invalid_during_login(ocs_cxn_t *cxn,
                              uint32_t itt);

int32_t ocs_iscsi_recv_login_rsp(ocs_cxn_t *cxn,
                 ocs_hal_rq_buffer_t *hdr,
                 uint32_t   hdr_len,
                 ocs_hal_rq_buffer_t *data,
                 uint32_t   data_len);

void ocs_iscsi_ffp_text_timeout(void *arg);

ocs_pdu_process_rtn_e ocs_iscsi_recv_text(ocs_cxn_t *cxn,
                      ocs_hal_rq_buffer_t *hdr,
                      uint32_t   hdr_len,
                      ocs_hal_rq_buffer_t *data,
                      uint32_t   data_len,
                      uint8_t   *reject_reason);

int32_t ocs_iscsi_send_logout(ocs_cxn_t *cxn,
                  uint8_t immediate,
                  uint8_t reason_code);

ocs_pdu_process_rtn_e ocs_iscsi_recv_logout(ocs_cxn_t *cxn,
                        ocs_hal_rq_buffer_t *hdr,
                        uint32_t     hdr_len);

int32_t ocs_iscsi_send_logout_rsp(ocs_cxn_t *cxn,
                  uint8_t response,
                  uint32_t itt);

int32_t ocs_iscsi_recv_logout_rsp(ocs_cxn_t *cxn,
                  ocs_hal_rq_buffer_t *hdr,
                  uint32_t hdr_len);

int32_t ocs_iscsi_send_nop_out(ocs_cxn_t *cxn,
                   uint64_t   lun,
                   uint32_t   itt,
                   uint32_t   ttt,
                   char  *data_ptr,
                   uint32_t   data_len);

int32_t ocs_iscsi_send_nop_in(ocs_cxn_t *cxn,
                  uint64_t   lun,
                  uint32_t   itt,
                  uint32_t   ttt,
                  char  *data_ptr,
                  uint32_t   data_len);

int32_t ocs_iscsi_recv_nop_in(ocs_cxn_t *cxn,
                  ocs_hal_rq_buffer_t *hdr,
                  uint32_t   hdr_len,
                  ocs_hal_rq_buffer_t *data,
                  uint32_t   data_len);

ocs_pdu_process_rtn_e ocs_iscsi_recv_nop_out(ocs_cxn_t *cxn,
                         ocs_hal_rq_buffer_t *hdr,
                         uint32_t     hdr_len,
                         ocs_hal_rq_buffer_t *data,
                         uint32_t     data_len);

int32_t ocs_iscsi_send_reject(ocs_cxn_t *cxn,
                  void  *hdr,
                  uint32_t   hdr_len,
                  uint8_t    reason);

int32_t ocs_iscsi_send_async(ocs_cxn_t *cxn,
                 void   *payload,
                 uint32_t    payload_len,
                 uint8_t     reason,
                 uint64_t    lun,
                 uint16_t    param1,
                 uint16_t    param2,
                 uint16_t    param3);

int32_t ocs_iscsi_are_login_reqs_outstanding(ocs_cxn_t *cxn);

void ocs_iscsi_cbit_cleanup(ocs_cxn_t *cxn);

#endif /* !_OCS_LOGIN_H */

/* vim: set noexpandtab textwidth=120: */