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