1b1b4d261SWilliam A. Kennington IIIdescription: > 2*a1347418SPatrick Williams Implement to update LDAP mandatory properties. Any service implementing 3*a1347418SPatrick Williams User.Ldap.Config interface on one or more objects must implement 4*a1347418SPatrick Williams Object.Enable interface on the object. 5b1b4d261SWilliam A. Kennington III 6b1b4d261SWilliam A. Kennington IIIproperties: 7b1b4d261SWilliam A. Kennington III - name: LDAPServerURI 8b1b4d261SWilliam A. Kennington III type: string 9b1b4d261SWilliam A. Kennington III description: > 10b1b4d261SWilliam A. Kennington III Specifies the LDAP URI of the server to connect to. 11b1b4d261SWilliam A. Kennington III errors: 12b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InternalFailure 13b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InvalidArgument 14b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.NoCACertificate 15b1b4d261SWilliam A. Kennington III - name: LDAPBindDN 16b1b4d261SWilliam A. Kennington III type: string 17b1b4d261SWilliam A. Kennington III description: > 18b1b4d261SWilliam A. Kennington III Specifies the distinguished name with which to bind to the directory 19b1b4d261SWilliam A. Kennington III server for lookups. 20b1b4d261SWilliam A. Kennington III errors: 21b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InternalFailure 22b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InvalidArgument 23b1b4d261SWilliam A. Kennington III - name: LDAPBindDNPassword 24b1b4d261SWilliam A. Kennington III type: string 25b1b4d261SWilliam A. Kennington III description: > 26b1b4d261SWilliam A. Kennington III Specifies the credentials with which to bind,Implementation should 27*a1347418SPatrick Williams consider changing the permissions of the underlying file to only grant 28*a1347418SPatrick Williams access to the root user. This property value should not be reflected 29*a1347418SPatrick Williams on the D-bus object itself. Implementation can use the given value and 30*a1347418SPatrick Williams update the service implementing the LDAP client.This is just to 31*a1347418SPatrick Williams facilitate the support for changing the bin dn password if needed. 32*a1347418SPatrick Williams Currently this property is over D-bus, There are security concerns for 33*a1347418SPatrick Williams the same, but once we find better way to update the ldap password we 34*a1347418SPatrick Williams would fix it. 35b1b4d261SWilliam A. Kennington III - name: LDAPBaseDN 36b1b4d261SWilliam A. Kennington III type: string 37b1b4d261SWilliam A. Kennington III description: > 38b1b4d261SWilliam A. Kennington III Specifies the base distinguished name to use as search base. 39b1b4d261SWilliam A. Kennington III errors: 40b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InternalFailure 41b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InvalidArgument 42b1b4d261SWilliam A. Kennington III - name: LDAPSearchScope 43b1b4d261SWilliam A. Kennington III type: enum[self.SearchScope] 44b1b4d261SWilliam A. Kennington III description: > 45b1b4d261SWilliam A. Kennington III Specifies the search scope:subtree, one level or base object. 46b1b4d261SWilliam A. Kennington III default: sub 47b1b4d261SWilliam A. Kennington III errors: 48b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InternalFailure 49b1b4d261SWilliam A. Kennington III - name: LDAPType 50b1b4d261SWilliam A. Kennington III type: enum[self.Type] 51b1b4d261SWilliam A. Kennington III description: > 52b1b4d261SWilliam A. Kennington III Specifies the the configured server is ActiveDirectory(AD) or 53*a1347418SPatrick Williams OpenLdap. It's just an indication for the LDAP stack running on the 54*a1347418SPatrick Williams BMC, in case the app is implemented in such a way that it has to react 55*a1347418SPatrick Williams differently for AD vs openldap. This property is readonly, Once the 56*a1347418SPatrick Williams D-Bus object gets created then this property should not be modifiable. 57b1b4d261SWilliam A. Kennington III errors: 58b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.InternalFailure 59b1b4d261SWilliam A. Kennington III - xyz.openbmc_project.Common.Error.NotAllowed 60b1b4d261SWilliam A. Kennington III - name: GroupNameAttribute 61b1b4d261SWilliam A. Kennington III type: string 62b1b4d261SWilliam A. Kennington III description: > 63*a1347418SPatrick Williams The value of this property shall be the attribute name that contains 64*a1347418SPatrick Williams the name of the Group in the LDAP server. 65b1b4d261SWilliam A. Kennington III - name: UserNameAttribute 66b1b4d261SWilliam A. Kennington III type: string 67b1b4d261SWilliam A. Kennington III description: > 68*a1347418SPatrick Williams The value of this property shall be the attribute name that contains 69*a1347418SPatrick Williams the username in the LDAP server. 70b1b4d261SWilliam A. Kennington IIIenumerations: 71b1b4d261SWilliam A. Kennington III - name: SearchScope 72b1b4d261SWilliam A. Kennington III description: > 73b1b4d261SWilliam A. Kennington III Possible base scopes. 74b1b4d261SWilliam A. Kennington III values: 75b1b4d261SWilliam A. Kennington III - name: sub 76b1b4d261SWilliam A. Kennington III - name: one 77b1b4d261SWilliam A. Kennington III - name: base 78b1b4d261SWilliam A. Kennington III 79b1b4d261SWilliam A. Kennington III - name: Type 80b1b4d261SWilliam A. Kennington III description: > 81b1b4d261SWilliam A. Kennington III Possible LDAP Types. 82b1b4d261SWilliam A. Kennington III values: 83b1b4d261SWilliam A. Kennington III - name: ActiveDirectory 84b1b4d261SWilliam A. Kennington III - name: OpenLdap 85