├── bower.json
├── CONTRIBUTING.md
├── README.md
├── cm-api-shim.js
└── LICENSE


/bower.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "cm-api-shim",
 3 |   "main": "cm-api-shim.js",
 4 |   "authors": [
 5 |     "Jan Wilken Dörrie <jdoerrie@google.com>"
 6 |   ],
 7 |   "description": "A shim library for the updated Credential Management API (June 2017).",
 8 |   "keywords": [
 9 |     "Credential Management API",
10 |     "shim"
11 |   ],
12 |   "license": "Apache-2.0",
13 |   "ignore": [
14 |     "**/.*",
15 |     "node_modules",
16 |     "bower_components",
17 |     "test",
18 |     "tests"
19 |   ]
20 | }
21 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # How to Contribute
 2 | 
 3 | We'd love to accept your patches and contributions to this project. There are
 4 | just a few small guidelines you need to follow.
 5 | 
 6 | ## Contributor License Agreement
 7 | 
 8 | Contributions to this project must be accompanied by a Contributor License
 9 | Agreement. You (or your employer) retain the copyright to your contribution,
10 | this simply gives us permission to use and redistribute your contributions as
11 | part of the project. Head over to <https://cla.developers.google.com/> to see
12 | your current agreements on file or to sign a new one.
13 | 
14 | You generally only need to submit a CLA once, so if you've already submitted one
15 | (even if it was for a different project), you probably don't need to do it
16 | again.
17 | 
18 | ## Code reviews
19 | 
20 | All submissions, including submissions by project members, require review. We
21 | use GitHub pull requests for this purpose. Consult
22 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23 | information on using pull requests.
24 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Polyfills for the Credential Management API
 2 | The Credential Management API gained additional features that will be supported
 3 | by Google Chrome version 60 and onwards. This repository includes polyfills for
 4 | these features, so that developers can use the new API features while supporting
 5 | old and new browser versions.
 6 | 
 7 | ## How to use
 8 | Simply include `cm-api-shim.js` in your project, for example in the following
 9 | way:
10 | ``` html
11 | <script src="./cm-api-shim.js"></script>
12 | ```
13 | 
14 | You can install the library locally by running `bower install cm-api-shim`.
15 | 
16 | ## Supported Features
17 | The following features will be supported through the use of this library:
18 | 
19 | ### `navigator.credentials.preventSilentAccess`
20 | `navigator.credentials.requireUserMediation` has been renamed to
21 | `navigator.credentials.preventSilentAccess`. Through the use of this library
22 | developers can simply use `preventSilentAccess`, which will dispatch to
23 | `requireUserMediation` for older browsers.
24 | 
25 | ### A `mediation` enum argument to `navigator.credentials.get`
26 | The boolean `unmediated` flag argument to `navigator.credentials.get` has been
27 | replaced by a `mediation` enum, which takes the values `'silent'`, `'optional'`
28 | and `'required'`. `mediation: 'silent'` and `mediation: 'optional'` directly map
29 | to `unmediated: true` and `unmediated: false`. As before, `medation: 'optional'`
30 | is the default value if nothing else is specified.
31 | 
32 | Note: `mediation: 'required'` is a completely novel option that can not be
33 | polyfilled in older browsers. In this case the polyfill falls back to
34 | `mediation: 'optional'` and warns the developers about doing so via a console
35 | message.
36 | 
37 | ### Asynchronous creation of `Credential` objects
38 | It is now possible to create `Credential` objects asynchronously using
39 | `navigator.credentials.create`. This returns a `Promise` which will resolve to a
40 | `Credential` object if successful.
41 | 
42 | Currently, both `password` and `federated` are supported as keys, which will
43 | try to create a `PasswordCredential` or `FederatedCredential`.
44 | 
45 | Example Use:
46 | ``` js
47 | let cred = await navigator.credentials.create({password: {
48 |   id: "Foo",
49 |   password: "Bar",
50 | }});
51 | ```
52 | 
53 | ## Unsupported Features
54 | While the Credential Management API provides access to the `password` property
55 | of `PasswordCredential` for recent browser versions, this can not be polyfilled
56 | and is not supported for older browsers.
57 | 
58 | For this use case it is suggested to detect whether access to passwords is
59 | possible or not and dispatch accordingly.
60 | 
61 | Example Code:
62 | ``` js
63 | let cred = await navigator.credentials.get({password: true});
64 | if (cred.password !== undefined) {
65 |   let body = {id: cred.id, password: cred.password};
66 |   fetch('my_endpoint.html', {body : body}).then(result => {
67 |       // Handle server response.
68 |   });
69 | } else {
70 |   fetch('my_endpoint.html', {credentials: cred}).then(result => {
71 |       // Handle server response.
72 |   });
73 | }
74 | ```
75 | 


