# sks-lib

[![npm package](https://img.shields.io/npm/v/sks-lib.svg)](https://www.npmjs.com/package/sks-lib) [![npm license](https://img.shields.io/npm/l/sks-lib.svg)](https://github.com/ntzwrk/sks-lib/blob/develop/LICENSE.md) [![code documentation](https://img.shields.io/badge/Code-documentation-blue.svg)](https://ntzwrk.github.io/sks-lib/code/)

<table>
	<tr>
		<td><tt><b>develop</b></tt></td>
		<td><a href="https://travis-ci.org/ntzwrk/sks-lib"><img src="https://img.shields.io/travis/ntzwrk/sks-lib/develop.svg" alt="Travis Build Status for develop"></a></td>
		<td><a href="https://david-dm.org/ntzwrk/sks-lib/develop"><img src="https://img.shields.io/david/ntzwrk/sks-lib/develop.svg" alt="Dependency Status for develop"></a></td>
	</tr>
	<tr>
		<td><tt><b>master</b></tt></td>
		<td><a href="https://travis-ci.org/ntzwrk/sks-lib"><img src="https://img.shields.io/travis/ntzwrk/sks-lib/master.svg" alt="Travis Build Status for master"></a></td>
		<td><a href="https://david-dm.org/ntzwrk/sks-lib/master"><img src="https://img.shields.io/david/ntzwrk/sks-lib/master.svg" alt="Dependency Status for master"></a></td>
	</tr>
</table>
<br />

`sks-lib` is a Typescript library for interacting with SKS keyservers. Currently there's support for looking up keys, uploading keys and retrieving statistics of a keyserver.

*Please note that keyservers never return verified data. Do **not** trust the retrieved keys and **always verify** them.*


## Installation

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/`.


## Usage

```ts
// Create a new keyserver object to query on
var keyserver = new Keyserver('keyserver.ntzwrk.org');

var somePublicKey: string;

// Lookup the key for "vsund" and then print it
keyserver.lookup('vsund').then(
	(key) => {
		somePublicKey = key;
		console.log(key);
	}
);

// Upload the previously fetched key and print the server's response
keyserver.upload(publicKey).then(
	(response) => {
		console.log(response);
	}
);

// 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);
	}
);
```

See [`examples/`](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

### Run tests
```bash
$ yarn test
```

### Generate documentation
```bash
$ yarn document
```


## License

This code is published under the [GNU General Public License v3.0](LICENSE.md).