commit 32847991c31d580aa41e2fdc6489c6219400bf22
author Vishwanatha Subbanna <vishwa@linux.vnet.ibm.com> Tue Aug 29 17:36:07 2017 +0530
committer Patrick Williams <patrick@stwcx.xyz> Tue Sep 12 16:33:54 2017 +0000
tree 87c50d6c1fd58e14025aeaf65302bba5fb1a30c1
parent 2f3c9a6386f64286227c0c28a8818b5df20642a5

Add interface yaml file for user password update feature

Change-Id: I9b23ebcae15e1feee0eb32c42b184c8a429e0977
Signed-off-by: Vishwanatha Subbanna <vishwa@linux.vnet.ibm.com>

xyz/openbmc_project/Common.errors.yaml

diff --git a/xyz/openbmc_project/Common.errors.yaml b/xyz/openbmc_project/Common.errors.yaml
index 2066005..f6b2734 100644
--- a/xyz/openbmc_project/Common.errors.yaml
+++ b/xyz/openbmc_project/Common.errors.yaml
@@ -4,3 +4,5 @@
   description: The operation failed internally.
 - name: InvalidArgument
   description: Invalid argument was given.
+- name: InsufficientPermission
+  description: Insufficient permission to perform operation

xyz/openbmc_project/Common.metadata.yaml

diff --git a/xyz/openbmc_project/Common.metadata.yaml b/xyz/openbmc_project/Common.metadata.yaml
index 669a9b0..e2b76cc 100644
--- a/xyz/openbmc_project/Common.metadata.yaml
+++ b/xyz/openbmc_project/Common.metadata.yaml
@@ -10,3 +10,5 @@
       type: string
 - name: InternalFailure
   level: ERR
+- name: InsufficientPermission
+  level: INFO

xyz/openbmc_project/User/Password.interface.yaml

diff --git a/xyz/openbmc_project/User/Password.interface.yaml b/xyz/openbmc_project/User/Password.interface.yaml
new file mode 100644
index 0000000..24697a3
--- /dev/null
+++ b/xyz/openbmc_project/User/Password.interface.yaml
@@ -0,0 +1,27 @@
+description: >
+    Implement to provide user password set functionality. Since this
+    needs an authenticated session, there is no need of old password.
+    User ID is part of the dbus object.
+methods:
+    - name: SetPassword
+      description: >
+          Set the user password. If the user already had a password, it will
+          be updated, else sets the password.
+
+          InsufficientPermission error doing so would mean that, the caller
+          does not have required permission to update the password.
+
+          InternalFailure error would mean that, caller had required
+          permissions, but, there was a software error.
+          Errorlog metadata would need to be looked into when this happens.
+          Re-try once on this error and if that fails, do not try anymore.
+      parameters:
+        - name: NewPassword
+          type: string
+          description: >
+              new password string
+      errors:
+        - xyz.openbmc_project.Common.Error.InternalFailure
+        - xyz.openbmc_project.Common.Error.InsufficientPermission
+
+# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4