Netscape NETSCAPE DIRECTORY SERVER 6.02 - PLUG-IN Manuel utilisateur

Plug-In Programmer’s Guide

Netscape Directory Server

Version6.02

May 2002

Netscape Communications Corporation (“Netscape”) and its licensors retain all ownership rights to the software programs offered

by Netscape (referred to herein as “Software”) and related documentation. Use of the Software and related documentation is

governed by the license agreement for the Software and applicable copyright law.

Your right to copy this documentation is limited by copyright law. Making unauthorized copies, adaptations or compilation works is

prohibited and constitutes a punishable violation of the law. Netscape may revise this documentation from time to time without

notice.

THIS DOCUMENTATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN NO EVENT SHALL NETSCAPE BE

LIABLE FOR INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY KIND ARISING FROM ANY

ERROR IN THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION ANY LOSS OR INTERRUPTION OF BUSINESS,

PROFITS, USE, OR DATA.

rights reserved.

Netscape and the Netscape N logo are registered trademarks of Netscape Communications Corporation in the United States and

other countries. Other Netscape logos, product names, and service names are also trademarks of Netscape Communications

Corporation, which may be registered in other countries. Other product and brand names are the exclusive property of their

respective owners.

The downloading, exporting, or reexporting of Netscape software or any underlying information or technology must be in full

compliance with all United States and other applicable laws and regulations. Any provision of Netscape software or documentation

to the U.S. government is with restricted rights as described in the license agreement for that Software.

Contents

Preface .......................................................................11

WhatYouShouldAlreadyKnow......................................................... 11

UsingDirectoryServerPlug-InAPIs...................................................... 11

DocumentConventions ................................................................. 13

WheretoFindDirectoryServerInformation ............................................... 14

Part 1 Introduction to Directory Server Plug-Ins . . . . . . . . . . . ...................... 17

Chapter 1 AnOverviewofDirectoryServerPlug-Ins................................19

WhatAreDirectoryServerPlug-Ins? ..................................................... 19

HowDirectoryServerPlug-InsWork ..................................................... 20

CallingDirectoryServerPlug-InFunctions ............................................. 21

TheDirectoryServerArchitecture ..................................................... 21

TypesofDirectoryServerPlug-Ins ....................................................... 24

Chapter 2 Writing and Compiling Plug-Ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

WritingaPlug-InFunction .............................................................. 27

IncludingtheAPIHeaderFile......................................................... 28

PassingDatawithParameterBlocks ................................................... 28

WorkingwithParameterBlocks ....................................................... 29

GettingDatafromtheParameterBlock .............................................. 29

SettingDataintheParameterBlock ................................................. 30

CallingFront-EndFunctions .......................................................... 31

Plug-inReturnValues................................................................ 31

WritingPlug-inInitializationFunctions ................................................... 32

InitializationFunctionsforWindowsPlatforms ....................................... 32

SpecifyingDirectoryServerCompatibility .............................................. 33

SpecifyingInformationAboutthePlug-In .............................................. 33

4 Netscape Directory Server Plug-In Programmer’s Guide • May 2002

RegisteringYourPlug-InFunctions .................................................... 34

ReturningaValuetotheDirectoryServer............................................... 35

ExampleofanInitializationFunction .................................................. 35

CompilingaDirectoryServerPlug-In..................................................... 36

Chapter 3 Configuring Plug-Ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

CreatingaPlug-InConfigurationFile ..................................................... 39

Plug-InDependencies................................................................ 41

SpecificPlug-inDependencies ...................................................... 41

Plug-InTypeDependencies ........................................................ 42

SpecifyingtheOrderofPlug-InDirectives .............................................. 42

SummaryofPlug-InDirectives........................................................ 43

LoadingthePlug-InConfigurationFile ................................................... 44

PassingExtraArgumentstoPlug-Ins ..................................................... 45

SettingtheLogLeveloftheServer........................................................ 46

Chapter 4 AQuickExample ................................................... 47

AnExamplePre-OperationPlug-In....................................................... 47

WritingthePlug-InExample.......................................................... 48

Compiling the Plug-In Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

RegisteringthePlug-InExample....................................................... 52

RunningthePlug-InExample ......................................................... 53

Part 2 BasicPlug-InProgrammingTechniques ..................................55

Chapter 5 Front-End API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

LoggingMessages...................................................................... 58

AddingNotestoAccessLogEntries ...................................................... 58

