GUACAMOLE-96: Handle enrollment via QR code for unconfirmed users.

extensions/guacamole-auth-totp/pom.xml

@@ -249,6 +249,26 @@
             <scope>test</scope>
         </dependency>
 
+        <!-- ZXing - Barcode library -->
+        <dependency>
+            <groupId>com.google.zxing</groupId>
+            <artifactId>javase</artifactId>
+            <version>3.3.1</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.zxing</groupId>
+            <artifactId>core</artifactId>
+            <version>3.3.1</version>
+        </dependency>
+
+        <!-- Guacamole depends on an implementation of JAX-WS -->
+        <dependency>
+            <groupId>javax.ws.rs</groupId>
+            <artifactId>javax.ws.rs-api</artifactId>
+            <version>2.0</version>
+            <scope>provided</scope>
+        </dependency>
+
     </dependencies>
 
 </project>

extensions/guacamole-auth-totp/src/licenses/LICENSE

@@ -283,3 +283,12 @@ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+
+ZXing Barcode Scanning Library (https://github.com/zxing/zxing/)
+----------------------------------------------------------------
+
+    Version: 3.3.1
+    From: 'ZXing authors' (https://github.com/zxing/zxing/blob/zxing-3.3.1/AUTHORS)
+    License(s):
+        Apache v2.0 (bundled/zxing-3.3.1/LICENSE)
+

extensions/guacamole-auth-totp/src/licenses/bundled/zxing-3.3.1/LICENSE

@@ -0,0 +1,245 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+========================================================================
+jai-imageio
+========================================================================
+
+Copyright (c) 2005 Sun Microsystems, Inc.
+Copyright © 2010-2014 University of Manchester
+Copyright © 2010-2015 Stian Soiland-Reyes
+Copyright © 2015 Peter Hull
+All Rights Reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+- Redistribution of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+- Redistribution in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in
+  the documentation and/or other materials provided with the
+  distribution.
+
+Neither the name of Sun Microsystems, Inc. or the names of
+contributors may be used to endorse or promote products derived
+from this software without specific prior written permission.
+
+This software is provided "AS IS," without a warranty of any
+kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
+WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
+EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
+NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
+USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
+DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
+ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
+CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
+REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
+INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+You acknowledge that this software is not designed or intended for
+use in the design, construction, operation or maintenance of any
+nuclear facility.

extensions/guacamole-auth-totp/src/main/java/org/apache/guacamole/auth/totp/UserTOTPKey.java

@@ -32,6 +32,11 @@ public class UserTOTPKey {
      */
     private static final Random RANDOM = new SecureRandom();
 
+    /**
+     * The username of the user associated with this key.
+     */
+    private final String username;
+
     /**
      * Whether the associated secret key has been confirmed by the user. A key
      * is confirmed once the user has successfully entered a valid TOTP
@@ -63,17 +68,23 @@ public class UserTOTPKey {
      * Creates a new, unconfirmed, randomly-generated TOTP key having the given
      * length.
      *
+     * @param username
+     *     The username of the user associated with this key.
+     *
      * @param length
      *     The length of the key to generate, in bytes.
      */
-    public UserTOTPKey(int length) {
+    public UserTOTPKey(String username, int length) {
-        this(generateBytes(length), false);
+        this(username, generateBytes(length), false);
     }
 
     /**
      * Creates a new UserTOTPKey containing the given key and having the given
      * confirmed state.
      *
+     * @param username
+     *     The username of the user associated with this key.
+     *
      * @param secret
      *     The raw binary secret key to be used to generate TOTP codes.
      *
@@ -82,11 +93,22 @@ public class UserTOTPKey {
      *     successfully generate the corresponding TOTP codes (the user has
      *     been "enrolled"), false otherwise.
      */
-    public UserTOTPKey(byte[] secret, boolean confirmed) {
+    public UserTOTPKey(String username, byte[] secret, boolean confirmed) {
+        this.username = username;
         this.confirmed = confirmed;
         this.secret = secret;
     }
 
+    /**
+     * Returns the username of the user associated with this key.
+     *
+     * @return
+     *     The username of the user associated with this key.
+     */
+    public String getUsername() {
+        return username;
+    }
+
     /**
      * Returns the raw binary secret key to be used to generate TOTP codes.
      *

extensions/guacamole-auth-totp/src/main/java/org/apache/guacamole/auth/totp/UserVerificationService.java

@@ -76,6 +76,9 @@ public class UserVerificationService {
      * @param context
      *     The UserContext of the user whose TOTP key should be retrieved.
      *
+     * @param username
+     *     The username of the user associated with the given UserContext.
+     *
      * @return
      *     The TOTP key associated with the user having the given UserContext,
      *     or null if the extension storing the user does not support storage
@@ -85,7 +88,8 @@ public class UserVerificationService {
      *     If a new key is generated, but the extension storing the associated
      *     user fails while updating the user account.
      */
-    private UserTOTPKey getKey(UserContext context) throws GuacamoleException {
+    private UserTOTPKey getKey(UserContext context,
+            String username) throws GuacamoleException {
 
         // Retrieve attributes from current user
         User self = context.self();
@@ -96,7 +100,7 @@ public class UserVerificationService {
         if (secret == null) {
 
             // Generate random key for user
-            UserTOTPKey generated = new UserTOTPKey(TOTPGenerator.Mode.SHA1.getRecommendedKeyLength());
+            UserTOTPKey generated = new UserTOTPKey(username, TOTPGenerator.Mode.SHA1.getRecommendedKeyLength());
             if (setKey(context, generated))
                 return generated;
 
@@ -121,7 +125,7 @@ public class UserVerificationService {
 
         // Otherwise, parse value from attributes
         boolean confirmed = "true".equals(attributes.get(TOTP_KEY_CONFIRMED_ATTRIBUTE_NAME));
-        return new UserTOTPKey(key, confirmed);
+        return new UserTOTPKey(username, key, confirmed);
 
     }
 
@@ -205,7 +209,7 @@ public class UserVerificationService {
             return;
 
         // Ignore users which do not have an associated key
-        UserTOTPKey key = getKey(context);
+        UserTOTPKey key = getKey(context, username);
         if (key == null)
             return;
 
@@ -219,7 +223,14 @@ public class UserVerificationService {
         // If no TOTP provided, request one
         if (code == null) {
 
-            // FIXME: Handle key.isConfirmed() for initial prompt
+            // If the user hasn't completed enrollment, request that they do
+            if (!key.isConfirmed())
+                throw new GuacamoleInsufficientCredentialsException(
+                        "LOGIN.INFO_TOTP_REQUIRED", new CredentialsInfo(
+                            Collections.<Field>singletonList(new AuthenticationCodeField(key))
+                        ));
+
+            // Otherwise simply request the user's authentication code
             throw new GuacamoleInsufficientCredentialsException(
                     "LOGIN.INFO_TOTP_REQUIRED", new CredentialsInfo(
                         Collections.<Field>singletonList(new AuthenticationCodeField())

extensions/guacamole-auth-totp/src/main/java/org/apache/guacamole/auth/totp/form/AuthenticationCodeField.java

@@ -19,7 +19,21 @@
 
 package org.apache.guacamole.auth.totp.form;
 
+import com.google.common.io.BaseEncoding;
+import com.google.zxing.BarcodeFormat;
+import com.google.zxing.WriterException;
+import com.google.zxing.client.j2se.MatrixToImageWriter;
+import com.google.zxing.common.BitMatrix;
+import com.google.zxing.qrcode.QRCodeWriter;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.net.URI;
+import javax.ws.rs.core.UriBuilder;
+import javax.xml.bind.DatatypeConverter;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.auth.totp.UserTOTPKey;
 import org.apache.guacamole.form.Field;
+import org.codehaus.jackson.annotate.JsonProperty;
 
 /**
  * Field which prompts the user for an authentication code generated via TOTP.
@@ -37,12 +51,135 @@ public class AuthenticationCodeField extends Field {
      */
     private static final String FIELD_TYPE_NAME = "GUAC_TOTP_CODE";
 
+    /**
+     * The width of QR codes to generate, in pixels.
+     */
+    private static final int QR_CODE_WIDTH = 256;
+
+    /**
+     * The height of QR codes to generate, in pixels.
+     */
+    private static final int QR_CODE_HEIGHT = 256;
+
+    /**
+     * BaseEncoding which encodes/decodes base32.
+     */
+    private static final BaseEncoding BASE32 = BaseEncoding.base32();
+
+    /**
+     * The TOTP key to expose to the user for the sake of enrollment, if any.
+     * If no such key should be exposed to the user, this will be null.
+     */
+    private final UserTOTPKey key;
+
     /**
      * Creates a new field which prompts the user for an authentication code
-     * generated via TOTP.
+     * generated via TOTP, and provide the user with their TOTP key to
+     * facilitate enrollment.
+     *
+     * @param key
+     *     The TOTP key to expose to the user for the sake of enrollment.
+     */
+    public AuthenticationCodeField(UserTOTPKey key) {
+        super(PARAMETER_NAME, FIELD_TYPE_NAME);
+        this.key = key;
+    }
+
+    /**
+     * Creates a new field which prompts the user for an authentication code
+     * generated via TOTP. The user's TOTP key is not exposed for enrollment.
      */
     public AuthenticationCodeField() {
-        super(PARAMETER_NAME, FIELD_TYPE_NAME);
+        this(null);
+    }
+
+    /**
+     * Returns the "otpauth" URI for the secret key used to generate TOTP codes
+     * for the current user. If the secret key is not being exposed to
+     * facilitate enrollment, null is returned.
+     *
+     * @return
+     *     The "otpauth" URI for the secret key used to generate TOTP codes
+     *     for the current user, or null is the secret ket is not being exposed
+     *     to facilitate enrollment.
+     *
+     * @throws GuacamoleException
+     *     If the configuration information required for generating the key URI
+     *     cannot be read from guacamole.properties.
+     */
+    @JsonProperty("keyUri")
+    public URI getKeyURI() throws GuacamoleException {
+
+        // Do not generate a key URI if no key is being exposed
+        if (key == null)
+            return null;
+
+        // FIXME: Pull from configuration
+        String issuer = "Some Issuer";
+        String algorithm = "SHA1";
+        String digits = "6";
+        String period = "30";
+
+        // Format "otpauth" URL (see https://github.com/google/google-authenticator/wiki/Key-Uri-Format)
+        return UriBuilder.fromUri("otpauth://totp/")
+                .path(issuer + ":" + key.getUsername())
+                .queryParam("secret", BASE32.encode(key.getSecret()))
+                .queryParam("issuer", issuer)
+                .queryParam("algorithm", algorithm)
+                .queryParam("digits", digits)
+                .queryParam("period", period)
+                .build();
+
+    }
+
+    /**
+     * Returns the URL of a QR code describing the user's TOTP key and
+     * configuration. If the key is not being exposed for enrollment, null is
+     * returned.
+     *
+     * @return 
+     *     The URL of a QR code describing the user's TOTP key and
+     *     configuration, or null if the key is not being exposed for
+     *     enrollment.
+     *
+     * @throws GuacamoleException
+     *     If the configuration information required for generating the QR code
+     *     cannot be read from guacamole.properties.
+     */
+    @JsonProperty("qrCode")
+    public String getQRCode() throws GuacamoleException {
+
+        // Do not generate a QR code if no key is being exposed
+        URI keyURI = getKeyURI();
+        if (keyURI == null)
+            return null;
+
+        ByteArrayOutputStream stream = new ByteArrayOutputStream();
+
+        try {
+
+            // Create QR code writer
+            QRCodeWriter writer = new QRCodeWriter();
+            BitMatrix matrix = writer.encode(keyURI.toString(),
+                    BarcodeFormat.QR_CODE, QR_CODE_WIDTH, QR_CODE_HEIGHT);
+
+            // Produce PNG image of TOTP key text
+            MatrixToImageWriter.writeToStream(matrix, "PNG", stream);
+
+        }
+        catch (WriterException e) {
+            throw new IllegalArgumentException("QR code could not be "
+                    + "generated for TOTP key.", e);
+        }
+        catch (IOException e) {
+            throw new IllegalStateException("Image stream of QR code could "
+                    + "not be written.", e);
+        }
+
+        // Return data URI for generated image
+        return "data:image/png;base64,"
+                + DatatypeConverter.printBase64Binary(stream.toByteArray());
+
     }
 
 }

extensions/guacamole-auth-totp/src/main/resources/templates/authenticationCodeField.html

@@ -1,3 +1,13 @@
 <div class="totp-code-field">
-    <input type="text" ng-model="model" autocorrect="off" autocapitalize="off"/>
+
+    <!-- QR Code (if available) -->
+    <div class="totp-qr-code" ng-show="field.qrCode">
+        <img ng-src="{{field.qrCode}}">
+    </div>
+
+    <!-- Field for entry of the current TOTP code -->
+    <div class="totp-code">
+        <input type="text" ng-model="model" autocorrect="off" autocapitalize="off"/>
+    </div>
+
 </div>