DL_GetDbAcl

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

DL_FreeUniqueRecord

DL_GetDbNameFromHandle

DL_GetDbAcl

Library
Description
Errors

Parameters
Return Value
See Also

NAME

DL_GetDbAcl: CSSM_DL_GetDbAcl - Get ACL description (CDSA)

SYNOPSIS

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_DL_GetDbAcl(CSSM_DL_DB_HANDLE DLDBHandle,const CSSM_STRING *SelectionTag,uint32 *NumberOfAclInfos,CSSM_ACL_ENTRY_INFO_PTR *AclInfos)SPI:CSSM_RETURN CSSMDLI DL_GetDbAcl(CSSM_DL_DB_HANDLE DLDBHandle,const CSSM_STRING *SelectionTag,uint32 *NumberOfAclInfos,CSSM_ACL_ENTRY_INFO_PTR *AclInfos)

LIBRARY

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

PARAMETERS

`DLDBHandle` (input)
		The handle pair that identifies the Data Storageservice provider to perform this operation and the target data storewhose associated ACL entries are scanned and returned.
`SelectionTag` (input/optional)
		A CSSM_STRING value matching the user-defined tagvalue associated with one or more ACL entries for the target database. To retrieve a description of all ACL entries for the targetdata base, this parameter must be NULL.
`NumberOfAclInfos` (output)
		The number of entries in the `AclInfos` array.If no ACL entry descriptions are returned, this value is zero.
`AclInfos` (output)
		An array of CSSM_ACL_ENTRY_INFO structures. Theunique handle contained in each structure can be used during thecurrent attach session to reference the ACL entry for editing. Thestructure is allocated by the service provider and must be releasedby the caller when the structure is no longer needed. If no ACLentry descriptions are returned, this value is NULL.

DESCRIPTION

This function returns a description of zero or more ACL entriesmanaged by the data storage service provider module and associatedwith the target database identified by DLDBHandle.DBHandle.The optional input SelectionTag restricts thereturned descriptions to those ACL entries with a matching EntryTag value.If a SelectionTag value is specified and no matchesare found, zero descriptions are returned. If no SelectionTag isspecified, a description of all ACL entries associated with thetarget data base are returned by this function.

Each AclInfo structure contains:

Public contents of an ACL entry

ACL EntryHandle, which is a uniquevalue defined and managed by the service provider

The public ACL entry information returned by this functionincludes:
The subject
type
A CSSM_LIST structure containing one element identifyingthe type of subject stored in the ACL entry.
Delegation flag
A CSSM_BOOL value indicating whether the subjectcan delegate the permissions recorded in Authorization.
Authorization array
A CSSM_AUTHORIZATIONGROUP structure defining theset of operations for which permission is granted to the Subject.
Validity period
A CSSM_ACL_VALIDITY_PERIOD structure containingtwo elements, the start time and the stop time for which the ACLentry is valid.
ACL entry tag
A CSSM_STRING containing a user-defined value associatedwith the ACL entry.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particularerror condition. The value CSSM_OK indicates success. All othervalues represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_DL_INVALID_DB_HANDLE

The subject type
		A CSSM_LIST structure containing one element identifyingthe type of subject stored in the ACL entry.
Delegation flag
		A CSSM_BOOL value indicating whether the subjectcan delegate the permissions recorded in Authorization.
Authorization array
		A CSSM_AUTHORIZATIONGROUP structure defining theset of operations for which permission is granted to the Subject.
Validity period
		A CSSM_ACL_VALIDITY_PERIOD structure containingtwo elements, the start time and the stop time for which the ACLentry is valid.
ACL entry tag
		A CSSM_STRING containing a user-defined value associatedwith the ACL entry.