--------------------------------------------------------------------------------
/cm-api-shim.js:
--------------------------------------------------------------------------------
  1 | // Copyright 2017 Google Inc.
  2 | //
  3 | // Licensed under the Apache License, Version 2.0 (the "License");
  4 | // you may not use this file except in compliance with the License.
  5 | // You may obtain a copy of the License at
  6 | //
  7 | //      http://www.apache.org/licenses/LICENSE-2.0
  8 | //
  9 | // Unless required by applicable law or agreed to in writing, software
 10 | // distributed under the License is distributed on an "AS IS" BASIS,
 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 | // See the License for the specific language governing permissions and
 13 | // limitations under the License.
 14 | 
 15 | // This file includes polyfills for recent features added to the Credential
 16 | // Management API.
 17 | 
 18 | (function() {
 19 |   // Return early if CM API is not available or the new features are already
 20 |   // present.
 21 |   if (!navigator.credentials || navigator.credentials.preventSilentAccess)
 22 |     return;
 23 | 
 24 |   // Polyfill for navigator.credentials.preventSilentAccess.
 25 |   navigator.credentials.preventSilentAccess =
 26 |       navigator.credentials.requireUserMediation;
 27 | 
 28 |   // Polyfill for navigator.credentials.get supporting a mediation enum.
 29 |   var oldGet = navigator.credentials.get.bind(navigator.credentials);
 30 |   navigator.credentials.get = function(options) {
 31 |     // If mediation is specified, check whether it contains a valid value and
 32 |     // raise a TypeError otherwise.
 33 |     var validOptions = ['silent', 'optional', 'required'];
 34 |     if (options['mediation'] &&
 35 |         validOptions.indexOf(options['mediation']) === -1) {
 36 |       throw new TypeError(
 37 |           "The provided value '" + options['mediation'] +
 38 |           "' is not a valid enum value.");
 39 |     }
 40 | 
 41 |     // mediation: 'required' can not be supported in older browsers, so fall
 42 |     // back to 'optional' and issue a warning.
 43 |     if (options['mediation'] === 'required') {
 44 |       console.warn(
 45 |           "mediation: 'required' can not be supported in older browsers, " +
 46 |           "using mediation: 'optional' instead.");
 47 |     }
 48 | 
 49 |     options['unmediated'] = options['mediation'] === 'silent';
 50 |     return oldGet(options);
 51 |   }
 52 | 
 53 |   // Polyfill for Credential Management API's navigator.credentials.create.
 54 |   // Other APIs might define this method already, in which case we need to cache
 55 |   // the original version.
 56 |   if (navigator.credentials.create) {
 57 |     var oldCreate = navigator.credentials.create.bind(navigator.credentials);
 58 |   }
 59 | 
 60 |   navigator.credentials.create = function(options) {
 61 |     // Check whether exactly one option is specified, reject the Promise
 62 |     // otherwise.
 63 |     if (Object.keys(options).length !== 1) {
 64 |       return Promise.reject('NotSupportedError: Only exactly one credential ' +
 65 |           'option is currently supported.');
 66 |     }
 67 | 
 68 | 
 69 |     // Dispatch to the appropriate constructors for 'password' and
 70 |     // 'federated' if applicable.
 71 |     if ('password' in options && window.PasswordCredential) {
 72 |       return new Promise(function(resolve, reject) {
 73 |         try {
 74 |           resolve(new PasswordCredential(options['password']));
 75 |         } catch (e) {
 76 |           reject(e);
 77 |         }
 78 |       });
 79 |     }
 80 | 
 81 |     if ('federated' in options && window.FederatedCredential) {
 82 |       return new Promise(function(resolve, reject) {
 83 |         try {
 84 |           resolve(new FederatedCredential(options['federated']));
 85 |         } catch (e) {
 86 |           reject(e);
 87 |         }
 88 |       });
 89 |     }
 90 | 
 91 |     // Dispatch to old create if possible, otherwise reject anything else.
 92 |     if (oldCreate) {
 93 |       return oldCreate(options);
 94 |     }
 95 | 
 96 |     return Promise.reject('NotSupportedError: No valid credential option ' +
 97 |         'was specified.');
 98 |   };
 99 | }());
