CSSM_CSP_Login

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

CSSM_CSP_GetLoginOwner

CSSM_CSP_Logout

CSSM_CSP_Login

Library
Description
Errors

Parameters
Return Value
See Also

NAME

CSSM_CSP_Login - Log user in to the CSP (CDSA)

SYNOPSIS

# include <cssm.h>

CSSM_RETURN CSSMAPI CSSM_CSP_Login
(CSSM_CSP_HANDLE CSPHandle,
const CSSM_ACCESS_CREDENTIALS *AccessCred,
const CSSM_DATA *LoginName,
const void *Reserved)

LIBRARY

Common Security Services Manager library (cdsa$incssm300_shr.exe)

PARAMETERS

`CSPHandle` (input)
		Handle of the CSP to log in to.
`AccessCred` (input)
		A pointer to the set of one or more credentials required to log in to the token or Cryptographic Service Provider. The credentials structure can contain an immediate value for the credential, such as a passphrase or PIN, or the caller can specify a callback function the CSP can use to obtain one or more credentials.
`LoginName` (input/optional)
		A name or ID of the caller. The value is used with the provided `AccessCred` to authenticate and authorize the caller for login with the CSP. The CSP can require that a name value be provided. If a name value is not provided, the CSP can assume a default name under which to perform the authentication and authorization check, or the login request can fail.
`Reserved` (input)
		This field is reserved for future use. The value NULL should always be given. (May be used for multiple user support in the future.)

DESCRIPTION

Logs the user in to the CSP, allowing for multiple login types.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particular error condition. The value CSSM_OK indicates success. All other values represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_CSP_INVALID_LOGIN_NAME
CSSMERR_CSP_ALREADY_LOGGED_IN