SendingDatatotheClient............................................................... 59

DeterminingifanOperationWasAbandoned ............................................. 59

WorkingwithEntries,Attributes,andValues .............................................. 60

CreatingaNewEntry ................................................................ 61

ConvertingBetweenEntriesandStrings ................................................ 61

GettingandSettingtheDNofanEntry................................................. 62

VerifyingCompliancewiththeSchema................................................. 62

GettingtheAttributesandValuesofanEntry ........................................... 63

IteratingThroughtheAttributesinanEntry.......................................... 63

FindingaSpecificAttributeinanEntry .............................................. 63

Adding and Removing Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

WorkingwithDNsandRDNs ........................................................... 64

DeterminingifaDNistheRootDN ................................................... 64

WorkingwithDNSuffixes............................................................ 65

ServerSuffixes ................................................................... 65

GettingtheParentDNofaDN ........................................................ 65

NormalizingaDN................................................................... 65

WorkingwithSearchFilters ............................................................. 66

DeterminingifanEntryMatchesaFilter................................................ 67

GettingtheFilterType ............................................................... 67

GettingtheSearchCriteria............................................................ 68

ConvertingaStringtoaFilter ......................................................... 69

CreatingComplexFiltersbyCombiningFilters.......................................... 69

CheckingPasswords.................................................................... 69

Chapter 6 WritingPre/Post-OperationPlug-Ins ....................................71

HowPre/Post-OperationPlug-InsWork .................................................. 71

TypesPre-OperationandPost-OperationFunctions ........................................ 73

TypesofPre-OperationFunctions ..................................................... 73

TypesofPost-OperationFunctions..................................................... 74

RegisteringPre/Post-OperationFunctions................................................. 76

Chapter 7 Defining Functions for LDAP Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

SpecifyingStartandCloseFunctions...................................................... 78

ProcessinganLDAPBindOperation...................................................... 78

DefiningFunctionsfortheBindOperation.............................................. 78

GettingandSettingParametersfortheBindOperation ................................... 79

ProcessinganLDAPUnbindOperation ................................................... 79

ProcessinganLDAPSearchOperation .................................................... 80

Getting the List of Candidates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

IteratingThroughCandidates ......................................................... 82

ProcessinganLDAPCompareOperation.................................................. 84

ProcessinganLDAPAddOperation...................................................... 84

ProcessinganLDAPModifyOperation ................................................... 86

ProcessinganLDAPModifyRDNOperation .............................................. 87

ProcessinganLDAPDeleteOperation .................................................... 89

ProcessinganLDAPAbandonOperation ................................................. 89

Chapter 8 Defining Functions for Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

UnderstandingAuthenticationMethods .................................................. 91

HowtheDirectoryServerIdentifiesClients................................................ 92

HowtheAuthenticationProcessWorks ................................................... 92

WritingYourOwnAuthenticationPlug-in ................................................ 95

WritingaPre-OperationBindPlug-in..................................................... 95

DefiningYourAuthenticationFunction ................................................ 97

6 Netscape Directory Server Plug-In Programmer’s Guide • May 2002

GettingandCheckingtheBindParameters........................................... 97

GettingtheEntryandCheckingtheCredentials....................................... 98

WhattoDoIfAuthenticationFails .................................................. 99

WhattoDoIfAuthenticationSucceeds .............................................. 99

RegisteringtheSASLMechanism..................................................... 100

ExampleofaPre-OperationBindPlug-In .............................................. 101

ExampleofaPre-OperationBindFunction .......................................... 101

ExampleofanInitializationFunction ............................................... 104

RegisteringthePlug-In ........................................................... 105

Using SASL with an LDAP Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Part 3 AdvancedProgrammingTechniques ....................................111

Chapter 9 WritingEntryStore/FetchPlug-Ins.................................... 113

HowEntryStore/FetchPlug-InsWork................................................... 113

WritingEntryStore/FetchFunctions .................................................... 114

RegisteringEntryStore/FetchFunctions ................................................. 115

Chapter 10 WritingExtendedOperationPlug-Ins................................. 117

HowExtendedOperationPlug-InsWork................................................. 117

WritingExtendedOperationFunctions .................................................. 118

RegisteringExtendedOperationFunctions ............................................... 119

SpecifyingStartandCloseFunctions..................................................... 121

Chapter 11 WritingMatchingRulePlug-Ins ..................................... 123

UnderstandingMatchingRules ......................................................... 123

