Av:Developer:CredentialsService - Revision history

Davidd: /* ReLogin */

2015-01-09T11:31:09Z

ReLogin

← Older revision		Revision as of 11:31, 9 January 2015
Line 46:		Line 46:

	== ReLogin ==		== ReLogin ==
-	Refresh an existing token returned from <tt>Login()</tt>. This should only be called after ~~teh~~ remote service has indicated that the current token has expired and is no longer valid.	+	Refresh an existing token returned from <tt>Login()</tt>. This should only be called after the remote service has indicated that the current token has expired and is no longer valid.
	<br>Returns a 800 fault code if the <tt>Id</tt> argument is invalid.		<br>Returns a 800 fault code if the <tt>Id</tt> argument is invalid.
	<br>Returns a 801 fault code if a new login was attempted but failed.		<br>Returns a 801 fault code if a new login was attempted but failed.

Simonc: /* PublicKey */

2014-12-22T14:19:56Z

PublicKey

← Older revision		Revision as of 14:19, 22 December 2014
Line 12:		Line 12:
	RSA public key that must be used to encrypt any/all passwords.		RSA public key that must be used to encrypt any/all passwords.
	<br>When encrypting ensure PKCS1 OAEP padding is used.		<br>When encrypting ensure PKCS1 OAEP padding is used.
-	<br>May be blank on startup; will not vary once set. ~~The~~ rest of the service cannot usefully be used before this is set.	+	<br>May be blank on startup; will not vary once set. With the exception of the <tt>Ids</tt> state variable, the rest of the service cannot usefully be used before this is set.

	== SequenceNumber ==		== SequenceNumber ==

Simonc: /* Service Description (XML) */

2014-12-22T14:18:37Z

Service Description (XML)

← Older revision		Revision as of 14:18, 22 December 2014
Line 91:		Line 91:
	<name>Password</name>		<name>Password</name>
	<direction>in</direction>		<direction>in</direction>
-	<relatedStateVariable>~~A_ARG_TYPE_String~~</relatedStateVariable>	+	<relatedStateVariable>A_ARG_TYPE_Binary</relatedStateVariable>
	</argument>		</argument>
	</argumentList>		</argumentList>
Line 136:		Line 136:
	<name>Password</name>		<name>Password</name>
	<direction>out</direction>		<direction>out</direction>
-	<relatedStateVariable>~~A_ARG_TYPE_String~~</relatedStateVariable>	+	<relatedStateVariable>A_ARG_TYPE_Binary</relatedStateVariable>
	</argument>		</argument>
	<argument>		<argument>
Line 237:		Line 237:
	<name>A_ARG_TYPE_String</name>		<name>A_ARG_TYPE_String</name>
	<dataType>string</dataType>		<dataType>string</dataType>
		+	</stateVariable>
		+	<stateVariable sendEvents="no">
		+	<name>A_ARG_TYPE_Binary</name>
		+	<dataType>bin.base64</dataType>
	</stateVariable>		</stateVariable>
	<stateVariable sendEvents="no">		<stateVariable sendEvents="no">

Davidd: /* PublicKey */

2014-12-03T17:04:21Z

PublicKey

← Older revision		Revision as of 17:04, 3 December 2014
Line 11:		Line 11:
	== PublicKey ==		== PublicKey ==
	RSA public key that must be used to encrypt any/all passwords.		RSA public key that must be used to encrypt any/all passwords.
		+	<br>When encrypting ensure PKCS1 OAEP padding is used.
	<br>May be blank on startup; will not vary once set. The rest of the service cannot usefully be used before this is set.		<br>May be blank on startup; will not vary once set. The rest of the service cannot usefully be used before this is set.

Simonc: /* Service Description (XML) */

2014-11-21T18:05:10Z

Service Description (XML)

← Older revision		Revision as of 18:05, 21 November 2014
Line 144:		Line 144:
	<argument>		<argument>
	<name>Status</name>		<name>Status</name>
		+	<direction>out</direction>
		+	<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
		+	</argument>
		+	<argument>
		+	<name>Data</name>
	<direction>out</direction>		<direction>out</direction>
	<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>		<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
Line 165:		Line 170:
	</action>		</action>
	<action>		<action>
-	<name>~~Logout~~</name>	+	<name>ReLogin</name>
	<argumentList>		<argumentList>
	<argument>		<argument>
Line 173:		Line 178:
	</argument>		</argument>
	<argument>		<argument>
-	<name>~~Token~~</name>	+	<name>CurrentToken</name>
	<direction>in</direction>		<direction>in</direction>
		+	<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
		+	</argument>
		+	<argument>
		+	<name>NewToken</name>
		+	<direction>out</direction>
	<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>		<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
	</argument>		</argument>

Simonc: /* Get */

2014-11-21T17:40:31Z

Get

