reformat with latest settings
Reformat with the latest settings from openbmc-build-scripts (and
copy latest config files where appropriate). Fix a few minor
markdownlint issues.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I55205817c29dc3f182a165ddf9cd5d4e07b90063
diff --git a/yaml/xyz/openbmc_project/User/AccountPolicy.interface.yaml b/yaml/xyz/openbmc_project/User/AccountPolicy.interface.yaml
index b55b288..1cfc4bf 100644
--- a/yaml/xyz/openbmc_project/User/AccountPolicy.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/AccountPolicy.interface.yaml
@@ -5,18 +5,16 @@
- name: MaxLoginAttemptBeforeLockout
type: uint16
description: >
- Configures the maximum permissible attempt before locking
- out the user. Value of 0 indicates that account lockout
- feature is disabled.
+ Configures the maximum permissible attempt before locking out the
+ user. Value of 0 indicates that account lockout feature is disabled.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
- name: AccountUnlockTimeout
type: uint32
description: >
- Configures timeout needed (in seconds) to unlock the account
- after a lockout. Value of 0 indicates that account must be
- unlocked manually.
+ Configures timeout needed (in seconds) to unlock the account after a
+ lockout. Value of 0 indicates that account must be unlocked manually.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
@@ -25,8 +23,8 @@
description: >
Configures the minimum password length. Minimum password length
specified in build time is marked as default value. This property
- cannot be configured below the build time default value but can be
- set to higher one for security reasons.
+ cannot be configured below the build time default value but can be set
+ to higher one for security reasons.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
- xyz.openbmc_project.Common.Error.InvalidArgument
@@ -34,8 +32,8 @@
- name: RememberOldPasswordTimes
type: byte
description: >
- Configures the number of times old password shouldn't be allowed
- when trying to update new password. Value of 0 (by default) indicates
- this feature is not enforced.
+ Configures the number of times old password shouldn't be allowed when
+ trying to update new password. Value of 0 (by default) indicates this
+ feature is not enforced.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/User/Attributes.interface.yaml b/yaml/xyz/openbmc_project/User/Attributes.interface.yaml
index 50d1816..70ef629 100644
--- a/yaml/xyz/openbmc_project/User/Attributes.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Attributes.interface.yaml
@@ -1,7 +1,7 @@
description: >
- Provides user objects, their properties.
- As communication to this service is done through authenticated
- & authorized session, there won't be any validation for the both.
+ Provides user objects, their properties. As communication to this service is
+ done through authenticated & authorized session, there won't be any
+ validation for the both.
properties:
- name: UserGroups
@@ -30,12 +30,12 @@
- name: UserLockedForFailedAttempt
type: boolean
description: >
- Locked or unlocked state of the user. After repeated failed
- login attempt (configured through MaxLoginAttemptBeforeLockout),
- locked out user can be unlocked manually by setting false to
- this property. This property will return true if user is locked
- out user. AccountUnlockTimeout property can be configured to unlock
- the user after a timeout.
+ Locked or unlocked state of the user. After repeated failed login
+ attempt (configured through MaxLoginAttemptBeforeLockout), locked out
+ user can be unlocked manually by setting false to this property. This
+ property will return true if user is locked out user.
+ AccountUnlockTimeout property can be configured to unlock the user
+ after a timeout.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
@@ -53,7 +53,7 @@
flags:
- const
description: >
- True when the user's password must be changed before access should
- be granted.
+ True when the user's password must be changed before access should be
+ granted.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml b/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
index 75a7695..d0fc5ee 100644
--- a/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Ldap/Config.interface.yaml
@@ -1,7 +1,7 @@
description: >
- Implement to update LDAP mandatory properties.
- Any service implementing User.Ldap.Config interface on one or more
- objects must implement Object.Enable interface on the object.
+ Implement to update LDAP mandatory properties. Any service implementing
+ User.Ldap.Config interface on one or more objects must implement
+ Object.Enable interface on the object.
properties:
- name: LDAPServerURI
@@ -24,15 +24,14 @@
type: string
description: >
Specifies the credentials with which to bind,Implementation should
- consider changing the permissions of the underlying file to
- only grant access to the root user.
- This property value should not be reflected on the D-bus object itself.
- Implementation can use the given value and update the service
- implementing the LDAP client.This is just to facilitate the support
- for changing the bin dn password if needed.
- Currently this property is over D-bus, There are security concerns
- for the same, but once we find better way to update the ldap password
- we would fix it.
+ consider changing the permissions of the underlying file to only grant
+ access to the root user. This property value should not be reflected
+ on the D-bus object itself. Implementation can use the given value and
+ update the service implementing the LDAP client.This is just to
+ facilitate the support for changing the bin dn password if needed.
+ Currently this property is over D-bus, There are security concerns for
+ the same, but once we find better way to update the ldap password we
+ would fix it.
- name: LDAPBaseDN
type: string
description: >
@@ -51,24 +50,23 @@
type: enum[self.Type]
description: >
Specifies the the configured server is ActiveDirectory(AD) or
- OpenLdap. It's just an indication for the LDAP stack running on
- the BMC, in case the app is implemented in such a way that it has
- to react differently for AD vs openldap.
- This property is readonly, Once the D-Bus object gets created then
- this property should not be modifiable.
+ OpenLdap. It's just an indication for the LDAP stack running on the
+ BMC, in case the app is implemented in such a way that it has to react
+ differently for AD vs openldap. This property is readonly, Once the
+ D-Bus object gets created then this property should not be modifiable.
errors:
- xyz.openbmc_project.Common.Error.InternalFailure
- xyz.openbmc_project.Common.Error.NotAllowed
- name: GroupNameAttribute
type: string
description: >
- The value of this property shall be the attribute name
- that contains the name of the Group in the LDAP server.
+ The value of this property shall be the attribute name that contains
+ the name of the Group in the LDAP server.
- name: UserNameAttribute
type: string
description: >
- The value of this property shall be the attribute name
- that contains the username in the LDAP server.
+ The value of this property shall be the attribute name that contains
+ the username in the LDAP server.
enumerations:
- name: SearchScope
description: >
diff --git a/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml b/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
index 452bd9e..fae5b8b 100644
--- a/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Ldap/Create.interface.yaml
@@ -4,10 +4,10 @@
methods:
- name: CreateConfig
description: >
- This method always creates a new config file as well as a D-Bus
- object to represent the config, it will destroy an existing one,
- if found. In other words, this is not an update API. Individual
- properties can be updated as per the
+ This method always creates a new config file as well as a D-Bus object
+ to represent the config, it will destroy an existing one, if found. In
+ other words, this is not an update API. Individual properties can be
+ updated as per the
xyz/openbmc_project/User/Ldap/Config.interface.yaml.
parameters:
- name: LDAPServerURI
@@ -37,18 +37,18 @@
description: >
Specifies the the configured server is ActiveDirectory(AD) or
OpenLdap. It's just an indication for the LDAP stack running on
- the BMC, in case the app is implemented in such a way that it has
- to react differently for AD vs openldap.
+ the BMC, in case the app is implemented in such a way that it
+ has to react differently for AD vs openldap.
- name: GroupNameAttribute
type: string
description: >
- Specifies the attribute name that contains the name
- of the Group in the LDAP server.
+ Specifies the attribute name that contains the name of the Group
+ in the LDAP server.
- name: UsernameAttribute
type: string
description: >
- Specifies the attribute name that contains
- the username in the LDAP server.
+ Specifies the attribute name that contains the username in the
+ LDAP server.
returns:
- name: path
type: string
diff --git a/yaml/xyz/openbmc_project/User/Manager.interface.yaml b/yaml/xyz/openbmc_project/User/Manager.interface.yaml
index 14774c0..4cc0ab0 100644
--- a/yaml/xyz/openbmc_project/User/Manager.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/Manager.interface.yaml
@@ -1,13 +1,13 @@
description: >
- Provides user management functionality.
- As communication to this service is done through authenticated
- & authorized session, there won't be any validation for both.
+ Provides user management functionality. As communication to this service is
+ done through authenticated & authorized session, there won't be any
+ validation for both.
methods:
- name: CreateUser
description: >
- Creates a new user. If the user already exists, then it will throw
- an error.
+ Creates a new user. If the user already exists, then it will throw an
+ error.
parameters:
- name: UserName
type: string
@@ -36,8 +36,8 @@
- name: RenameUser
description: >
- Rename's existing user to new one. All other properties of the
- user will remain same.
+ Rename's existing user to new one. All other properties of the user
+ will remain same.
parameters:
- name: UserName
type: string
@@ -59,8 +59,7 @@
- name: GetUserInfo
description: >
- Get user properites.
- If its local user, method returns
+ Get user properites. If its local user, method returns
-user privilege
-user groups
-user enabled state
@@ -79,9 +78,8 @@
- name: UserInfo
type: dict[string,variant[string,array[string],boolean]]
description: >
- Dictionary of user properties.
- List of key name and data type of properties below.
- UserPrivilege -> privilege of the user(string)
+ Dictionary of user properties. List of key name and data type of
+ properties below. UserPrivilege -> privilege of the user(string)
UserGroups -> list of groups user belongs to(array[string])
UserEnabled -> user enabled state(boolean)
UserLockedForFailedAttempt -> user locked state(boolean)
@@ -89,8 +87,7 @@
RemoteUser -> remote or local user(boolean)
For detailed documentation of user properties refer
- Attributes.interface.yaml
- examples:
+ Attributes.interface.yaml examples:
1.UserInfo["RemoteUser"] returns true for ldap user
and false for local user.
2.UserInfo["UserGroups"] gets list of groups of user.
@@ -102,8 +99,8 @@
- name: CreateGroup
description: >
- Creates a new groups. If the group already exists, or the
- group name is not allowed to be created, it throws an error.
+ Creates a new groups. If the group already exists, or the group name
+ is not allowed to be created, it throws an error.
parameters:
- name: GroupName
type: string
@@ -116,8 +113,8 @@
- name: DeleteGroup
description: >
- Deletes an existing groups. If the group doesn't exists, or the
- group name is not allowed to be deleted, it throws an error.
+ Deletes an existing groups. If the group doesn't exists, or the group
+ name is not allowed to be deleted, it throws an error.
parameters:
- name: GroupName
type: string
diff --git a/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml b/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
index 3e84ecd..ce87dec 100644
--- a/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/PrivilegeMapper.interface.yaml
@@ -1,17 +1,17 @@
description: >
- Implement this interface to set the privilege of the user based on the
- group name. The users in the group will inherit the privilege mapping of
- the group. The Create method on success creates the object which implements
+ Implement this interface to set the privilege of the user based on the group
+ name. The users in the group will inherit the privilege mapping of the
+ group. The Create method on success creates the object which implements
xyz.openbmc_project.User.PrivilegeMapperEntry. For example in the case of
LDAP, the object path will be
- /xyz/openbmc_project/user/ldap/privilege_mapper/<id>. The <id> will be
- a unique number generated by the application. If the privilege mapping
- already exists then it throws the exception
+ /xyz/openbmc_project/user/ldap/privilege_mapper/<id>. The <id> will be a
+ unique number generated by the application. If the privilege mapping already
+ exists then it throws the exception
xyz.openbmc_project.User.Common.Error.PrivilegeMappingExists. To modify the
privilege for a mapping which already exists, the Privilege property in the
- xyz.openbmc_project.User.PrivilegeMapperEntry interface needs to be set.
- Any application consuming the privilege mapping should not cache the object
- path and use the GetManagedObjects method on the
+ xyz.openbmc_project.User.PrivilegeMapperEntry interface needs to be set. Any
+ application consuming the privilege mapping should not cache the object path
+ and use the GetManagedObjects method on the
org.freedesktop.DBus.ObjectManager interface to figure out the D-Bus object
path associated with the group name.
@@ -24,7 +24,8 @@
type: string
description: >
Group Name to which the privilege is to be assigned. In the case
- of LDAP, the GroupName will be the LDAP group the user is part of.
+ of LDAP, the GroupName will be the LDAP group the user is part
+ of.
- name: Privilege
type: string
description: >
diff --git a/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml b/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml
index 4217b91..5e3da0f 100644
--- a/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml
+++ b/yaml/xyz/openbmc_project/User/PrivilegeMapperEntry.interface.yaml
@@ -17,8 +17,8 @@
One of the privilege as defined by
xyz.openbmc_project.User.Manager.AllPrivileges.
xyz.openbmc_project.Common.Error.InvalidArgument exception will be
- thrown if the privilege is invalid. Additional documentation
- on privilege is available here.
+ thrown if the privilege is invalid. Additional documentation on
+ privilege is available here.
https://github.com/openbmc/docs/blob/master/architecture/user-management.md
errors:
diff --git a/yaml/xyz/openbmc_project/User/README.md b/yaml/xyz/openbmc_project/User/README.md
index 16a0911..00de6c4 100644
--- a/yaml/xyz/openbmc_project/User/README.md
+++ b/yaml/xyz/openbmc_project/User/README.md
@@ -29,8 +29,8 @@
##### properties
-- MaxLoginAttemptBeforeLockout - Permissible attempt before locking out the
- user for failed login attempts.
+- MaxLoginAttemptBeforeLockout - Permissible attempt before locking out the user
+ for failed login attempts.
- AccountUnlockTimeout - Timeout (in seconds) to unlock the account after a
lockout.
- MinPasswordLength - Minimum password length, which can be set.
@@ -39,10 +39,10 @@
### Users Interface
-User manager daemon, will create user objects for every user existing
-in the system under object path `/xyz/openbmc_project/user/<user name>`.
-Each user object can be handled through 'org.freedesktop.DBus.ObjectManager'.
-User object will expose following properties and methods.
+User manager daemon, will create user objects for every user existing in the
+system under object path `/xyz/openbmc_project/user/<user name>`. Each user
+object can be handled through 'org.freedesktop.DBus.ObjectManager'. User object
+will expose following properties and methods.
#### xyz.openbmc_project.User.Attributes interface
@@ -61,6 +61,6 @@
## Note
-This interface doesn't provide ways to set / update password. The same must
-be set / updated through pam_chauthtok() (PAM modules). This is to avoid
-sending out password through D-Bus.
+This interface doesn't provide ways to set / update password. The same must be
+set / updated through pam_chauthtok() (PAM modules). This is to avoid sending
+out password through D-Bus.