Common Security: CDSA and CSSM, Version 2 (with corrigenda)
Copyright © 2000 The Open Group

MDS Name Space and Directory Structures

The Module Directory Service leverages name space and types defined by the CDSA Data Storage Library Services API. Even though MDS is a standalone service, application developer can use a similar programming paradigm to access MDS-managed databases and DL module-managed databases.

MDS defines several new data types in addition to those defined by CDSA's Data Storage Library Services. The new types define names for the MDS relations and the records stored in those relations. The MDS-specific names and data structures are defined below.

MDS Name Space

A relation identifier, also referred to as CSSM_DB_RECORDTYPE, identifies an MDS relation. MDS relation identifiers are allocated from the CSSM_DB_RECORDTYPE name space. The MDS system reserves and uses the following name space definitions.


/*  MDS predefined values for a 16K name space */
#define CSSM_DB_RELATIONID_MDS_START (0x40000000)
#define CSSM_DB_RELATIONID_MDS_END (0x40004000)

Object Directory

This constant defines the programmatic name for type of records stored in the MDS Object Directory database.


#define MDS_OBJECT_RECORDTYPE (CSSM_DB_RELATIONID_MDS_START)

CDSA Directory

These constants define the programmatic names for the record types stored in the MDS CDSA Directory database.


#define MDS_CDSA_SCHEMA_START         (MDS_OBJECT_RECORDTYPE)
#define MDS_CDSADIR_CSSM_RECORDTYPE   (MDS_CDSA_SCHEMA_START + 1)
#define MDS_CDSADIR_KRMM_RECORDTYPE   (MDS_CDSA_SCHEMA_START + 2)
#define MDS_CDSADIR_EMM_RECORDTYPE    (MDS_CDSA_SCHEMA_START + 3)
#define MDS_CDSADIR_COMMON_RECORDTYPE
                                      (MDS_CDSA_SCHEMA_START + 4)
#define MDS_CDSADIR_CSP_PRIMARY_RECORDTYPE
                                      (MDS_CDSA_SCHEMA_START + 5)
#define MDS_CDSADIR_CSP_CAPABILITY_RECORDTYPE
                                      (MDS_CDSA_SCHEMA_START + 6)
#define MDS_CDSADIR_CSP_ENCAPSULATED_PRODUCT_RECORDTYPE
                                      (MDS_CDSA_SCHEMA_START + 7)
#define MDS_CDSADIR_CSP_SC_INFO_RECORDTYPE
                                      (MDS_CDSA_SCHEMA_START + 8)
#define MDS_CDSADIR_DL_PRIMARY_RECORDTYPE
                                      (MDS_CDSA_SCHEMA_START + 9)
#define MDS_CDSADIR_DL_ENCAPSULATED_PRODUCT_RECORDTYPE
                                     (MDS_CDSA_SCHEMA_START + 10)
#define MDS_CDSADIR_CL_PRIMARY_RECORDTYPE
                                     (MDS_CDSA_SCHEMA_START + 11)
#define MDS_CDSADIR_CL_ENCAPSULATED_PRODUCT_RECORDTYPE
                                     (MDS_CDSA_SCHEMA_START + 12)
#define MDS_CDSADIR_TP_PRIMARY_RECORDTYPE
                                     (MDS_CDSA_SCHEMA_START + 13)
#define MDS_CDSADIR_TP_OIDS_RECORDTYPE
                                     (MDS_CDSA_SCHEMA_START + 14)
#define MDS_CDSADIR_TP_ENCAPSULATED_PRODUCT_RECORDTYPE
                                     (MDS_CDSA_SCHEMA_START + 15)
#define MDS_CDSADIR_EMM_PRIMARY_RECORDTYPE
                                     (MDS_CDSA_SCHEMA_START + 16)
#define MDS_CDSADIR_AC_PRIMARY_RECORDTYPE 
                                     (MDS_CDSA_SCHEMA_START + 17)
#define MDS_CDSADIR_KR_PRIMARY_RECORDTYPE   
                                     (MDS_CDSA_SCHEMA_START + 18)