← Older revision		Revision as of 17:40, 21 November 2014
Line 36:		Line 36:
	<br>Username, password and enabled will only change in response to invocations of the Credentials service. The password is encrypted so is not suitable for user display. Clients can infer whether a password has been set by checking whether the value returned has non-zero length.		<br>Username, password and enabled will only change in response to invocations of the Credentials service. The password is encrypted so is not suitable for user display. Clients can infer whether a password has been set by checking whether the value returned has non-zero length.
	<br>Status may change in response to runtime events. e.g. If an account expires, the status may change to include the error returned by the remote service provider. Status is only set for error cases - a blank status indicates that a service is functioning correctly. The exact format of status content varies between services.		<br>Status may change in response to runtime events. e.g. If an account expires, the status may change to include the error returned by the remote service provider. Status is only set for error cases - a blank status indicates that a service is functioning correctly. The exact format of status content varies between services.
		+	<br>Data contains any other service-specific information. The format of content varies between services.
	<br>Returns a 800 fault code if the <tt>Id</tt> argument is invalid.		<br>Returns a 800 fault code if the <tt>Id</tt> argument is invalid.

Simonc: /* Logout */

2014-11-21T17:37:54Z

Logout

← Older revision		Revision as of 17:37, 21 November 2014
Line 43:		Line 43:
	<br>Returns a 801 fault code if the login was attempted but failed.		<br>Returns a 801 fault code if the login was attempted but failed.

-	== ~~Logout~~ ==	+	== ReLogin ==
-	~~Optional action, indicating that a~~ token returned from ~~an earlier call to~~ <tt>Login()</tt> is no longer ~~required~~.	+	Refresh an existing token returned from <tt>Login()</tt>. This should only be called after teh remote service has indicated that the current token has expired and is no longer valid.
	<br>Returns a 800 fault code if the <tt>Id</tt> argument is invalid.		<br>Returns a 800 fault code if the <tt>Id</tt> argument is invalid.
-	<br>Returns a ~~802~~ fault code if ~~the logout~~ was attempted but failed~~. This error is reported for information only; there is nothing a client should do in response to it~~.	+	<br>Returns a 801 fault code if a new login was attempted but failed.

	== GetIds ==		== GetIds ==

Simonc: /* Login */

2014-11-18T13:09:09Z

← Older revision		Revision as of 13:09, 18 November 2014
Line 39:		Line 39:

	== Login ==		== Login ==
-	Read a token indicating that a registered user has logged in to a remote service. This allows control points to access data that is specific to a certain user account without requiring access to the (sensitive) password for that account.	+	Read a token indicating that a registered user has logged in to a remote service. This allows control points to access data that is specific to a certain user account without requiring access to the (sensitive) password for that account. The data returned may vary between credential-consuming services; the control point is responsible for knowing how to interpret it.
	<br>Returns a 800 fault code if the <tt>Id</tt> argument is invalid.		<br>Returns a 800 fault code if the <tt>Id</tt> argument is invalid.
	<br>Returns a 801 fault code if the login was attempted but failed.		<br>Returns a 801 fault code if the login was attempted but failed.

Simonc: /* PublicKey */

2014-11-18T12:13:40Z

PublicKey

← Older revision		Revision as of 12:13, 18 November 2014
Line 11:		Line 11:
	== PublicKey ==		== PublicKey ==
	RSA public key that must be used to encrypt any/all passwords.		RSA public key that must be used to encrypt any/all passwords.
-	<br>~~Set~~ on startup; ~~does~~ not ~~change at runtime~~.	+	<br>May be blank on startup; will not vary once set. The rest of the service cannot usefully be used before this is set.

	== SequenceNumber ==		== SequenceNumber ==

Simonc: Created page with "= Overview = The Credentials provides access to username, password and current status of all remote services that require unique logins.
If a device's [[Developer:ProductSer..."

2014-11-11T13:43:01Z

Created page with "= Overview = The Credentials provides access to username, password and current status of all remote services that require unique logins. If a device's [[Developer:ProductSer..."

New page

= Overview =

The Credentials provides access to username, password and current status of all remote services that require unique logins.
 If a device's [[Developer:ProductService|Product]] service reports an attribute 'Credentials', then that device is guaranteed to bear the Credentials service.

= State Variables =
== Ids ==
Space separated list of identifiers for services whose credentials can be set.
 Set on startup; does not change at runtime.

== PublicKey ==
RSA public key that must be used to encrypt any/all passwords.
 Set on startup; does not change at runtime.

== SequenceNumber ==
Increases whenever any aspect of state for any user of credentials listed in <tt>Ids</tt> changes. The client is responsible for polling each Id they are interested in to determine what has changed.

= Actions =
== Set ==
Set the username and password for a given service. The password must be encrypted using the RSA public key in the <tt>PublicKey</tt> state variable.
 Calling this action automatically enables the service.
 Note that some processing may happen asynchronously. If any of username, password or enabled states are changed for the service, <tt>SequenceNumber</tt> will automatically change.
 Returns a 800 fault code if the <tt>Id</tt> argument is invalid.

