a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap/*
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * CDDL HEADER START
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * The contents of this file are subject to the terms of the
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * Common Development and Distribution License (the "License").
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * You may not use this file except in compliance with the License.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * or http://www.opensolaris.org/os/licensing.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * See the License for the specific language governing permissions
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * and limitations under the License.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * When distributing Covered Code, include this CDDL HEADER in each
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * If applicable, add the following below this CDDL HEADER, with the
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * fields enclosed by brackets "[]" replaced with your own identifying
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * information: Portions Copyright [yyyy] [name of copyright owner]
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * CDDL HEADER END
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap/*
2ef9abdc6ea9bad985430325b12b90938a8cd18fjv * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * Use is subject to license terms.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap#ifndef _IDM_TEXT_H_
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap#define _IDM_TEXT_H_
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap#ifdef __cplusplus
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapextern "C" {
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap#endif
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap#include <sys/idm/idm_impl.h>
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap/*
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * Numerical identifiers for iSCSI name-value pair keys (just so that
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * we can use case statements to handle a particular key-value pair
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * after we find it in idm_kvpair_xlate).
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * We want to use a bitmask to keep track of negotiated key-value pairs
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * so keep this enum under 64 values -- or spend some time reworking the
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * login code.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlaptypedef enum {
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_AUTH_METHOD = 1,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_KRB_AP_REQ,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_KRB_AP_REP,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap /* SPKM */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SPKM_REQ,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SPKM_ERROR,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SPKM_REP_TI,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SPKM_REP_IT,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap /*
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * SRP
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SRP_U,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_TARGET_AUTH,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SRP_GROUP,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SRP_A,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SRP_B,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SRP_M,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SRM_HM,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap /*
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * CHAP
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_CHAP_A,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_CHAP_I,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_CHAP_C,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_CHAP_N,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_CHAP_R,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap /*
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * ISCSI Operational Parameter Keys
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_HEADER_DIGEST,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_DATA_DIGEST,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_MAX_CONNECTIONS,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SEND_TARGETS,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_TARGET_NAME,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_INITIATOR_NAME,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_TARGET_ALIAS,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_INITIATOR_ALIAS,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_TARGET_ADDRESS,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_TARGET_PORTAL_GROUP_TAG,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_INITIAL_R2T,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_IMMEDIATE_DATA,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_MAX_RECV_DATA_SEGMENT_LENGTH,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_MAX_BURST_LENGTH,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_FIRST_BURST_LENGTH,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_DEFAULT_TIME_2_WAIT,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_DEFAULT_TIME_2_RETAIN,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_MAX_OUTSTANDING_R2T,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_DATA_PDU_IN_ORDER,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_DATA_SEQUENCE_IN_ORDER,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_ERROR_RECOVERY_LEVEL,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_SESSION_TYPE,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_OFMARKER,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_OFMARKERINT,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_IFMARKER,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_IFMARKERINT,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap /*
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * iSER-specific keys
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_RDMA_EXTENSIONS,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_TARGET_RECV_DATA_SEGMENT_LENGTH,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_INITIATOR_RECV_DATA_SEGMENT_LENGTH,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_MAX_OUTSTANDING_UNEXPECTED_PDUS,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap /*
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap * End of list marker, no keys below here.
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KI_MAX_KEY
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap} iscsikey_id_t;
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap/* Numerical types for iSCSI name-value pair values */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlaptypedef enum {
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_TEXT,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_ISCSI_NAME,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_ISCSI_LOCAL_NAME,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_BOOLEAN,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_NUMERICAL, /* Hex or decimal constant */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_LARGE_NUMERICAL, /* Hex, decimal or Base64 constant */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_NUMERIC_RANGE,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_REGULAR_BINARY, /* Hex, decimal, base64 not longer than 64 bits */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_LARGE_BINARY, /* Hex, decimal, base64 longer than 64 bites */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_BINARY, /* Regular binary or large binary */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_SIMPLE,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap KT_LIST_OF_VALUES
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap} idmkey_type_t;
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlaptypedef struct {
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap iscsikey_id_t ik_key_id;
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap char *ik_key_name;
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap idmkey_type_t ik_idm_type; /* RFC type */
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap boolean_t ik_declarative;
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap} idm_kv_xlate_t;
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapconst idm_kv_xlate_t *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_lookup_kv_xlate(const char *key, int keylen);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapint
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_nvlist_add_keyvalue(nvlist_t *nvl, char *key, int keylen, char *value);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapint
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_textbuf_to_nvlist(nvlist_t *nvl, char **textbuf, int *textbuflen);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapint
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_textbuf_to_firstfraglen(void *textbuf, int textbuflen);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapint
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_nvlist_to_textbuf(nvlist_t *nvl, char **textbuf, int *textbuflen,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap int *tblen_required);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapkv_status_t
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_nvstat_to_kvstat(int nvrc);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapvoid
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_kvstat_to_error(kv_status_t kvrc, uint8_t *class, uint8_t *detail);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapint
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_nvlist_add_id(nvlist_t *nvl, iscsikey_id_t kv_id, char *value);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapnvpair_t *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_get_next_listvalue(nvpair_t *value_list, nvpair_t *curr_nvp);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapchar *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_id_to_name(iscsikey_id_t kv_id);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapchar *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_nvpair_value_to_textbuf(nvpair_t *nvp);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_status_t
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_pdu_list_to_nvlist(list_t *pdu_list, nvlist_t **nvlist,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap uint8_t *error_detail);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapvoid *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_nvlist_to_itextbuf(nvlist_t *nvl);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapchar *
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_pdu_init_text_data(idm_pdu_t *pdu, void *arg,
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap int max_xfer_len, char *bufptr, int *transit);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapvoid
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlapidm_itextbuf_free(void *arg);
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap#ifdef __cplusplus
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap}
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap#endif
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap
a6d42e7d71324c5193c3b94d57d96ba2925d52e1Peter Dunlap#endif /* _IDM_TEXT_H_ */