#define MDS_CDSADIR_MDS_SCHEMA_RELATIONS
                                     (MDS_CDSA_SCHEMA_START + 19)
#define MDS_CDSADIR_MDS_SCHEMA_ATTRIBUTES
                                     (MDS_CDSA_SCHEMA_START + 20)
#define MDS_CDSADIR_MDS_SCHEMA_INDEXES
                                     (MDS_CDSA_SCHEMA_START + 21)

CDSA Relation Attributes

These constants define the programmatic names for the attributes of the CDSA relations. The constant assigned to an attribute must be unique with the relation containing that attribute.


/*  MDS predefined values for a 16K name space */
#define CSSM_DB_ATTRIBUTE_MDS_START (0x40000000)
#define CSSM_DB_ATTRIBUTE_MDS_END   (0x40004000) 

#define MDS_CDSAATTR_MODULE_ID              (CSSM_DB_ATTRIBUTE_MDS_START + 1)
#define MDS_CDSAATTR_MANIFEST               (CSSM_DB_ATTRIBUTE_MDS_START + 2)
#define MDS_CDSAATTR_MODULE_NAME            (CSSM_DB_ATTRIBUTE_MDS_START + 3)
#define MDS_CDSAATTR_PATH                   (CSSM_DB_ATTRIBUTE_MDS_START + 4)
#define MDS_CDSAATTR_CDSAVERSION            (CSSM_DB_ATTRIBUTE_MDS_START + 5)
#define MDS_CDSAATTR_VENDOR                 (CSSM_DB_ATTRIBUTE_MDS_START + 6)
#define MDS_CDSAATTR_DESC                   (CSSM_DB_ATTRIBUTE_MDS_START + 7)
#define MDS_CDSAATTR_POLICY_STMT            (CSSM_DB_ATTRIBUTE_MDS_START + 8)
#define MDS_CDSAATTR_EMM_SPEC_VERSION       (CSSM_DB_ATTRIBUTE_MDS_START + 9)
#define MDS_CDSAATTR_EMM_VERSION            (CSSM_DB_ATTRIBUTE_MDS_START + 10)
#define MDS_CDSAATTR_EMM_VENDOR             (CSSM_DB_ATTRIBUTE_MDS_START + 11)
#define MDS_CDSAATTR_EMM_TYPE               (CSSM_DB_ATTRIBUTE_MDS_START + 12)
#define MDS_CDSAATTR_SSID                   (CSSM_DB_ATTRIBUTE_MDS_START + 13)
#define MDS_CDSAATTR_SERVICE_TYPE           (CSSM_DB_ATTRIBUTE_MDS_START + 14)
#define MDS_CDSAATTR_NATIVE_SERVICES        (CSSM_DB_ATTRIBUTE_MDS_START + 15)
#define MDS_CDSAATTR_DYNAMIC_FLAG           (CSSM_DB_ATTRIBUTE_MDS_START + 16)
#define MDS_CDSAATTR_MULTITHREAD_FLAG       (CSSM_DB_ATTRIBUTE_MDS_START + 17)
#define MDS_CDSAATTR_SERVICE_MASK           (CSSM_DB_ATTRIBUTE_MDS_START + 18)
#define MDS_CDSAATTR_CSP_TYPE               (CSSM_DB_ATTRIBUTE_MDS_START + 19)
#define MDS_CDSAATTR_CSP_FLAGS              (CSSM_DB_ATTRIBUTE_MDS_START + 20)
#define MDS_CDSAATTR_CSP_CUSTOMFLAGS        (CSSM_DB_ATTRIBUTE_MDS_START + 21)
#define MDS_CDSAATTR_USEE_TAGS              (CSSM_DB_ATTRIBUTE_MDS_START + 22)
#define MDS_CDSAATTR_CONTEXT_TYPE           (CSSM_DB_ATTRIBUTE_MDS_START + 23)
#define MDS_CDSAATTR_ALG_TYPE               (CSSM_DB_ATTRIBUTE_MDS_START + 24)
#define MDS_CDSAATTR_GROUP_ID               (CSSM_DB_ATTRIBUTE_MDS_START + 25)
#define MDS_CDSAATTR_ATTRIBUTE_TYPE         (CSSM_DB_ATTRIBUTE_MDS_START + 26)
#define MDS_CDSAATTR_ATTRIBUTE_VALUE        (CSSM_DB_ATTRIBUTE_MDS_START + 27)
#define MDS_CDSAATTR_PRODUCT_DESC           (CSSM_DB_ATTRIBUTE_MDS_START + 28)
#define MDS_CDSAATTR_PRODUCT_VENDOR         (CSSM_DB_ATTRIBUTE_MDS_START + 29)
#define MDS_CDSAATTR_PRODUCT_VERSION        (CSSM_DB_ATTRIBUTE_MDS_START + 30)
#define MDS_CDSAATTR_PRODUCT_FLAGS          (CSSM_DB_ATTRIBUTE_MDS_START + 31)
#define MDS_CDSAATTR_PRODUCT_CUSTOMFLAGS    (CSSM_DB_ATTRIBUTE_MDS_START + 32)
#define MDS_CDSAATTR_STANDARD_DESC          (CSSM_DB_ATTRIBUTE_MDS_START + 33)
#define MDS_CDSAATTR_STANDARD_VERSION       (CSSM_DB_ATTRIBUTE_MDS_START + 34)
#define MDS_CDSAATTR_READER_DESC            (CSSM_DB_ATTRIBUTE_MDS_START + 35)
#define MDS_CDSAATTR_READER_VENDOR          (CSSM_DB_ATTRIBUTE_MDS_START + 36)
#define MDS_CDSAATTR_READER_VERSION         (CSSM_DB_ATTRIBUTE_MDS_START + 37)
#define MDS_CDSAATTR_READER_FWVERSION       (CSSM_DB_ATTRIBUTE_MDS_START + 38)
#define MDS_CDSAATTR_READER_FLAGS           (CSSM_DB_ATTRIBUTE_MDS_START + 39)
#define MDS_CDSAATTR_READER_CUSTOMFLAGS     (CSSM_DB_ATTRIBUTE_MDS_START + 40)
#define MDS_CDSAATTR_READER_SERIALNUMBER    (CSSM_DB_ATTRIBUTE_MDS_START + 41)
#define MDS_CDSAATTR_SC_DESC                (CSSM_DB_ATTRIBUTE_MDS_START + 42)
#define MDS_CDSAATTR_SC_VENDOR              (CSSM_DB_ATTRIBUTE_MDS_START + 43)
#define MDS_CDSAATTR_SC_VERSION             (CSSM_DB_ATTRIBUTE_MDS_START + 44)
#define MDS_CDSAATTR_SC_FWVERSION           (CSSM_DB_ATTRIBUTE_MDS_START + 45)
#define MDS_CDSAATTR_SC_FLAGS               (CSSM_DB_ATTRIBUTE_MDS_START + 46)
#define MDS_CDSAATTR_SC_CUSTOMFLAGS         (CSSM_DB_ATTRIBUTE_MDS_START + 47)
#define MDS_CDSAATTR_SC_SERIALNUMBER        (CSSM_DB_ATTRIBUTE_MDS_START + 48)
#define MDS_CDSAATTR_DL_TYPE                (CSSM_DB_ATTRIBUTE_MDS_START + 49)
#define MDS_CDSAATTR_QUERY_LIMITS           (CSSM_DB_ATTRIBUTE_MDS_START + 50)
#define MDS_CDSAATTR_CONJUNCTIVE_OPS        (CSSM_DB_ATTRIBUTE_MDS_START + 51)
#define MDS_CDSAATTR_RELATIONAL_OPS         (CSSM_DB_ATTRIBUTE_MDS_START + 52)
#define MDS_CDSAATTR_PROTOCOL               (CSSM_DB_ATTRIBUTE_MDS_START + 53)
#define MDS_CDSAATTR_CERT_TYPEFORMAT        (CSSM_DB_ATTRIBUTE_MDS_START + 54)
#define MDS_CDSAATTR_CRL_TYPEFORMAT         (CSSM_DB_ATTRIBUTE_MDS_START + 55)
#define MDS_CDSAATTR_CERT_FIELDNAMES        (CSSM_DB_ATTRIBUTE_MDS_START + 56)
#define MDS_CDSAATTR_BUNDLE_TYPEFORMAT      (CSSM_DB_ATTRIBUTE_MDS_START + 57)
#define MDS_CDSAATTR_CERT_CLASSNAME         (CSSM_DB_ATTRIBUTE_MDS_START + 58)
#define MDS_CDSAATTR_ROOTCERT               (CSSM_DB_ATTRIBUTE_MDS_START + 59)
#define MDS_CDSAATTR_ROOTCERT_TYPEFORMAT    (CSSM_DB_ATTRIBUTE_MDS_START + 60)
#define MDS_CDSAATTR_VALUE                  (CSSM_DB_ATTRIBUTE_MDS_START + 61)
#define MDS_CDSAATTR_REQCREDENTIALS         (CSSM_DB_ATTRIBUTE_MDS_START + 62)
#define MDS_CDSAATTR_SAMPLETYPES            (CSSM_DB_ATTRIBUTE_MDS_START + 63)
#define MDS_CDSAATTR_ACLSUBJECTTYPES        (CSSM_DB_ATTRIBUTE_MDS_START + 64)
#define MDS_CDSAATTR_AUTHTAGS               (CSSM_DB_ATTRIBUTE_MDS_START + 65)
#define MDS_CDSAATTR_USEETAG                (CSSM_DB_ATTRIBUTE_MDS_START + 66)
#define MDS_CDSAATTR_RETRIEVALMODE          (CSSM_DB_ATTRIBUTE_MDS_START + 67)
#define MDS_CDSAATTR_OID                    (CSSM_DB_ATTRIBUTE_MDS_START + 68)
#define MDS_CDSAATTR_XLATIONTYPEFORMAT      (CSSM_DB_ATTRIBUTE_MDS_START + 69)
#define MDS_CDSAATTR_DEFAULT_TEMPLATE_TYPE  (CSSM_DB_ATTRIBUTE_MDS_START + 70)
#define MDS_CDSAATTR_TEMPLATE_FIELD_NAMES   (CSSM_DB_ATTRIBUTE_MDS_START + 71)
#define MDS_CDSAATTR_AUTHORITY_REQUEST_TYPE (CSSM_DB_ATTRIBUTE_MDS_START + 72)
#define MDS_CDSAATTR_CONFIG_FLAG            (CSSM_DB_ATTRIBUTE_MDS_START + 73)
#define MDS_CDSAATTR_CSSM_GUID              (CSSM_DB_ATTRIBUTE_MDS_START + 74)
#define MDS_CDSAATTR_POLICY_TYPE            (CSSM_DB_ATTRIBUTE_MDS_START + 75)
#define MDS_CDSAATTR_POLICY_NAME            (CSSM_DB_ATTRIBUTE_MDS_START + 76)
#define MDS_CDSAATTR_POLICY_PATH            (CSSM_DB_ATTRIBUTE_MDS_START + 77)
#define MDS_CDSAATTR_POLICY_INFO            (CSSM_DB_ATTRIBUTE_MDS_START + 78)
#define MDS_CDSAATTR_POLICY_MANIFEST        (CSSM_DB_ATTRIBUTE_MDS_START + 79)

