# authentik

> Express.js JWT authentication middleware

Latest version **0.0.4** (published 2018-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install authentik
pnpm add authentik
yarn add authentik
bun add authentik
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2018-08-29 |
| First published | 2018-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 11.1 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Erickson G. Pece |
| Maintainers | avodacs |

## Links

- npm: https://www.npmjs.com/package/authentik
- Repository: https://github.com/avodacs/authentik
- Homepage: https://github.com/avodacs/authentik#readme
- Issues: https://github.com/avodacs/authentik/issues
- npm.io page: https://npm.io/package/authentik

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^3.1.0
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^8.3.0

## Recent versions

- 0.0.4 (latest) — 2018-08-29
- 0.0.3 — 2018-08-29
- 0.0.2 — 2018-08-29
- 0.0.1 — 2018-08-29

## README

# authentik

Express.js JWT authentication middleware

## Configuration

### JWT Options

When creating an instance of `Authentik`, the second parameter is an array of configuration options.  To pass options directly to the `jsonwebtoken` dependency, include a key of `jwtOptions` with children specific to the options listed in this package:

https://www.npmjs.com/package/jsonwebtoken

## Examples

### Creating token

#### Built in basic username, password authentication

```js
let authentik = require('authentik');

(async () => {
  authentik.config(
    'my-secret-token',        // JWT Secret
    {
      basicAuth: {            // Basic authentication provided by Authentik
        username: 'admin',    // Expected Username
        password: 'password'  // Expected Password
      },
      jwtOptions: {           // jsonwebtoken options
        expiresIn: '1h'
      }
    }
  );

  let authenticated = await authentik.login('admin', 'password');
})();
```

If successful, the response is:

```js
{
  err: null,
  token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImVyaWNrIiwiaWF0IjoxNTM1NTU4NzY2LCJleHAiOjE1MzU1NjIzNjZ9.mf2txDsxaGaaO14yLOn5tX0dYl3lEhJZijZoQcoY9xU'
}
```

If unsuccessful, the response is:

```js
{
  err: 'Username and/or password invalid!',
  token: null
}
```

#### Override authentication method

The default authentication method provides very basic username and password matching.  If you want to extend `Authentik` to work with your own authentication mechanism, you can override the `authenticate` method:

```js
let Authentik = require('authentik');

(async () => {
  const customAuth = (sharedSecret) => {
    return new Promise((resolve, reject) => {
      if (sharedSecret === 'lorem') {
        let data = {
          anything: 'else',
          you: 'want',
          to: 'include'
        };

        return resolve({
          err: null,
          authenticated: true,
          data
        });
      }

      return resolve({
        err: 'Total failure',
        authenticated: false
      });
    });
  };

  authentik.config(
    'my-secret-token',        // JWT Secret
    {
      jwtOptions: {           // jsonwebtoken options
        expiresIn: '1h'
      },
      customAuthenticationFunction: customAuth
    }
  );

  let authenticated = await authentik.login('lorem');
})();
```

If successful, the response is:

```js
{
  err: null,
  token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImVyaWNrIiwiaWF0IjoxNTM1NTU4NzY2LCJleHAiOjE1MzU1NjIzNjZ9.mf2txDsxaGaaO14yLOn5tX0dYl3lEhJZijZoQcoY9xU'
}
```

If unsuccessful, the response is:

```js
{
  err: 'Total failure',
  token: null
}
```

### Verifying token

Include the `authentik.verify` middleware in your route to handle authentication.  If the authentication is invalid, express will return a `401` response.

```
app.get('/protected', authentik.verify, (req, res) => {}
```

The decoded token is available in the request as `req.authentik`.

```js
const authentik = require('authentik');
const express = require('express');

const app = express();

authentik.config(
  'my-secret-token',        // JWT Secret
  {
    basicAuth: {            // Basic authentication provided by Authentik
      username: 'admin',    // Expected Username
      password: 'password'  // Expected Password
    },
    jwtOptions: {           // jsonwebtoken options
      expiresIn: '1h'
    }
  }
);

app.post('/login', async (req, res) => {
  // TODO: In real life, get this from the body
  let authed = await authentik.login('admin', 'password');

  res.json(authed);
});

app.get('/protected', authentik.verify, (req, res) => {
  res.json(req.authentik);
})

app.listen(3000, () => {
  console.log('app listening on 3000');
})
```

## Debugging

`Authentik` makes use of the `debug` package.  To include debugging output, include `DEBUG=authentik*` in your environment.

## TODO

* Full testing

---
_Source: https://npm.io/package/authentik · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._