7f37a8aaca
Refactor functions to take the configuration as a parameter.
This allows setting a config option for a single function call, whereas
setting `openpgp.config` could lead to concurrency-related issues when
multiple async function calls are made at the same time.
`openpgp.config` is used as default for unset config values in top-level
functions.
`openpgp.config` is used as default config object in low-level functions
(i.e., when calling a low-level function, it may be required to pass
`{ ...openpgp.config, modifiedConfig: modifiedValue }`).
Also,
- remove `config.rsaBlinding`: blinding is now always applied to RSA decryption
- remove `config.debug`: debugging mode can be enabled by setting
`process.env.NODE_ENV = 'development'`
- remove `config.useNative`: native crypto is always used when available
92 lines
3.2 KiB
JavaScript
92 lines
3.2 KiB
JavaScript
// OpenPGP.js - An OpenPGP implementation in javascript
|
|
// Copyright (C) 2015 Tankred Hase
|
|
//
|
|
// This library is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
// License as published by the Free Software Foundation; either
|
|
// version 3.0 of the License, or (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License along with this library; if not, write to the Free Software
|
|
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
/**
|
|
* @fileoverview This class implements a client for the OpenPGP HTTP Keyserver Protocol (HKP)
|
|
* in order to lookup and upload keys on standard public key servers.
|
|
* @module hkp
|
|
*/
|
|
|
|
import defaultConfig from './config';
|
|
|
|
class HKP {
|
|
/**
|
|
* Initialize the HKP client and configure it with the key server url and fetch function.
|
|
* @param {String} keyServerBaseUrl (optional) The HKP key server base url including
|
|
* the protocol to use, e.g. 'https://pgp.mit.edu'; defaults to
|
|
* openpgp.config.keyserver (https://keyserver.ubuntu.com)
|
|
* @param {Object} config (optional) full configuration, defaults to openpgp.config
|
|
*/
|
|
constructor(keyServerBaseUrl, config = defaultConfig) {
|
|
this._baseUrl = keyServerBaseUrl || config.keyserver;
|
|
this._fetch = typeof globalThis.fetch === 'function' ? globalThis.fetch : require('node-fetch');
|
|
}
|
|
|
|
/**
|
|
* Search for a public key on the key server either by key ID or part of the user ID.
|
|
* @param {String} options.keyId The long public key ID.
|
|
* @param {String} options.query This can be any part of the key user ID such as name
|
|
* or email address.
|
|
* @returns {Promise<String>} The ascii armored public key.
|
|
* @async
|
|
*/
|
|
lookup(options) {
|
|
let uri = this._baseUrl + '/pks/lookup?op=get&options=mr&search=';
|
|
const fetch = this._fetch;
|
|
|
|
if (options.keyId) {
|
|
uri += '0x' + encodeURIComponent(options.keyId);
|
|
} else if (options.query) {
|
|
uri += encodeURIComponent(options.query);
|
|
} else {
|
|
throw new Error('You must provide a query parameter!');
|
|
}
|
|
|
|
return fetch(uri).then(function(response) {
|
|
if (response.status === 200) {
|
|
return response.text();
|
|
}
|
|
}).then(function(publicKeyArmored) {
|
|
if (!publicKeyArmored || publicKeyArmored.indexOf('-----END PGP PUBLIC KEY BLOCK-----') < 0) {
|
|
return;
|
|
}
|
|
return publicKeyArmored.trim();
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Upload a public key to the server.
|
|
* @param {String} publicKeyArmored An ascii armored public key to be uploaded.
|
|
* @returns {Promise}
|
|
* @async
|
|
*/
|
|
upload(publicKeyArmored) {
|
|
const uri = this._baseUrl + '/pks/add';
|
|
const fetch = this._fetch;
|
|
|
|
return fetch(uri, {
|
|
method: 'post',
|
|
headers: {
|
|
'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8'
|
|
},
|
|
body: 'keytext=' + encodeURIComponent(publicKeyArmored)
|
|
});
|
|
}
|
|
}
|
|
|
|
export default HKP;
|