ARM4FS Designfoo - Revision history

Henryk: /* Musings On The Server<->Client Protocol */ moved to Reputation Provider-Client protocol

2006-05-13T01:57:44Z

Musings On The Server<->Client Protocol: moved to Reputation Provider-Client protocol

Henryk: /* authenticate */

2006-05-08T03:51:09Z

authenticate

← Older revision		Revision as of 03:51, 8 May 2006
Line 131:		Line 131:
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	! style="text-align: right;" \| Description:		! style="text-align: right;" \| Description:
	\| colspan="2" \| Completes the authentication procedure if the reserved keyword <code>new</~~new~~> is not present. If instead it is present (and the authentication checks out, of course), then a new user account will be created and entered into the database (and the connection will be authenticated).		\| colspan="2" \| Completes the authentication procedure if the reserved keyword <code>new</code> is not present. If instead it is present (and the authentication checks out, of course), then a new user account will be created and entered into the database (and the connection will be authenticated).
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	! style="text-align: right;" rowspan="2" \| Response:		! style="text-align: right;" rowspan="2" \| Response:

Henryk: /* List of Commands */

2006-05-08T03:50:50Z

List of Commands

@@ Line 122: / Line 122: @@
 |- style="vertical-align: top;"
 ! style="text-align: right;" | Synopsis:
-| colspan="2" | <code>authenticate <var>pubkey</var> <var>response_value</var></code><br/>&#8594; &#8709;
+| colspan="2" | <code>authenticate [new] <var>pubkey</var> <var>response_value</var></code><br/>&#8594; &#8709;
 |- style="vertical-align: top;"
 ! style="text-align: right;" | Arguments:
@@ Line 131: / Line 131: @@
 |- style="vertical-align: top;"
 ! style="text-align: right;" | Description:
 |- style="vertical-align: top;"
 ! style="text-align: right;" rowspan="2" | Response:
@@ Line 159: / Line 159: @@
 ! style="text-align: right; width: 1em;" | pos.:
 | <code><var>challenge_value</var></code>: The challenge, a BASE64 encoded opaque string.
 |- style="vertical-align: top;"
 ! style="text-align: right; width: 1em;" | neg.:

Henryk: /* List of Commands */

2006-05-08T03:47:32Z

List of Commands

@@ Line 125: / Line 125: @@
 |- style="vertical-align: top;"
 ! style="text-align: right;" | Arguments:
-| colspan="2" | <code><var>pubkey</var></code>: The clients public key, BASE64 encoded.<br/><code><var>response_value</var></code>: The response to the challenge.
+| colspan="2" | <code><var>pubkey</var></code>: The client's public key, BASE64 encoded.<br/><code><var>response_value</var></code>: The response to the challenge.
 |- style="vertical-align: top;"
 ! style="text-align: right;" | Description:
@@ Line 146: / Line 149: @@
 ! style="text-align: right;" | Arguments:
 | colspan="2" | none
 |- style="vertical-align: top;"
 ! style="text-align: right;" | Description:
@@ Line 153: / Line 159: @@
 ! style="text-align: right; width: 1em;" | pos.:
 | <code><var>challenge_value</var></code>: The challenge, a BASE64 encoded opaque string.
 |- style="vertical-align: top;"
 ! style="text-align: right; width: 1em;" | neg.:

Henryk: /* List of Commands */

2006-05-08T03:39:28Z

List of Commands

← Older revision		Revision as of 03:39, 8 May 2006
Line 117:		Line 117:

	==== List of Commands ====		==== List of Commands ====

			===== authenticate =====
			{\|
			\|- style="vertical-align: top;"
			! style="text-align: right;" \| Synopsis:
			\| colspan="2" \| <code>authenticate <var>pubkey</var> <var>response_value</var></code><br/>→ ∅
			\|- style="vertical-align: top;"
			! style="text-align: right;" \| Arguments:
			\| colspan="2" \| <code><var>pubkey</var></code>: The clients public key, BASE64 encoded.<br/><code><var>response_value</var></code>: The response to the challenge.
			\|- style="vertical-align: top;"
			! style="text-align: right;" \| Description:
			\| colspan="2" \| Completes the authentication procedure.
			\|- style="vertical-align: top;"
			! style="text-align: right;" rowspan="2" \| Response:
			! style="text-align: right; width: 1em;" \| pos.:
			\| none
			\|- style="vertical-align: top;"
			! style="text-align: right; width: 1em;" \| neg.:
			\| none
			\|}

	===== challenge =====		===== challenge =====
	{\|		{\|
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	! style="text-align: right;" \| ~~Format~~:		! style="text-align: right;" \| Synopsis:
	\| colspan="2" \| <code>challenge</code><br/>→<code><var>challenge_value</var></code>		\| colspan="2" \| <code>challenge</code><br/>→ <code><var>challenge_value</var></code>
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	! style="text-align: right;" \| Arguments:		! style="text-align: right;" \| Arguments:
Line 131:		Line 151:
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	! style="text-align: right;" rowspan="2" \| Response:		! style="text-align: right;" rowspan="2" \| Response:
	! style="text-align: right;" \| pos.:		! style="text-align: right; width: 1em;" \| pos.:
	\| <code><var>challenge_value</var></code>: The challenge, a BASE64 encoded string ~~without whitespace~~.		\| <code><var>challenge_value</var></code>: The challenge, a BASE64 encoded opaque string.
	\|- style="vertical-align: top;"		\|- style="vertical-align: top;"
	! style="text-align: right;" \| neg.:		! style="text-align: right; width: 1em;" \| neg.:
	\| none		\| none
	\|}		\|}