ExtensibleMatchFilters ............................................................. 124

ExtensibleMatchFiltersintheDirectoryServer ........................................ 125

UnderstandingMatchingRulePlug-Ins .................................................. 125

FunctionsDefinedinMatchingRulePlug-Ins .......................................... 125

HowMatchingRulesAreIdentified................................................... 126

HowtheServerAssociatesPlug-InswithOIDs ......................................... 127

FindingaPlug-InforIndexing..................................................... 127

FindingaPlug-InforSearching .................................................... 128

HowtheServerUsesParameterBlocks ................................................ 129

IndexingBasedonMatchingRules ...................................................... 129

HowtheServerSetsUptheIndex .................................................... 129

HowtheServerUpdatestheIndex.................................................... 130

WritingtheIndexerFactoryFunction ................................................. 131

GettingandSettingParametersinIndexerFactoryFunctions............................. 132

WritingtheIndexerFunction ........................................................ 133

GettingandSettingParametersinIndexerFunctions .................................... 134

HandlingExtensibleMatchFilters....................................................... 134

HowtheServerHandlestheFilter .................................................... 135

QueryOperatorsinMatchingRules................................................... 136

WritingaFilterFactoryFunction ..................................................... 137

GettingandSettingParametersinFilterFactoryFunctions ............................... 138

WritingaFilterIndexFunction....................................................... 139

GettingandSettingParametersinFilterIndexFunctions ................................ 140

WritingaFilterMatchingFunction ................................................... 141

HandlingSortingbyMatchingRules .................................................... 142

WritingaDestructorFunction .......................................................... 143

WritinganInitializationFunction ....................................................... 143

RegisteringMatchingRuleFunctions .................................................... 145

SpecifyingStartandCloseFunctions..................................................... 146

Chapter 12 Using the Custom Distribution Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

AboutDistributingFlatNamespaces..................................................... 147

CreatingaDistributionFunction ........................................................ 148

AddingtheDistributionFunctiontoYourDirectory ....................................... 150

Adding Multiple Databases to a Single Suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

UsingtheConsole ............................................................... 151

FromtheCommand-Line ......................................................... 151

Adding Distribution Logic to a Suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

UsingtheConsole ............................................................... 152

FromtheCommand-Line ......................................................... 152

UsingtheDistributionLogicExamples................................................... 153

CustomDistributionChecklist .......................................................... 154

Part 4 Reference .......................................................... 155

Chapter 13 DataTypeandStructureReference...................................157

SummaryofDataTypesandStructures .................................................. 157

Chapter 14 FunctionReference ................................................175

DistributionRoutines.................................................................. 176

FunctionsforAccessControl ........................................................... 177

FunctionsforInternalOperationsandPlug-InCallback .................................... 184

FunctionsforSettingInternalOperationFlags ............................................ 192

FunctionsforHandlingAttributes....................................................... 203

FunctionsforManagingBackendOperations ............................................. 222

FunctionsforDealingwithControls ..................................................... 239

8 Netscape Directory Server Plug-In Programmer’s Guide • May 2002

FunctionsforSyntaxPlug-In............................................................ 246

FunctionsforManagingMemory........................................................ 250

FunctionsforManagingDNs ........................................................... 257

FunctionsforManagingEntries ......................................................... 265

FunctionsRelatedtoEntryFlags ........................................................ 303

FunctionsforDealingwithFilters ....................................................... 306

FunctionsSpecifictoExtendedOperation ................................................ 324

FunctionsSpecifictoBindMethods...................................................... 325

FunctionsforThread-SafeLDAPConnections ............................................ 326

FunctionsforLogging ................................................................. 329

FunctionsforHandlingMatchingRules.................................................. 332

FunctionsforLDAPModManipulation .................................................. 340

FunctionsforMonitoringOperations .................................................... 373

FunctionsforManagingParameterBlock................................................. 375

FunctionsforHandlingPasswords ...................................................... 380

FunctionsforManagingRDN........................................................... 383

FunctionsforManagingRoles .......................................................... 404

FunctionsforManagingDNs ........................................................... 405

FunctionsforSendingEntriesandResultstotheClient..................................... 429

FunctionsRelatedtoUTF-8............................................................. 434

FunctionsforHandlingValues.......................................................... 447

FunctionsforHandlingValueset ........................................................ 467

FunctionsSpecifictoVirtualAttributeService ............................................ 476

