MQCSP - Security parameters
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.
Warning: In some cases, the password in an MQCSP structure for a
client application is sent over the network in plain text. To ensure that client application
passwords are protected appropriately, see MQCSP
password protection.
Availability
The MQCSP structure is available on all supported IBM® MQ platforms.
Character set and encoding
Data in MQCSP 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, respectively.
Fields
Note: In the following table, the fields are grouped by usage rather than alphabetically. The child
topics follow the same sequence.
Field name and description | Name of constant | Initial value (if any) of constant |
---|---|---|
StrucId (structure identifier) | MQCSP_STRUC_ID | 'CSP¬' |
Version (structure version number) | MQCSP_VERSION_1 | 1 |
AuthenticationType (type of authentication) | None | MQCSP_AUTH_NONE |
Reserved1 (required for pointer alignment on IBM i) | None | Null string or blanks |
CSPUserIdPtr (address of user ID) | None | Null pointer or null bytes |
CSPUserIdOffset (offset of user ID) | None | 0 |
CSPUserIdLength (length of user ID) | None | 0 |
Reserved2 (required for pointer alignment on IBM i) | None | Null string or blanks |
CSPPasswordPtr (address of password) | None | Null pointer or null bytes |
CSPPasswordOffset (offset of password) | None | 0 |
CSPPasswordLength (length of password) | None | 0 |
Notes:
|
Language declarations
C declaration for MQCSP
typedef struct tagMQCSP MQCSP;
struct tagMQCSP {
MQCHAR4 StrucId; /* Structure identifier */
MQLONG Version; /* Structure version number */
MQLONG AuthenticationType; /* Type of authentication */
MQBYTE4 Reserved1; /* Required for IBM i pointer
alignment */
MQPTR CSPUserIdPtr; /* Address of user ID */
MQLONG CSPUserIdOffset; /* Offset of user ID */
MQLONG CSPUserIdLength; /* Length of user ID */
MQBYTE8 Reserved2; /* Required for IBM i pointer
alignment */
alignment */
MQPTR CSPPasswordPtr; /* Address of password */
MQLONG CSPPasswordOffset; /* Offset of password */
MQLONG CSPPasswordLength; /* Length of password */
};
COBOL declaration for MQCSP
** MQCSP structure
10 MQCSP.
** Structure identifier
15 MQCSP-STRUCID PIC X(4).
** Structure version number
15 MQCSP-VERSION PIC S9(9) BINARY.
** Type of authentication
15 MQCSP-AUTHENTICATIONTYPE PIC S9(9) BINARY.
** Required for IBM i pointer alignment
15 MQCSP-RESERVED1 PIC X(4).
** Address of user ID
15 MQCSP-CSPUSERIDPTR POINTER.
** Offset of user ID
15 MQCSP-CSPUSERIDOFFSET PIC S9(9) BINARY.
** Length of user ID
15 MQCSP-CSPUSERIDLENGTH PIC S9(9) BINARY.
** Required for IBM i pointer alignment
15 MQCSP-RESERVED2 PIC X(4).
** Address of password
15 MQCSP-CSPPASSWORDPTR POINTER.
** Offset of password
15 MQCSP-CSPPASSWORDOFFSET PIC S9(9) BINARY.
** Length of password
15 MQCSP-CSPPASSWORDLENGTH PIC S9(9) BINARY.
PL/I declaration for MQCSP
dcl
1 MQCSP based,
3 StrucId char(4), /* Structure identifier */
3 Version fixed bin(31), /* Structure version number */
3 AuthenticationType fixed bin(31), /* Type of authentication */
3 Reserved1 char(4), /* Required for IBM i pointer
alignment */
3 CSPUserIdPtr pointer, /* Address of user ID */
3 CSPUserIdOffset fixed bin(31), /* Offset of user ID */
3 CSPUserIdLength fixed bin(31), /* Length of user ID */
3 Reserved2 char(8), /* Required for IBM i pointer
alignment */
3 CSPPasswordPtr pointer, /* Address of password */
3 CSPPasswordOffset fixed bin(31), /* Offset of user ID */
3 CSPPasswordLength fixed bin(31); /* Length of user ID */
Visual Basic declaration for MQCSP
Type MQCSP
StrucId As String*4 'Structure identifier'
Version As Long 'Structure version number'
AuthenticationType As Long 'Type of authentication'
Reserved1 As MQBYTE4 'Required for IBM i pointer'
'alignment'
CSPUserIdPtr As MQPTR 'Address of user ID'
CSPUserIdOffset As Long 'Offset of user ID'
CSPUserIdLength As Long 'Length of user ID'
Reserved2 As MQBYTE8 'Required for IBM i pointer'
'alignment'
CSPPasswordPtr As MQPTR 'Address of password'
CSPPasswordOffset As Long 'Offset of password'
CSPPasswordLength As Long 'Length of password'
End Type