Chapter 11 Name Server Lookup : tibemsLookupParams

tibemsLookupParams
Type
Purpose
Encapsulate parameters for LDAP lookup.
 
tibemsLookupParams_Create
Function
Purpose
Create a new lookup parameters object.
C Declaration
tibemsLookupParams
    tibemsLookupParams_Create(void);
COBOL Call
CALL "tibemsLookupParams_Create"
RETURNING lparams
END-CALL.
 
lparams has usage pointer.
See Also
tibemsLookupContext_CreateExternal on page 325
tibemsLookupParams_Destroy
Function
Purpose
Destroy a lookup parameters object.
C Declaration
void tibemsLookupParams_Destroy(
    tibemsLookupParams lparams );
COBOL Call
CALL "tibemsLookupParams_Destroy"
USING BY VALUE lparams
END-CALL.
 
lparams has usage pointer.
Parameters
 
tibemsLookupParams_GetLdapServerUrl
Function
Purpose
Get the LDAP server URL.
C Declaration
char* tibemsLookupParams_GetLdapServerUrl(
    tibemsLookupParams lparams);
COBOL Call
CALL "tibemsLookupParams_GetLdapServerUrl"
USING BY VALUE lparams
END-CALL.
 
lparams has usage pointer.
Parameters
 
tibemsLookupParams_SetLdapBaseDN
Function
Purpose
Set the LDAP base distinguished name.
C Declaration
tibems_status tibemsLookupParams_SetLdapBaseDN(
    tibemsLookupParams lparams,
    const char* basedn );
COBOL Call
CALL "tibemsLookupParams_SetLdapBaseDN"
USING BY VALUE lparams,
BY REFERENCE basedn,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Remarks
This parameter is required for all LDAP lookup operations.
tibemsLookupParams_SetLdapCAFile
Function
Purpose
Set the LDAP CA certificate file.
C Declaration
tibems_status tibemsLookupParams_SetLdapCAFile(
    tibemsLookupParams lparams,
    const char* file );
COBOL Call
CALL "tibemsLookupParams_SetLdapCAFile"
USING BY VALUE lparams,
BY REFERENCE file,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Remarks
The client program reads the CA certificate from this file.
tibemsLookupParams_SetLdapCAPath
Function
Purpose
Set the LDAP CA certificate directory pathname.
C Declaration
tibems_status tibemsLookupParams_SetLdapCAPath(
    tibemsLookupParams lparams,
    const char* path );
COBOL Call
CALL "tibemsLookupParams_SetLdapCAPath"
USING BY VALUE lparams,
BY REFERENCE path,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Remarks
Set this parameter when several certificate files are grouped in one directory. This parameter specifies that directory. The client program reads certificate files from this directory.
tibemsLookupParams_SetLdapCertFile
Function
Purpose
Set the LDAP client certificate file.
C Declaration
tibems_status tibemsLookupParams_SetLdapCertFile(
    tibemsLookupParams lparams,
    const char* file );
COBOL Call
CALL "tibemsLookupParams_SetLdapCertFile"
USING BY VALUE lparams,
BY REFERENCE file,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Remarks
The client program reads the client certificate from this file.
Set this parameter when the LDAP server requires clients to present certificates as identification.
tibemsLookupParams_SetLdapCiphers
Function
Purpose
Set SSL ciphers.
C Declaration
tibems_status tibemsLookupParams_SetLdapCiphers(
    tibemsLookupParams lparams,
    const char* ciphers );
