chrome/browser/resources/cryptotoken/gnubbyfactory.js

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @fileoverview Contains a factory interface for creating and opening gnubbies.
   7  */
   8 'use strict';
   9
  10 /**
  11  * A factory for creating and opening gnubbies.
  12  * @interface
  13  */
  14 function GnubbyFactory() {}
  15
  16 /**
  17  * Enumerates gnubbies.
  18  * @param {function(number, Array<GnubbyDeviceId>)} cb Enumerate callback
  19  */
  20 GnubbyFactory.prototype.enumerate = function(cb) {
  21 };
  22
  23 /** @typedef {function(number, Gnubby=)} */
  24 var FactoryOpenCallback;
  25
  26 /**
  27  * Creates a new gnubby object, and opens the gnubby with the given index.
  28  * @param {GnubbyDeviceId} which The device to open.
  29  * @param {boolean} forEnroll Whether this gnubby is being opened for enrolling.
  30  * @param {FactoryOpenCallback} cb Called with result of opening the gnubby.
  31  * @param {string=} opt_appIdHash The base64-encoded hash of the app id for
  32  *     which the gnubby being opened.
  33  * @param {string=} opt_logMsgUrl The url to post log messages to.
  34  */
  35 GnubbyFactory.prototype.openGnubby =
  36     function(which, forEnroll, cb, opt_appIdHash, opt_logMsgUrl) {
  37 };
  38
  39 /**
  40  * Called during enrollment to check whether a gnubby known not to be enrolled
  41  * is allowed to enroll in its present state. Upon completion of the check, the
  42  * callback is called.
  43  * @param {Gnubby} gnubby The not-enrolled gnubby.
  44  * @param {string} appIdHash The base64-encoded hash of the app id for which
  45  *     the gnubby being enrolled.
  46  * @param {FactoryOpenCallback} cb Called with the result of the prerequisite
  47  *     check. (A non-zero status indicates failure.)
  48  */
  49 GnubbyFactory.prototype.notEnrolledPrerequisiteCheck =
  50     function(gnubby, appIdHash, cb) {
  51 };