Constructor for creating a new no key found error
+Generated using TypeDoc
+hostname of the keyserver
+port of the keyserver
+base path where to find the keyserver (the path before /pks, usually nothing)
Base path for the keyserver (where the /pks paths start), (default: '')
The keyserver's raw stats html
+Request options for a query to the keyserver
Retrieves the server's key stats and returns a PromiseparseKeyStatsHtml).
Retrieves the server's key stats and returns a PromiseparseKeyStatsHtml)
Retrieves the keyserver's html and returns it as Promise
relative path to request, usually starts with /pks
Retrieves the server's stats and returns a PromiseparseStatsHtml).
Retrieves the server's stats and returns a PromiseparseStatsHtml)
Retrieves the keyserver's stats html if necessary and then returns it as Promise
Retrieves the keyserver's stats html and returns it as Promise
Retrieves a key by a given query, throws NoKeyFoundError
+query to look up
+Maps the keyserver's html to a generic promise.
+Maps the keyserver's html to a generic promise
function to transform HTML into a generic object
+Uploads a public key onto a keyserver
+public key to upload
+Checks whether a given input is a PGP key
+input to check
+Parses given html into a KeyStats object, throws ParseError.
+Parses given html into a KeyStats object, throws ParseError
HTML to parse, usually from a keyserver's stats page
+Parses given html into a Stats object, throws ParseError.
+Parses given html into a Stats object, throws ParseError
HTML to parse, usually from a keyserver's stats page
+sks-lib is a Typescript library for interacting with SKS keyservers. Currently there's only support for retrieving a keyserver's stats.
sks-lib is a Typescript library for interacting with SKS keyservers. Currently there's only support for retrieving statistics of a keyserver.
Please note that keyservers never return verified data. Do not trust the retrieved keys and always verify them.
Just add it with yarn install sks-lib (or npm install sks-lib) to your project. It ships the generated Javascript code along with Typescript's declaration files. The Typescript code itself lives in lib/.
import {Keyserver} from 'sks-lib';
-import {Moment} from 'moment';
-
-
+ Usage
+ // Create a new keyserver object to query on
var keyserver = new Keyserver('keyserver.ntzwrk.org');
-keyserver.getStats().then(
- (stats) => {
- var hostName = stats.hostName;
- var software = stats.software;
- var version = stats.version;
- var peerCount = stats.gossipPeerCount;
+var somePublicKey: string;
- console.log('"%s" is a %s %s keyserver with %s gossip peers.', hostName, software, version, peerCount);
+// Lookup the key for "vsund" and then print it
+keyserver.lookup('vsund').then(
+ (key) => {
+ somePublicKey = key;
+ console.log(key);
}
-).catch((reason: Error) => {
- console.log('Could not connect to "%s:11371"', keyserver.hostName);
- console.log('%s: %s', reason.name, reason.message);
-});
+);
-keyserver.getKeyStats().then(
- (keyStats) => {
- var hostName = keyserver.hostName;
- var totalKeys = keyStats.totalKeys;
- var newKeys = keyStats.dailyKeys[11].newKeys;
- var date = keyStats.dailyKeys[11].dateTime.format('MMMM Do YYYY');
+// Upload the previously fetched key and print the server's response
+keyserver.upload(publicKey).then(
+ (response) => {
+ console.log(response);
+ }
+);
- console.log('"%s" has %s total keys and saw %s new keys on %s.', hostName, totalKeys, newKeys, date);
+// Get stats and then print some information
+keyserver.getStats().then(
+ (stats) => {
+ console.log('"%s" is a %s keyserver on version %s.', stats.hostName, stats.software, stats.version);
}
-).catch((reason: Error) => {
- console.log('Could not connect to "%s:11371"', keyserver.hostName);
- console.log('%s: %s', reason.name, reason.message);
-});
+);
+ See examples/ for some more examples.
Documentation
Code documentation lives in docs/code/, the generated HTML version is available at https://ntzwrk.github.io/sks-lib/code/.
Development
@@ -137,13 +132,13 @@ License
Globals
Class representing an error that no key could been found
+