== Clear ==
Remove both username and password for a given service.
 Note that some processing may happen asynchronously. If any of username, password or enabled states are changed for the service, <tt>SequenceNumber</tt> will automatically change.
 Returns a 800 fault code if the <tt>Id</tt> argument is invalid.

== SetEnabled ==
Set or clear the enabled state of a service. Disabling a service temporarily prevents its use by a device but allows the device to retain the username/password for later use (if the service is re-enabled by calling <tt>SetEnabled()</tt> again).
 Returns a 800 fault code if the <tt>Id</tt> argument is invalid.

== Get ==
Retrieve username, password, status and enabled state for a service.
 Username, password and enabled will only change in response to invocations of the Credentials service. The password is encrypted so is not suitable for user display. Clients can infer whether a password has been set by checking whether the value returned has non-zero length.
 Status may change in response to runtime events. e.g. If an account expires, the status may change to include the error returned by the remote service provider. Status is only set for error cases - a blank status indicates that a service is functioning correctly. The exact format of status content varies between services.
 Returns a 800 fault code if the <tt>Id</tt> argument is invalid.

== Login ==
Read a token indicating that a registered user has logged in to a remote service. This allows control points to access data that is specific to a certain user account without requiring access to the (sensitive) password for that account.
 Returns a 800 fault code if the <tt>Id</tt> argument is invalid.
 Returns a 801 fault code if the login was attempted but failed.

== Logout ==
Optional action, indicating that a token returned from an earlier call to <tt>Login()</tt> is no longer required.
 Returns a 800 fault code if the <tt>Id</tt> argument is invalid.
 Returns a 802 fault code if the logout was attempted but failed. This error is reported for information only; there is nothing a client should do in response to it.

== GetIds ==
Read the value of the <tt>Ids</tt> state variable.

== GetPublicKey ==
Read the value of the <tt>PublicKey</tt> state variable.

== GetSequenceNumber ==
Read the value of the <tt>SequenceNumber</tt> state variable.

= Technical Details =
<code>
Domain : av.openhome.org
Name : Credentials
Version : 1
</code>

== Service Description (XML) ==
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<scpd xmlns="urn:schemas-upnp-org:service-1-0">
<specVersion>
<major>1</major>
<minor>0</minor>
</specVersion>
<actionList>
<action>
<name>Set</name>
<argumentList>
<argument>
<name>Id</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>UserName</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>Password</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Clear</name>
<argumentList>
<argument>
<name>Id</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetEnabled</name>
<argumentList>
<argument>
<name>Id</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>Enabled</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_Bool</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Get</name>
<argumentList>
<argument>
<name>Id</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>UserName</name>
<direction>out</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>Password</name>
<direction>out</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>Enabled</name>
<direction>out</direction>
<relatedStateVariable>A_ARG_TYPE_Bool</relatedStateVariable>
</argument>
<argument>
<name>Status</name>
<direction>out</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Login</name>
<argumentList>
<argument>
<name>Id</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>Token</name>
<direction>out</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>Logout</name>
<argumentList>
<argument>
<name>Id</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>Token</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>GetIds</name>
<argumentList>
<argument>
<name>Ids</name>
<direction>out</direction>
<relatedStateVariable>Ids</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>GetPublicKey</name>
<argumentList>
<argument>
<name>PublicKey</name>
<direction>out</direction>
<relatedStateVariable>PublicKey</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>GetSequenceNumber</name>
<argumentList>
<argument>
<name>SequenceNumber</name>
<direction>out</direction>
<relatedStateVariable>SequenceNumber</relatedStateVariable>
</argument>
</argumentList>
</action>
</actionList>
<serviceStateTable>
<stateVariable sendEvents="yes">
<name>Ids</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>PublicKey</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="yes">
<name>SequenceNumber</name>
<dataType>ui4</dataType>
</stateVariable>
<stateVariable sendEvents="no">
<name>A_ARG_TYPE_String</name>
<dataType>string</dataType>
</stateVariable>
<stateVariable sendEvents="no">
<name>A_ARG_TYPE_Bool</name>
<dataType>boolean</dataType>
</stateVariable>
</serviceStateTable>
</scpd>

Av:Developer:CredentialsService - Revision history

Davidd: /* ReLogin */

Simonc: /* PublicKey */

Simonc: /* Service Description (XML) */

Davidd: /* PublicKey */

Simonc: /* Service Description (XML) */

Simonc: /* Get */

Simonc: /* Logout */

Simonc: /* Login */

Simonc: /* PublicKey */

Simonc: Created page with "= Overview = The Credentials provides access to username, password and current status of all remote services that require unique logins. If a device's [[Developer:ProductSer..."

Simonc: Created page with "= Overview = The Credentials provides access to username, password and current status of all remote services that require unique logins.
If a device's [[Developer:ProductSer..."