MDS Meta-Data Names

These constants define the programmatic names for the meta-data attributes that describe the MDS relations.

/** Meta-data names for the MDS Object directory relation **/ #define MDS_OBJECT_NUM_RELATIONS (1) #define MDS_OBJECT_NUM_ATTRIBUTES (5) /** Defined constant for # of relations in the CDSA directory **/ #define MDS_CDSADIR_NUM_RELATIONS (19) /** Meta-data names for the MDS CSSM relation **/ #define MDS_CDSADIR_CSSM_NUM_ATTRIBUTES (5) /** Meta-data names for the MDS KRMM relation **/ #define MDS_CDSADIR_KRMM_NUM_ATTRIBUTES (6) /** Meta-data names for the MDS EMM relation **/ #define MDS_CDSADIR_EMM_NUM_ATTRIBUTES (11) /** Meta-data names for the MDS Common relation **/ #define MDS_CDSADIR_COMMON_NUM_ATTRIBUTES (9) /** Meta-data names for the MDS CSP Primary relation **/ #define MDS_CDSADIR_CSP_PRIMARY_NUM_ATTRIBUTES (13) /** Meta-data names for the MDS CSP Capabilities relation **/ #define MDS_CDSADIR_CSP_CAPABILITY_NUM_ATTRIBUTES (9) /** Meta-data names for the MDS CSP Encapsulated Product relation **/ #define MDS_CDSADIR_CSP_ENCAPSULATED_PRODUCT_NUM_ATTRIBUTES (16) /** Meta-data names for the MDS CSP SmartcardInfo relation **/ #define MDS_CDSADIR_CSP_SC_INFO_NUM_ATTRIBUTES (9) /** Meta-data names for the MDS DL Primary relation **/ #define MDS_CDSADIR_DL_PRIMARY_NUM_ATTRIBUTES (13) /** Meta-data names for the MDS DL Encapsulated Product relation **/ #define MDS_CDSADIR_DL_ENCAPSULATED_PRODUCT_NUM_ATTRIBUTES (10) /** Meta-data names for the MDS CL Primary relation **/ #define MDS_CDSADIR_CL_PRIMARY_NUM_ATTRIBUTES (13) /** Meta-data names for the MDS CL Encapsulated Product relation **/ #define MDS_CDSADIR_CL_ENCAPSULATED_PRODUCT_NUM_ATTRIBUTES (8) /** Meta-data names for the MDS TP Primary relation **/ #define MDS_CDSADIR_TP_PRIMARY_NUM_ATTRIBUTES (10) /** Meta-data names for the MDS TP Policy-OIDS relation **/ #define MDS_CDSADIR_TP_OIDS_NUM_ATTRIBUTES (4) /** Meta-data names for the MDS TP Encapsulated Product relation **/ #define MDS_CDSADIR_TP_ENCAPSULATED_PRODUCT_NUM_ATTRIBUTES (13) /** Meta-data names for MDS EMM Service Provider Primary relation **/ #define MDS_CDSADIR_EMM_PRIMARY_NUM_ATTRIBUTES (11) /** Meta-data names for MDS AC Primary relation **/ #define MDS_CDSADIR_AC_PRIMARY_NUM_ATTRIBUTES (6) /** Meta-data names for the MDS KR relation **/ #define MDS_CDSADIR_KR_PRIMARY_RELATION_NUM_ATTRIBUTES (8)