100 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | 
  2 |                                  Apache License
  3 |                            Version 2.0, January 2004
  4 |                         http://www.apache.org/licenses/
  5 | 
  6 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  7 | 
  8 |    1. Definitions.
  9 | 
 10 |       "License" shall mean the terms and conditions for use, reproduction,
 11 |       and distribution as defined by Sections 1 through 9 of this document.
 12 | 
 13 |       "Licensor" shall mean the copyright owner or entity authorized by
 14 |       the copyright owner that is granting the License.
 15 | 
 16 |       "Legal Entity" shall mean the union of the acting entity and all
 17 |       other entities that control, are controlled by, or are under common
 18 |       control with that entity. For the purposes of this definition,
 19 |       "control" means (i) the power, direct or indirect, to cause the
 20 |       direction or management of such entity, whether by contract or
 21 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 22 |       outstanding shares, or (iii) beneficial ownership of such entity.
 23 | 
 24 |       "You" (or "Your") shall mean an individual or Legal Entity
 25 |       exercising permissions granted by this License.
 26 | 
 27 |       "Source" form shall mean the preferred form for making modifications,
 28 |       including but not limited to software source code, documentation
 29 |       source, and configuration files.
 30 | 
 31 |       "Object" form shall mean any form resulting from mechanical
 32 |       transformation or translation of a Source form, including but
 33 |       not limited to compiled object code, generated documentation,
 34 |       and conversions to other media types.
 35 | 
 36 |       "Work" shall mean the work of authorship, whether in Source or
 37 |       Object form, made available under the License, as indicated by a
 38 |       copyright notice that is included in or attached to the work
 39 |       (an example is provided in the Appendix below).
 40 | 
 41 |       "Derivative Works" shall mean any work, whether in Source or Object
 42 |       form, that is based on (or derived from) the Work and for which the
 43 |       editorial revisions, annotations, elaborations, or other modifications
 44 |       represent, as a whole, an original work of authorship. For the purposes
 45 |       of this License, Derivative Works shall not include works that remain
 46 |       separable from, or merely link (or bind by name) to the interfaces of,
 47 |       the Work and Derivative Works thereof.
 48 | 
 49 |       "Contribution" shall mean any work of authorship, including
 50 |       the original version of the Work and any modifications or additions
 51 |       to that Work or Derivative Works thereof, that is intentionally
 52 |       submitted to Licensor for inclusion in the Work by the copyright owner
 53 |       or by an individual or Legal Entity authorized to submit on behalf of
 54 |       the copyright owner. For the purposes of this definition, "submitted"
 55 |       means any form of electronic, verbal, or written communication sent
 56 |       to the Licensor or its representatives, including but not limited to
 57 |       communication on electronic mailing lists, source code control systems,
 58 |       and issue tracking systems that are managed by, or on behalf of, the
 59 |       Licensor for the purpose of discussing and improving the Work, but
 60 |       excluding communication that is conspicuously marked or otherwise
 61 |       designated in writing by the copyright owner as "Not a Contribution."
 62 | 
 63 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 64 |       on behalf of whom a Contribution has been received by Licensor and
 65 |       subsequently incorporated within the Work.
 66 | 
 67 |    2. Grant of Copyright License. Subject to the terms and conditions of
 68 |       this License, each Contributor hereby grants to You a perpetual,
 69 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 70 |       copyright license to reproduce, prepare Derivative Works of,
 71 |       publicly display, publicly perform, sublicense, and distribute the
 72 |       Work and such Derivative Works in Source or Object form.
 73 | 
 74 |    3. Grant of Patent License. Subject to the terms and conditions of
 75 |       this License, each Contributor hereby grants to You a perpetual,
 76 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 77 |       (except as stated in this section) patent license to make, have made,
 78 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 79 |       where such license applies only to those patent claims licensable
 80 |       by such Contributor that are necessarily infringed by their
 81 |       Contribution(s) alone or by combination of their Contribution(s)
 82 |       with the Work to which such Contribution(s) was submitted. If You
 83 |       institute patent litigation against any entity (including a
 84 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 85 |       or a Contribution incorporated within the Work constitutes direct
 86 |       or contributory patent infringement, then any patent licenses
 87 |       granted to You under this License for that Work shall terminate
 88 |       as of the date such litigation is filed.
 89 | 
 90 |    4. Redistribution. You may reproduce and distribute copies of the
 91 |       Work or Derivative Works thereof in any medium, with or without
 92 |       modifications, and in Source or Object form, provided that You
 93 |       meet the following conditions:
 94 | 
 95 |       (a) You must give any other recipients of the Work or
 96 |           Derivative Works a copy of this License; and
 97 | 
 98 |       (b) You must cause any modified files to carry prominent notices
 99 |           stating that You changed the files; and
100 | 
101 |       (c) You must retain, in the Source form of any Derivative Works
102 |           that You distribute, all copyright, patent, trademark, and
103 |           attribution notices from the Source form of the Work,
104 |           excluding those notices that do not pertain to any part of
105 |           the Derivative Works; and
106 | 
107 |       (d) If the Work includes a "NOTICE" text file as part of its
108 |           distribution, then any Derivative Works that You distribute must
109 |           include a readable copy of the attribution notices contained
110 |           within such NOTICE file, excluding those notices that do not
111 |           pertain to any part of the Derivative Works, in at least one
112 |           of the following places: within a NOTICE text file distributed
113 |           as part of the Derivative Works; within the Source form or
114 |           documentation, if provided along with the Derivative Works; or,
115 |           within a display generated by the Derivative Works, if and
116 |           wherever such third-party notices normally appear. The contents
117 |           of the NOTICE file are for informational purposes only and
118 |           do not modify the License. You may add Your own attribution
119 |           notices within Derivative Works that You distribute, alongside
120 |           or as an addendum to the NOTICE text from the Work, provided
121 |           that such additional attribution notices cannot be construed
122 |           as modifying the License.
123 | 
124 |       You may add Your own copyright statement to Your modifications and
125 |       may provide additional or different license terms and conditions
126 |       for use, reproduction, or distribution of Your modifications, or
127 |       for any such Derivative Works as a whole, provided Your use,
128 |       reproduction, and distribution of the Work otherwise complies with
129 |       the conditions stated in this License.
130 | 
131 |    5. Submission of Contributions. Unless You explicitly state otherwise,
132 |       any Contribution intentionally submitted for inclusion in the Work
133 |       by You to the Licensor shall be under the terms and conditions of
134 |       this License, without any additional terms or conditions.
135 |       Notwithstanding the above, nothing herein shall supersede or modify
136 |       the terms of any separate license agreement you may have executed
137 |       with Licensor regarding such Contributions.
138 | 
139 |    6. Trademarks. This License does not grant permission to use the trade
140 |       names, trademarks, service marks, or product names of the Licensor,
141 |       except as required for reasonable and customary use in describing the
142 |       origin of the Work and reproducing the content of the NOTICE file.
143 | 
144 |    7. Disclaimer of Warranty. Unless required by applicable law or
145 |       agreed to in writing, Licensor provides the Work (and each
146 |       Contributor provides its Contributions) on an "AS IS" BASIS,
147 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 |       implied, including, without limitation, any warranties or conditions
149 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 |       PARTICULAR PURPOSE. You are solely responsible for determining the
151 |       appropriateness of using or redistributing the Work and assume any
152 |       risks associated with Your exercise of permissions under this License.
153 | 
154 |    8. Limitation of Liability. In no event and under no legal theory,
155 |       whether in tort (including negligence), contract, or otherwise,
156 |       unless required by applicable law (such as deliberate and grossly
157 |       negligent acts) or agreed to in writing, shall any Contributor be
158 |       liable to You for damages, including any direct, indirect, special,
159 |       incidental, or consequential damages of any character arising as a
160 |       result of this License or out of the use or inability to use the
161 |       Work (including but not limited to damages for loss of goodwill,
162 |       work stoppage, computer failure or malfunction, or any and all
163 |       other commercial damages or losses), even if such Contributor
164 |       has been advised of the possibility of such damages.
165 | 
166 |    9. Accepting Warranty or Additional Liability. While redistributing
167 |       the Work or Derivative Works thereof, You may choose to offer,
168 |       and charge a fee for, acceptance of support, warranty, indemnity,
169 |       or other liability obligations and/or rights consistent with this
170 |       License. However, in accepting such obligations, You may act only
171 |       on Your own behalf and on Your sole responsibility, not on behalf
172 |       of any other Contributor, and only if You agree to indemnify,
173 |       defend, and hold each Contributor harmless for any liability
174 |       incurred by, or claims asserted against, such Contributor by reason
175 |       of your accepting any such warranty or additional liability.
176 | 
177 |    END OF TERMS AND CONDITIONS
178 | 
179 |    APPENDIX: How to apply the Apache License to your work.
180 | 
181 |       To apply the Apache License to your work, attach the following
182 |       boilerplate notice, with the fields enclosed by brackets "[]"
183 |       replaced with your own identifying information. (Don't include
184 |       the brackets!)  The text should be enclosed in the appropriate
185 |       comment syntax for the file format. We also recommend that a
186 |       file or class name and description of purpose be included on the
187 |       same "printed page" as the copyright notice for easier
188 |       identification within third-party archives.
189 | 
190 |    Copyright [yyyy] [name of copyright owner]
191 | 
192 |    Licensed under the Apache License, Version 2.0 (the "License");
193 |    you may not use this file except in compliance with the License.
194 |    You may obtain a copy of the License at
195 | 
196 |        http://www.apache.org/licenses/LICENSE-2.0
197 | 
198 |    Unless required by applicable law or agreed to in writing, software
199 |    distributed under the License is distributed on an "AS IS" BASIS,
200 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 |    See the License for the specific language governing permissions and
202 |    limitations under the License.
203 | 


--------------------------------------------------------------------------------