git.sur5r.net Git - openldap/blob - servers/slapd/schema/duaconf.schema

   1 # $OpenLDAP$
   2 ## This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3 ##
   4 ## Copyright 1998-2004 The OpenLDAP Foundation.
   5 ## All rights reserved.
   6 ##
   7 ## Redistribution and use in source and binary forms, with or without
   8 ## modification, are permitted only as authorized by the OpenLDAP
   9 ## Public License.
  10 ##
  11 ## A copy of this license is available in the file LICENSE in the
  12 ## top-level directory of the distribution or, alternatively, at
  13 ## <http://www.OpenLDAP.org/license.html>.
  14
  15 ## Notes:
  16 ## - The matching rule for attributes followReferrals and dereferenceAliases
  17 ##   has been changed to booleanMatch since their syntax is boolean
  18 ## - There was a typo in the name of the dereferenceAliases attributeType
  19 ##   in the DUAConfigProfile objectClass definition
  20 ## - Credit goes to the original Authors
  21
  22 #
  23 # Application Working Group                                      M. Ansari
  24 # INTERNET-DRAFT                                    Sun Microsystems, Inc.
  25 # Expires Febuary 2003                                           L. Howard
  26 #                                                  PADL Software Pty. Ltd.
  27 #                                                          B. Joslin [ed.]
  28 #                                                  Hewlett-Packard Company
  29 #
  30 #                                                     September 15th, 2003
  31 # Intended Category: Informational
  32 #
  33 #
  34 #                  A Configuration Schema for LDAP Based
  35 #                          Directory User Agents
  36 #                   <draft-joslin-config-schema-07.txt>
  37 #
  38 #Status of this Memo
  39 #
  40 #    This memo provides information for the Internet community.  This
  41 #    memo does not specify an Internet standard of any kind.  Distribu-
  42 #    tion of this memo is unlimited.
  43 #
  44 #    This document is an Internet-Draft and is in full conformance with
  45 #    all provisions of Section 10 of RFC2026.
  46 #
  47 #    This document is an Internet-Draft. Internet-Drafts are working
  48 #    documents of the Internet Engineering Task Force (IETF), its areas,
  49 #    and its working groups. Note that other groups may also distribute
  50 #    working documents as Internet-Drafts.
  51 #
  52 #    Internet-Drafts are draft documents valid for a maximum of six
  53 #    months.  Internet-Drafts may be updated, replaced, or made obsolete
  54 #    by other documents at any time. It is not appropriate to use
  55 #    Internet-Drafts as reference material or to cite them other than as
  56 #    a "working draft" or "work in progress".
  57 #
  58 #    To learn the current status of any Internet-Draft, please check the
  59 #    1id-abstracts.txt listing contained in the Internet-Drafts Shadow
  60 #    Directories on ds.internic.net (US East Coast), nic.nordu.net
  61 #    (Europe), ftp.isi.edu (US West Coast), or munnari.oz.au (Pacific
  62 #    Rim).
  63 #
  64 #    Distribution of this document is unlimited.
  65 #
  66 #
  67 # Abstract
  68 #
  69 #      This document describes a mechanism for global configuration of
  70 #      similar directory user agents.  This document defines a schema for
  71 #      configuration of these DUAs that may be discovered using the Light-
  72 #      weight Directory Access Protocol in RFC 2251[17].  A set of attri-
  73 #      bute types and an objectclass are proposed, along with specific
  74 #      guidelines for interpreting them.  A significant feature of the
  75 #      global configuration policy for DUAs is a mechanism that allows
  76 #      DUAs to re-configure their schema to that of the end user's
  77 #      environment.  This configuration is achieved through attribute and
  78 #      objectclass mapping.  This document is intended to be a skeleton
  79 #      for future documents that describe configuration of specific DUA
  80 #      services.
  81 #
  82 #
  83 # [trimmed]
  84 #
  85 #
  86 # 2.  General Issues
  87 #
  88 #      The schema defined by this document is defined under the "DUA Con-
  89 #      figuration Schema."  This schema is derived from the OID: iso (1)
  90 #      org (3) dod (6) internet (1) private (4) enterprises (1) Hewlett-
  91 #      Packard Company (11) directory (1) LDAP-UX Integration Project (3)
  92 #      DUA Configuration Schema (1).  This OID is represented in this
  93 #      document by the keystring "DUAConfSchemaOID"
  94 #      (1.3.6.1.4.1.11.1.3.1).
  95 objectidentifier DUAConfSchemaOID 1.3.6.1.4.1.11.1.3.1
  96 #
  97 # 2.2 Attributes
  98 #
  99 #      The attributes and classes defined in this document are summarized
 100 #      below.
 101 #
 102 #      The following attributes are defined in this document:
 103 #
 104 #           preferredServerList
 105 #           defaultServerList
 106 #           defaultSearchBase
 107 #           defaultSearchScope
 108 #           authenticationMethod
 109 #           credentialLevel
 110 #           serviceSearchDescriptor
 111 #
 112 #
 113 #
 114 # Joslin                                                         [Page 3]
 115 # Internet-Draft          DUA Configuration Schema            October 2002
 116 #
 117 #
 118 #           serviceCredentialLevel
 119 #           serviceAuthenticationMethod
 120 #           attributeMap
 121 #           objectclassMap
 122 #           searchTimeLimit
 123 #           bindTimeLimit
 124 #           followReferrals
 125 #           dereferenceAliases
 126 #           profileTTL
 127 #
 128 # 2.3 Object Classes
 129 #
 130 #      The following object class is defined in this document:
 131 #
 132 #           DUAConfigProfile
 133 #
 134 #
 135 attributeType ( DUAConfSchemaOID:1.0 NAME 'defaultServerList'
 136             DESC 'Default LDAP server host address used by a DUA'
 137             EQUALITY caseIgnoreMatch
 138             SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
 139             SINGLE-VALUE )
 140
 141 attributeType ( DUAConfSchemaOID:1.1 NAME 'defaultSearchBase'
 142             DESC 'Default LDAP base DN used by a DUA'
 143             EQUALITY distinguishedNameMatch
 144             SYNTAX 1.3.6.1.4.1.1466.115.121.1.12
 145             SINGLE-VALUE )
 146
 147 attributeType ( DUAConfSchemaOID:1.2 NAME 'preferredServerList'
 148             DESC 'Preferred LDAP server host addresses to be used by a
 149             DUA'
 150             EQUALITY caseIgnoreMatch
 151             SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
 152             SINGLE-VALUE )
 153
 154 attributeType ( DUAConfSchemaOID:1.3 NAME 'searchTimeLimit'
 155             DESC 'Maximum time in seconds a DUA should allow for a
 156             search to complete'
 157             EQUALITY integerMatch
 158             SYNTAX 1.3.6.1.4.1.1466.115.121.1.27
 159             SINGLE-VALUE )
 160
 161 attributeType ( DUAConfSchemaOID:1.4 NAME 'bindTimeLimit'
 162             DESC 'Maximum time in seconds a DUA should allow for the
 163             bind operation to complete'
 164             EQUALITY integerMatch
 165             SYNTAX 1.3.6.1.4.1.1466.115.121.1.27
 166             SINGLE-VALUE )
 167
 168 attributeType ( DUAConfSchemaOID:1.5 NAME 'followReferrals'
 169             DESC 'Tells DUA if it should follow referrals
 170             returned by a DSA search result'
 171             EQUALITY booleanMatch
 172             SYNTAX 1.3.6.1.4.1.1466.115.121.1.7
 173             SINGLE-VALUE )
 174
 175 attributeType ( DUAConfSchemaOID:1.16 NAME 'dereferenceAliases'
 176             DESC 'Tells DUA if it should dereference aliases'
 177             EQUALITY booleanMatch
 178             SYNTAX 1.3.6.1.4.1.1466.115.121.1.7
 179             SINGLE-VALUE )
 180
 181 attributeType ( DUAConfSchemaOID:1.6 NAME 'authenticationMethod'
 182             DESC 'A keystring which identifies the type of
 183             authentication method used to contact the DSA'
 184             EQUALITY caseIgnoreMatch
 185             SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
 186             SINGLE-VALUE )
 187
 188 attributeType ( DUAConfSchemaOID:1.7 NAME 'profileTTL'
 189             DESC 'Time to live, in seconds, before a client DUA
 190             should re-read this configuration profile'
 191             EQUALITY integerMatch
 192             SYNTAX 1.3.6.1.4.1.1466.115.121.1.27
 193             SINGLE-VALUE )
 194
 195 attributeType ( DUAConfSchemaOID:1.14 NAME 'serviceSearchDescriptor'
 196             DESC 'LDAP search descriptor list used by a DUA'
 197             EQUALITY caseExactMatch
 198             SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )
 199
 200 attributeType ( DUAConfSchemaOID:1.9 NAME 'attributeMap'
 201             DESC 'Attribute mappings used by a DUA'
 202             EQUALITY caseIgnoreIA5Match
 203             SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
 204
 205 attributeType ( DUAConfSchemaOID:1.10 NAME 'credentialLevel'
 206             DESC 'Identifies type of credentials a DUA should
 207             use when binding to the LDAP server'
 208             EQUALITY caseIgnoreIA5Match
 209             SYNTAX 1.3.6.1.4.1.1466.115.121.1.26
 210             SINGLE-VALUE )
 211
 212 attributeType ( DUAConfSchemaOID:1.11 NAME 'objectclassMap'
 213             DESC 'Objectclass mappings used by a DUA'
 214             EQUALITY caseIgnoreIA5Match
 215             SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
 216
 217 attributeType ( DUAConfSchemaOID:1.12 NAME 'defaultSearchScope'
 218             DESC 'Default search scope used by a DUA'
 219             EQUALITY caseIgnoreIA5Match
 220             SYNTAX 1.3.6.1.4.1.1466.115.121.1.26
 221             SINGLE-VALUE )
 222
 223 attributeType ( DUAConfSchemaOID:1.13 NAME 'serviceCredentialLevel'
 224             DESC 'Identifies type of credentials a DUA
 225             should use when binding to the LDAP server for a
 226             specific service'
 227             EQUALITY caseIgnoreIA5Match
 228             SYNTAX 1.3.6.1.4.1.1466.115.121.1.26 )
 229
 230 attributeType ( DUAConfSchemaOID:1.15 NAME 'serviceAuthenticationMethod'
 231             DESC 'Authentication method used by a service of the DUA'
 232             EQUALITY caseIgnoreMatch
 233             SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )
 234 #
 235 # 4.  Class Definition
 236 #
 237 #      The objectclass below is constructed from the attributes defined in
 238 #      3, with the exception of the cn attribute, which is defined in RFC
 239 #      2256 [8].  cn is used to represent the name of the DUA configura-
 240 #      tion profile.
 241 #
 242 objectClass ( DUAConfSchemaOID:2.5 NAME 'DUAConfigProfile'
 243           SUP top STRUCTURAL
 244           DESC 'Abstraction of a base configuration for a DUA'
 245           MUST ( cn )
 246           MAY ( defaultServerList $ preferredServerList $
 247                 defaultSearchBase $ defaultSearchScope $
 248                 searchTimeLimit $ bindTimeLimit $
 249                 credentialLevel $ authenticationMethod $
 250                 followReferrals $ dereferenceAliases $
 251                 serviceSearchDescriptor $ serviceCredentialLevel $
 252                 serviceAuthenticationMethod $ objectclassMap $
 253                 attributeMap $ profileTTL ) )