/** Meta-data names for MDS Schema relation **/ #define MDS_CDSADIR_SCHEMA_RELATONS_NUM_ATTRIBUTES (2) #define MDS_CDSADIR_SCHEMA_ATTRIBUTES_NUM_ATTRIBUTES (6) #define MDS_CDSADIR_SCHEMA_INDEXES_NUM_ATTRIBUTES (5)

Data Structure

MDS defines a small number of data structures that are visible to the user through the MDS APIs. MDS type definitions are dependent on CDSA type definitions. These type are re-qualified as MDS data types to separate the MDS type space from CSSM and DL name spaces.

MDS_HANDLE

This defines an opaque handle used to identify the MDS context in which a user can receive MDS services.


typedef CSSM_DL_HANDLE     MDS_HANDLE;

MDS_DB_HANDLE

This defines an opaque handle used to identify an MDS-managed database.


typedef CSSM_DL_DB_HANDLE    MDS_DB_HANDLE;

MDS_FUNC

This structure defines a table of function pointer returned by MDS to a user when a service context has been established between MDS and a user. The user accesses MDS services through these function pointers.


typedef struct mds_funcs {
    CSSM_RETURN (CSSMAPI *DbOpen)
        (MDS_HANDLE MdsHandle,
        const char *DbName,
        const CSSM_NET_ADDRESS *DbLocation,
        CSSM_DB_ACCESS_TYPE AccessRequest,
        const CSSM_ACCESS_CREDENTIALS *AccessCred,
        const void *OpenParameters,
        CSSM_DB_HANDLE *hMds);
    CSSM_RETURN (CSSMAPI *DbClose)
        (MDS_DB_HANDLE MdsDbHandle);
    CSSM_RETURN (CSSMAPI *GetDbNames)
        (MDS_HANDLE MdsHandle,
        CSSM_NAME_LIST_PTR *NameList);
    CSSM_RETURN (CSSMAPI *GetDbNameFromHandle)
        (MDS_DB_HANDLE MdsDbHandle,
        char **DbName);
    CSSM_RETURN (CSSMAPI *FreeNameList)
        (MDS_HANDLE MdsHandle,
        CSSM_NAME_LIST_PTR NameList);
    CSSM_RETURN (CSSMAPI *DataInsert)
        (MDS_DB_HANDLE MdsDbHandle,
        CSSM_DB_RECORDTYPE RecordType,
        const CSSM_DB_RECORD_ATTRIBUTE_DATA *Attributes,
        const CSSM_DATA *Data,
        CSSM_DB_UNIQUE_RECORD_PTR *UniqueId);
    CSSM_RETURN (CSSMAPI *DataDelete)
        (MDS_DB_HANDLE MdsDbHandle,
        const CSSM_DB_UNIQUE_RECORD *UniqueRecordIdentifier);
    CSSM_RETURN (CSSMAPI *DataModify)
        (MDS_DB_HANDLE MdsDbHandle,
        CSSM_DB_RECORDTYPE RecordType,
        CSSM_DB_UNIQUE_RECORD_PTR UniqueRecordIdentifier,
        const CSSM_DB_RECORD_ATTRIBUTE_DATA *AttributesToBeModified,
        const CSSM_DATA *DataToBeModified,
        CSSM_DB_MODIFY_MODE ModifyMode);
    CSSM_RETURN (CSSMAPI *DataGetFirst)
        (MDS_DB_HANDLE MdsDbHandle,
        const CSSM_QUERY *Query,
        CSSM_HANDLE_PTR ResultsHandle,
        CSSM_DB_RECORD_ATTRIBUTE_DATA_PTR Attributes,
        CSSM_DATA_PTR Data,
        CSSM_DB_UNIQUE_RECORD_PTR *UniqueId);
    CSSM_RETURN (CSSMAPI *DataGetNext)
        (MDS_DB_HANDLE MdsDbHandle,
        CSSM_HANDLE ResultsHandle,
        CSSM_DB_RECORD_ATTRIBUTE_DATA_PTR Attributes,
        CSSM_DATA_PTR Data,
        CSSM_DB_UNIQUE_RECORD_PTR *UniqueId);
    CSSM_RETURN (CSSMAPI *DataAbortQuery)
        (MDS_DB_HANDLE MdsDbHandle,
        CSSM_HANDLE ResultsHandle);
    CSSM_RETURN (CSSMAPI *DataGetFromUniqueRecordId)
        (MDS_DB_HANDLE MdsDbHandle,
        const CSSM_DB_UNIQUE_RECORD_PTR UniqueRecord,
        CSSM_DB_RECORD_ATTRIBUTE_DATA_PTR Attributes,
        CSSM_DATA_PTR Data);
    CSSM_RETURN (CSSMAPI *FreeUniqueRecord)
        (MDS_DB_HANDLE MdsDbHandle,
        CSSM_DB_UNIQUE_RECORD_PTR UniqueRecord);
    CSSM_RETURN (CSSMAPI *CreateRelation)
        (MDS_DB_HANDLE MdsDbHandle,
        CSSM_DB_RECORDTYPE RelationID,
        const char *RelationName,
        uint32 NumberOfAttributes,
        const CSSM_DB_SCHEMA_ATTRIBUTE_INFO *pAttributeInfo,
        uint32 NumberOfIndexes,
        const CSSM_DB_SCHEMA_INDEX_INFO *pIndexInfo);
    CSSM_RETURN (CSSMAPI *DestroyRelation)
        (MDS_DB_HANDLE MdsDbHandle,
        CSSM_DB_RECORDTYPE RelationID);
} MDS_FUNCS, *MDS_FUNCS_PTR;

Contents

Next section

Index