MQCSP (Security parameters) on IBM i

Summary of the MQCSP structure for IBM i.


Overview

Purpose: The MQCSP structure enables the authorization service to authenticate a user ID and password. You specify the MQCSP connection security parameters structure on an MQCONNX call.

Character set and encoding: Data in MQCSP must be in the character set given by the CodedCharSetId queue manager attribute and encoding of the local queue manager given by ENNAT.


Fields

The MQCSP structure contains the following fields; the fields are described in alphabetical order:

    CSAUTHT (10-digit signed integer)

    This is the type of authentication to perform.

    Valid values are:

      CSAN
      Do not use user ID and password fields.

      CSAUIAP
      Authenticate user ID and password fields.

    This is an input field. The initial value of this field is CSAN.

    CSCPPL (10-digit signed integer)

    This is the length of the password to be used in authentication.

    The maximum length of the password is not dependent on the platform. If the length of the password is greater than that allowed, the authentication request fails with an RC2035.

    This is an input field. The initial value of this field is 0.

    CSCPPO (10-digit signed integer)

    This is the offset in bytes of the password to be used in authentication.

    The offset can be positive or negative.

    This is an input field. The initial value of this field is 0.

    CSCPPP (pointer)

    This is the address of the password to be used in authentication.

    This is an input field. The initial value of this field is the null pointer.

    CSCSPUIL (10-digit signed integer)

    This is the length of the user ID to be used in authentication.

    The maximum length of the user ID is not dependent on the platform. If the length of the user ID is greater than that allowed, the authentication request fails with an RC2035.

    This is an input field. The initial value of this field is 0.

    CSCSPUIO (10-digit signed integer)

    This is the offset in bytes of the user ID to be used in authentication.

    The offset can be positive or negative.

    This is an input field. The initial value of this field is 0.

    CSCSPUIP (pointer)

    This is the address of the user ID to be used in authentication.

    This is an input field. The initial value of this field is the null pointer. This field is ignored if CSVER is less than CSVER5.

    CSRE1 (4-byte character string)

    A reserved field, required for pointer alignment on IBM i.

    This is an input field. The initial value of this field is all null.

    CSRS2 (8-byte character string)

    A reserved field, required for pointer alignment on IBM i.

    This is an input field. The initial value of this field is all null.

    CSSID (4-byte character string)

    Structure identifier.

    The value must be:

      CSSIDV
      Identifier for the security parameters structure.

    CSVER (10-digit signed integer)

    Structure version number.

    The value must be:

      CSVER1
      Version-1 security parameters structure.

    The following constant specifies the version number of the current version:

      CSVERC
      Current version of security parameters structure.

    This is always an input field. The initial value of this field is CSVER1.


Initial values

Field name Name of constant Value of constant
CSSID CSSIDV 'CSP¬'
CSVER CSVER1 1
CSAUTHT None 0
CSRE1 None Nulls
CSCSPUIP None Null pointer
CSCSPUIO None 0
CSCSPUIL None 0
CSRS2 None Nulls
CSCPPP None Null pointer
CSCPPO None 0
CSCPPL None 0
Note:
  1. The symbol ¬ represents a single blank character.


RPG declaration

D*..1....:....2....:....3....:....4....:....5....:....6....:....7..
      D*                                                                 
      D* MQCSP Structure                                                 
      D*                                                                 
      D* Structure identifier                                            
      D  CSSID                  1      4    INZ('CSP ')                  
      D* Structure version number                                        
      D  CSVER                  5      8I 0 INZ(1)                       
      D* Type of authentication                                          
      D  CSAUTHT                9     12I 0 INZ(0)                       
      D* Reserved                                                        
      D  CSRE1                 13     16    INZ(X'00000000')             
      D* Address of user ID                                              
      D  CSCSPUIP              17     32*   INZ(*NULL)                   
      D* Offset of user ID                                               
      D  CSCSPUIO              33     36I 0 INZ(0)                       
      D* Length of user ID                                               
      D  CSCSPUIL              37     40I 0 INZ(0)                       
      D* Reserved                                                        
      D  CSRS2                 41     48    INZ(X'0000000000000000')     
      D* Address of password                                             
      D  CSCPPP                49     64*   INZ(*NULL)                   
      D* Offset of password                                              
      D  CSCPPO                65     68I 0 INZ(0)                       
      D* Length of password                                              
      D  CSCPPL                69     72I 0 INZ(0)
Parent topic: Data type descriptions on IBM i