Merge lp:~cjwatson/canonical-identity-provider/twofactor-required-error into lp:canonical-identity-provider/release

[Colin Watson]

Assign a distinct "twofactor-required" error code.

Assign a distinct "twofactor-required" error code.

These errors only moved over to the new style last week, so I think it's unlikely anyone's depending on this being conflated with CAPTCHA_REQUIRED.

[Celso Providelo (cprov)]

Thanks, Colin.

review: Approve

=== modified file 'docs/api.txt'
--- docs/api.txt	2016-09-02 11:31:05 +0000
+++ docs/api.txt	2016-09-14 16:52:23 +0000
@@ -154,23 +154,23 @@
 These are the codes used in the response and their meanings:
 
 - ``account-not-ready``: the account is deactivated, suspended or account email
-  is not valildated.
+  is not validated.
 
 - ``bad-request``: there is a problem in the structure of the request.
 
+- ``field-required``: the field in the request can't be empty or null.
+
 - ``internal-server-error``: some unexpected problem server side; this will be
   the code in all 5xx cases.
 
 - ``invalid-credentials``: the credentials for the authentication are not valid
-  (e.g.: the username, password are not correct, the 2 factor is needed, etc).
+  (e.g.: the username or password is not correct).
 
 - ``invalid-data``: the data is incorrect or corrupt.
 
 - ``permission-required``: the macaroon authorization is missing in
   the received request or not enough for it to be fulfilled.
 
-- ``required``: the field in the request can't be empty or null.
-
 - ``resource-not-found``: one or more fields are included to specify a
   resource, but it is not found in the Store.
 
@@ -178,6 +178,9 @@
   ready yet for that purpose; normally something else would need to be done
   first on the resource before this request can be repeated.
 
+- ``twofactor-required``: two-factor authentication is required for this
+  request but was not provided.
+
 - ``user-not-ready``: the user is not ready to issue the received request;
   normally some actions would need to be done in the user account before
   repeating the request.

=== modified file 'src/api/v20/utils.py'
--- src/api/v20/utils.py	2016-09-02 11:31:05 +0000
+++ src/api/v20/utils.py	2016-09-14 16:52:23 +0000
@@ -69,6 +69,7 @@
     REQUIRED = 'field-required'
     RESOURCE_NOT_FOUND = 'resource-not-found'
     RESOURCE_NOT_READY = 'resource-not-ready'
+    TWOFACTOR_REQUIRED = 'twofactor-required'
 
     def __init__(self):
         self._codes = {getattr(self, code) for code in dir(self)
@@ -91,7 +92,7 @@
 
     TWOFACTOR_REQUIRED=(
         401, _("2-factor authentication required."),
-        ErrorCode.REQUIRED),
+        ErrorCode.TWOFACTOR_REQUIRED),
 
     ACCOUNT_SUSPENDED=(
         403, _('Your account has been suspended. Please contact login '