CREATE_PASSWORD_SUBSTITUTE

CREATE_PASSWORD_SUBSTITUTE returns the password substitute, password verifier, and the send sequence number used to generate the substitute and verifier for the specified session.

VCB Structure

typedef struct create_password_substitute
{
   unsigned short  opcode;            /* verb operation code          */
   unsigned char   reserv2;           /* reserved                     */
   unsigned char   format;            /* format                       */
   unsigned short  primary_rc;        /* primary return code          */
   unsigned long   secondary_rc;      /* secondary return code        */
   unsigned char   lu_alias[8];       /* LU alias                     */
   unsigned char   conv_group_id[8];  /* partner LU alias             */
   unsigned char   user_id[10];       /* user ID                      */
   unsigned char   pw[10];            /* clear text password          */
   unsigned char   seq_no[8];         /* sequence number              */
   unsigned char   pw_sub[10];        /* password substitute          */
   unsigned char   pw_verifier[10];   /* password verifier            */
} CREATE_PASSWORD_SUBSTITUTE;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_CREATE_PASSWORD_SUBSTITUTE
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
lu_alias
Locally defined LU alias. This is an 8-byte string in a locally displayable character set.
conv_group_id
Conversation group identifier for the session used by the LU.
user_id
The user ID.
pw
Clear text password to be used in the encryption algorithm.

Returned Parameters

If the verb executes successfully, the Program returns the following parameters:
primary_rc
AP_OK
seq_no
Send sequence number used in the encryption algorithm. Note, if the verb is successful, the internal value of the send sequence number for this session is incremented. The value returned is the value after incrementing.
pw_sub
Password substitute generated by the encryption algorithm.
pw_verifier
Password verifier generated by the encryption algorithm.
If the verb does not execute because of a parameter error, the Program returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_BAD_LU_ALIAS

AP_DEACT_CG_INVALID_CGID

If the verb does not execute because the session does not support password substitution, the Program returns the following parameters:
primary_rc
AP_STATE_CHECK
secondary_rc
AP_PW_SUB_NOT_SUPP_ON_SESS
If the verb does not execute because the node has not yet been started, the Program returns the following parameter:
primary_rc
AP_NODE_NOT_STARTED
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR