MQAIR - Authentication information record

The MQAIR structure allows an application running as an IBM® MQ MQI client to specify information about an authenticator that is to be used for the client connection. The structure is an input parameter on the MQCONNX call.

Availability

The MQAIR structure is available for the following clients:

AIX®
HP-UX
Linux®
Solaris
Windows

Character set and encoding

Data in MQAIR must be in the character set and encoding of the local queue manager; these are given by the CodedCharSetId queue manager attribute and MQENC_NATIVE.

Fields

Note: In the following table, the fields are grouped by usage rather than alphabetically. The child topics follow the same sequence.

Table 1. Fields in MQAIR
Field name and description	Name of constant	Initial value (if any) of constant
StrucId (structure identifier)	MQAIR_STRUC_ID	`'AIR¬'`
Version (structure version number)	MQAIR_VERSION_1	`1`
AuthInfoType (type of authentication information)	MQAIT_CRL_LDAP	`1`
AuthInfoConnName (connection name of LDAP CRL server)	None	Null string or blanks
LDAPUserNamePtr (address of LDAP user name)	None	Null pointer or null bytes
LDAPUserNameOffset (offset of LDAP user name from start of MQSCO)	None	`0`
LDAPUserNameLength (length of LDAP user name)	None	`0`
LDAPPassword (password to access LDAP server)	None	Null string or blanks
Note: The remaining fields are ignored if `Version` is less than MQAIR_VERSION_2.
OCSPResponderURL (URL at which the OCSP responder can be contacted)	None	Null string or blanks
Notes: The symbol `¬` represents a single blank character. In the C programming language, the macro variable MQAIR_DEFAULT contains the values that are listed in the table. Use it in the following way to provide initial values for the fields in the structure: `MQAIR MyAIR = {MQAIR_DEFAULT};`

Language declarations

C declaration for MQAIR


typedef struct tagMQAIR MQAIR;
struct tagMQAIR {
  MQCHAR4    StrucId;             /* Structure identifier */
  MQLONG     Version;             /* Structure version number */
  MQLONG     AuthInfoType;        /* Type of authentication
                                     information */
  MQCHAR264  AuthInfoConnName;    /* Connection name of CRL LDAP
                                     server */
  PMQCHAR    LDAPUserNamePtr;     /* Address of LDAP user name */
  MQLONG     LDAPUserNameOffset;  /* Offset of LDAP user name from start
                                     of MQAIR structure */
  MQLONG     LDAPUserNameLength;  /* Length of LDAP user name */
  MQCHAR32   LDAPPassword;        /* Password to access LDAP server */
  MQCHAR256  OCSPResponderURL;    /* URL of OCSP responder */

};

COBOL declaration for MQAIR


**   MQAIR structure
  10 MQAIR.
**    Structure identifier
   15 MQAIR-STRUCID            PIC X(4).
**    Structure version number
   15 MQAIR-VERSION            PIC S9(9) BINARY.
**    Type of authentication information
   15 MQAIR-AUTHINFOTYPE       PIC S9(9) BINARY.
**    Connection name of CRL LDAP server
   15 MQAIR-AUTHINFOCONNNAME   PIC X(264).
**    Address of LDAP user name
   15 MQAIR-LDAPUSERNAMEPTR    POINTER.
**    Offset of LDAP user name from start of MQAIR structure
   15 MQAIR-LDAPUSERNAMEOFFSET PIC S9(9) BINARY.
**    Length of LDAP user name
   15 MQAIR-LDAPUSERNAMELENGTH PIC S9(9) BINARY.
**    Password to access LDAP server
   15 MQAIR-LDAPPASSWORD       PIC X(32).
**    URL of OCSP responder
   15 MQAIR-OCSPRESPONDERURL   PIC X(256).

Visual Basic declaration for MQAIR


Type MQAIR
  StrucId            As String*4   'Structure identifier'
  Version            As Long       'Structure version number'
  AuthInfoType       As Long       'Type of authentication information'
  AuthInfoConnName   As String*264 'Connection name of CRL LDAP server'
  LDAPUserNamePtr    As MQPTR      'Address of LDAP user name'
  LDAPUserNameOffset As Long       'Offset of LDAP user name from start'
                                   'of MQAIR structure'
  LDAPUserNameLength As Long       'Length of LDAP user name'
  LDAPPassword       As String*32  'Password to access LDAP server'
End Type