Henryk: /* List of Commands */

2006-05-08T03:32:46Z

List of Commands

← Older revision		Revision as of 03:32, 8 May 2006
Line 117:		Line 117:

	==== List of Commands ====		==== List of Commands ====

			===== challenge =====
			{\|
			\|- style="vertical-align: top;"
			! style="text-align: right;" \| Format:
			\| colspan="2" \| <code>challenge</code><br/>→<code><var>challenge_value</var></code>
			\|- style="vertical-align: top;"
			! style="text-align: right;" \| Arguments:
			\| colspan="2" \| none
			\|- style="vertical-align: top;"
			! style="text-align: right;" \| Description:
			\| colspan="2" \| Initiates the authentication procedure. The server responds with a challenge which the client must sign and send back in an <code>authenticate</code> command.
			\|- style="vertical-align: top;"
			! style="text-align: right;" rowspan="2" \| Response:
			! style="text-align: right;" \| pos.:
			\| <code><var>challenge_value</var></code>: The challenge, a BASE64 encoded string without whitespace.
			\|- style="vertical-align: top;"
			! style="text-align: right;" \| neg.:
			\| none
			\|}

Henryk: /* List of Commands */

2006-05-08T03:22:27Z

List of Commands

← Older revision		Revision as of 03:22, 8 May 2006
Line 115:		Line 115:

	Authentication may be tried exactly once per connection. No other command may be sent between the start of the procedure (the <code>challenge</code> command) and the reception of the positive response to the <code>authenticate</code> command. Any deviation from this protocol is forbidden and MUST lead to a termination of the connection.		Authentication may be tried exactly once per connection. No other command may be sent between the start of the procedure (the <code>challenge</code> command) and the reception of the positive response to the <code>authenticate</code> command. Any deviation from this protocol is forbidden and MUST lead to a termination of the connection.

			==== List of Commands ====

Henryk: /* Payload */

2006-05-08T03:21:45Z

Payload

← Older revision		Revision as of 03:21, 8 May 2006
Line 78:		Line 78:

	Failure to follow any of the regulations in this protocol MAY lead to immediate termination of the connection.		Failure to follow any of the regulations in this protocol MAY lead to immediate termination of the connection.

			==== Commands ====
			Commands are single words with no space, followed by optional command specific data that is separated from the command by a single space. The command specific data generally consists of several parameters (with no spaces) concatenated with spaces.

	==== Error Responses ====		==== Error Responses ====

Henryk: /* Error Responses */

2006-05-08T03:12:22Z

Error Responses

← Older revision		Revision as of 03:12, 8 May 2006
Line 84:		Line 84:

	'''Error codes'''		'''Error codes'''
			{\| style="border-top: 0.25em solid black; border-bottom: 0.25em solid black;"
	{\|
			\|- style="border-bottom: 0.125em solid black;"
	! Code !! Message !! Explanation		! Code !! Message !! Explanation
			\|- style="vertical-align: top"
	\|-
	! 400		! 400
	\| Bad command \|\| The command was malformed or invalid. Note that the server has the option to immediately terminate the connection when it encounters a protocol error and is not obliged to send this response and keep going.		\| Bad command \|\| The command was malformed or invalid. Note that the server has the option to immediately terminate the connection when it encounters a protocol error and is not obliged to send this response and keep going.
			\|- style="vertical-align: top"
	\|-
	! 401		! 401
	\| Authorization required \|\| The command was not executed because the client must authenticate first. See the section on Authentication. A server MAY terminate the connection instead of sending this response if it is extremely paranoid. This is the recommended behaviour. (Remember: Just because you're paranoid doesn't mean that they're not after you.)		\| Authorization required \|\| The command was not executed because the client must authenticate first. See the section on Authentication. A server MAY terminate the connection instead of sending this response if it is extremely paranoid. This is the recommended behaviour. (Remember: Just because you're paranoid doesn't mean that they're not after you.)

Henryk: /* Error Responses */

2006-05-08T03:03:56Z

Error Responses

← Older revision		Revision as of 03:03, 8 May 2006
Line 80:		Line 80:

	==== Error Responses ====		==== Error Responses ====
	Error responses start with an unhappy smiley, a single space and a three-digit error code, followed by an optional human readable error message~~, followed by an optional parameter section that starts with a semi-colon~~. They MUST thus match the following regular expression (PCRE syntax):		Error responses start with an unhappy smiley, a single space and a three-digit error code, followed by an optional human readable error message. They MUST thus match the following regular expression (PCRE syntax):
	/^:-\( +\d{3}~~[^;](?:;~~.)?$/		/^:-\( \d{3}.*$/

	'''Error codes'''		'''Error codes'''