FunctionsforManagingLocksandSynchronization ....................................... 479

FunctionsforManipulatingBits......................................................... 485

FunctionsforRegisteringObjectExtensions .............................................. 489

Chapter 15 ParameterBlockReference......................................... 493

ParametersforRegisteringPlug-InFunctions ............................................. 494

Pre-Operation/DataValidationPlug-Ins .............................................. 494

Post-Operation/DataNotificationPlug-Ins ............................................ 495

ExtendedOperationPlug-Ins ........................................................ 496

MatchingRulePlug-Ins ............................................................. 497

ParametersAccessibletoAllPlug-Ins .................................................... 497

InformationAbouttheDatabase...................................................... 498

InformationAbouttheConnection.................................................... 499

InformationAbouttheOperation..................................................... 500

NotesintheAccessLog ............................................................. 501

InformationAboutthePlug-In ....................................................... 502

TypesofPlug-Ins ................................................................ 503

VersionInformation.............................................................. 503

ParametersfortheConfigurationFunction ............................................... 504

ParametersfortheBindFunction........................................................ 504

ParametersfortheSearchFunction ...................................................... 505

ParametersfortheAddFunction........................................................ 507

ParametersfortheCompareFunction.................................................... 508

ParametersfortheDeleteFunction ...................................................... 508

ParametersfortheModifyFunction ..................................................... 509

ParametersfortheModifyRDNFunction ................................................ 510

ParametersfortheAbandonFunction.................................................... 511

ParametersforExtendedOperations..................................................... 511

ParametersforInternalLDAPOperations ................................................ 512

Glossary.....................................................................513

Index........................................................................517

10 Netscape Directory Server Plug-In Programmer’s Guide • May 2002

Ce manuel convient aux modèles suivants

Table des matières

Autres manuels Netscape Serveur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.2 -... Manuel de service

Netscape

Netscape NETSCAPE DIRECTORY SERVER 7.0 Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.01 Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.0 - DEPLOYMENT Guide de référence rapide

Netscape

Netscape NETSCAPE DIRECTORY SERVER 7.0 Manuel de service

Netscape

Netscape NETSCAPE ENTERPRISE SERVER 6.0 - PROGRAMMER GUIDE TO... Manuel

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.01 Manuel de service

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.0 Manuel utilisateur

Netscape

Netscape NETSCAPE CONSOLE 6.0 - MANAGING SERVERS Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.02 Manuel de service

Netscape

Netscape NETSCAPE ENTERPRISE SERVER 6.0 - NSAPI PROGRAMMER... Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.01 Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.02 Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.01 - DEPLOYMENT Guide de référence rapide

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.2 - DEPLOYMENT Guide de référence rapide

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.2 - PLUG-IN Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 7.0 - DEPLOYMENT Guide de référence rapide

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.01 - PLUG-IN Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.0 Manuel utilisateur

Netscape

Netscape NETSCAPE ENTREPRISE SERVER 6.1 - INSTALLATION AND MIGRATION... Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 7.0 - PLUG-IN Manuel utilisateur

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY... Manuel de service

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.02 - DEPLOYMENT Guide de référence rapide

Netscape

Netscape NETSCAPE ENTREPRISE SERVER 6.0 -... Manuel de service

Manuels Serveur populaires d'autres marques

HP AlphaServer ES47 Manuel utilisateur

Dell

Dell PowerEdge R410 Manuel utilisateur

PowerNAS

PowerNAS CMA Manuel utilisateur

Supero

Supero FatTwin F617R3-FT Manuel utilisateur

MSI

MSI P1-109N-L70 Manuel utilisateur

Dell

Dell PowerEdge XE9640 Manuel

Dell

Dell PS4100 Instructions de montage

EtroVISION

EtroVISION EV3151 Manuel utilisateur

NEC

NEC Express5800/T110j Manuel utilisateur

HP ProLiant Gen9 Manuel utilisateur

Compaq

Compaq ProLiant 3000 Manuel

Dell

Dell PowerEdge 3YPMN Manuel utilisateur

iRobo

iRobo IPC2U Manuel utilisateur

Nortel

Nortel 1000 Con?guration guide Manuel utilisateur

Asus

Asus AP7500 Manuel d'utilisation et d'entretien

Avid Technology

Avid Technology AirSpeed 5000 Manuel utilisateur

HP Integrity rx2600 Guide d'installation

Milestone

Milestone Husky IVO 350T Manuel utilisateur