COBOL Call
CALL "tibemsLookupParams_SetLdapCiphers"
USING BY VALUE lparams,
BY REFERENCE ciphers,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
"EDH-RSA-DES-CBC3-SHA:EDH-DSS-DES-CBC3-SHA:DES-CBC3-SHA:DES-CBC3-MD5:DHE-DSS-RC4-SHA:IDEA-CBC-SHA:RC4-SHA:RC4-MD5:IDEA-CBC-MD5:RC2-CBC-MD5:RC4-MD5:RC4-64-MD5:EXP1024-DHE-DSS-RC4-SHA:EXP1024-RC4-SHA:EXP1024-DHE-DSS-DES-CBC-SHA:EXP1024-DES-CBC-SHA:EXP1024-RC2-CBC-MD5:EXP1024-RC4-MD5:EDH-RSA-DES-CBC-SHA:EDH-DSS-DES-CBC-SHA:DES-CBC-SHA:DES-CBC-MD5:EXP-EDH-RSA-DES-CBC-SHA:EXP-EDH-DSS-DES-CBC-SHA:EXP-DES-CBC-SHA:EXP-RC2-CBC-MD5:EXP-RC4-MD5:EXP-RC2-CBC-MD5:EXP-RC4-MD5"
Remarks
Set this parameter when using secure LDAP connections.
The LDAP server configures a similar list of ciphers. SSL communication uses the strongest ciphers in the intersection of the server and client cipher lists.
tibemsLookupParams_SetLdapConnType
Function
Purpose
Set the LDAP connection type.
C Declaration
tibems_status tibemsLookupParams_SetLdapConnType(
    tibemsLookupParams lparams,
    const char* type );
COBOL Call
CALL "tibemsLookupParams_SetLdapConnType"
USING BY VALUE lparams,
BY REFERENCE type,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Either "ldaps" or "startTLS" specify secure connections.
tibemsLookupParams_SetLdapCredential
Function
Purpose
Set the LDAP credential (password).
C Declaration
tibems_status tibemsLookupParams_SetLdapCredential(
    tibemsLookupParams lparams,
    const char* credential );
COBOL Call
CALL "tibemsLookupParams_SetLdapCredential"
USING BY VALUE lparams,
BY REFERENCE credential,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
tibemsLookupParams_SetLdapKeyFile
Function
Purpose
Set the LDAP client key file.
C Declaration
tibems_status tibemsLookupParams_SetLdapKeyFile(
    tibemsLookupParams lparams,
    const char* file );
COBOL Call
CALL "tibemsLookupParams_SetLdapKeyFile"
USING BY VALUE lparams,
BY REFERENCE file,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Remarks
The client program reads the private key for the client certificate from this (encrypted) file.
Set this parameter when the LDAP server requires clients to present certificates as identification.
tibemsLookupParams_SetLdapPrincipal
Function
Purpose
Set the LDAP principal (user name).
C Declaration
tibems_status tibemsLookupParams_SetLdapPrincipal(
    tibemsLookupParams lparams,
    const char* principal );
COBOL Call
CALL "tibemsLookupParams_SetLdapPrincipal"
USING BY VALUE lparams,
BY REFERENCE principal,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Remarks
This parameter is required for all LDAP lookup operations.
tibemsLookupParams_SetLdapRandFile
Function
Purpose
Set a randomization data file.
C Declaration
tibems_status tibemsLookupParams_SetLdapRandFile(
    tibemsLookupParams lparams,
    const char* file );
COBOL Call
CALL "tibemsLookupParams_SetLdapRandFile"
USING BY VALUE lparams,
BY REFERENCE file,
           RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Remarks
The client program reads random data for security computations from this file.
Set this parameter when the operating system does not provide a random data service.
tibemsLookupParams_SetLdapSearchScope
Function
Purpose
Set the LDAP search scope.
C Declaration
tibems_status tibemsLookupParams_SetLdapSearchScope(
    tibemsLookupParams lparams,
    const char* scope );
COBOL Call
CALL "tibemsLookupParams_SetLdapSearchScope"
USING BY VALUE lparams,
BY REFERENCE scope,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Remarks
This parameter is required for all LDAP lookup operations.
tibemsLookupParams_SetLdapServerUrl
Function
Purpose
Set the LDAP server URL.
C Declaration
tibems_status tibemsLookupParams_SetLdapServerUrl(
    tibemsLookupParams lparams,
    const char* url);
COBOL Call
CALL "tibemsLookupParams_SetLdapServerUrl"
USING BY VALUE lparams,
BY REFERENCE url,
RETURNING tibems-status
END-CALL.
 
lparams has usage pointer.
Parameters
 
Remarks
This parameter is required for all LDAP lookup operations.