balena-auth

balena-auth
-----------


Join our online chat at 

Balena session authentication utilities

Role
----

The intention of this module is to provide low level access to how a balena authentication tokens are parsed and persisted.

THIS MODULE IS LOW LEVEL AND IS NOT MEANT TO BE USED BY END USERS DIRECTLY.

Unless you know what you're doing, use the balena SDK instead.

Installation
------------

Install balena-auth by running:

``sh
$ npm install --save balena-auth
`

Documentation
-------------

The module returns a class that you use to get an instance of the auth module.

It accepts the following params:

| Param | Type | Description |
| --- | --- | --- |
| options | Object | options |
| [options.dataDirectory] | string \| false | the directory to use for storage in Node.js or false to create an isolated in memory instance. Values other than false are ignored in the browser. |
| [options.tokenKey] | string | the key used to store the last token in the storage. token by default. |

Example
`js
import BalenaAuth from 'balena-auth';
const auth = new BalenaAuth({
dataDirectory: '/opt/cache/balena',
tokenKey: 'token'
});
`


* auth
* ~setKey(key) ⇒ [ 'Promise' ].<void>
* ~hasKey() ⇒ [ 'Promise' ].<Boolean>
* ~removeKey() ⇒ Promise
* ~getType() ⇒ [ 'Promise' ].<TokenType>
* ~getKey() ⇒ [ 'Promise' ].<string>
* ~getAge() ⇒ [ 'Promise' ].<(number\|undefined)>
* ~isExpired() ⇒ [ 'Promise' ].<boolean>
* ~isValid() ⇒ [ 'Promise' ].<boolean>
* ~get2FAStatus() ⇒ [ 'Promise' ].<('not\_required'\|'pending'\|'passed')>
* ~needs2FA() ⇒ [ 'Promise' ].<boolean>

$3

Kind: inner method of auth
Summary: Set the key
Access: public

| Param | Type |
| --- | --- |
| key | String |

Example
`js
auth.setKey('...').then(() => { ... });
`


$3


Kind: inner method of auth
Summary: Has a key
Returns: [ 'Promise' ].<Boolean> - has key
Access: public
Example
`js
auth.hasKey().then((hasKey) => { ... });
`

$3

This promise is not rejected if there was no key at the time of removal.

Kind: inner method of auth
Summary: Remove the key
Access: public
Example
`js
auth.removeKey();
`


$3


Kind: inner method of auth
Summary: Gets the key type
Access: public
Example
`js
auth.getType().then((type) => { ... });
`

$3

Kind: inner method of auth
Summary: Gets the key
Access: public
Example
`js
auth.getKey().then((key) => { ... });
`

$3

Kind: inner method of auth
Summary: Gets the token age
Access: public
Example
`js
auth.getAge().then((age) => { ... });
`

$3

Kind: inner method of auth
Summary: Checks if token is expired
Access: public
Example
`js
auth.isExpired().then((expired) => { ... });
`

$3

Kind: inner method of auth
Summary: Checks if token format is valid
Access: public
Example
`js
auth.isValid().then((valid) => { ... });
`

$3

Kind: inner method of auth
Summary: Gets whether passing a 2FA challenge is pending, passed or not required.
Access: public
Example
`js
auth.get2FAStatus().then((get2FAStatus) => { ... });
`

$3

Kind: inner method of auth
Summary: Checks whether passing 2FA is pending/needed
Access: public
Example
`js
auth.needs2FA().then((needs2FA) => { ... });
`

Support
-------

If you're having any problem, please raise an issue on GitHub and the balena team will be happy to help.

Tests
-----

Run the test suite by doing:

`sh
$ npm test
`

Contribute
----------

- Issue Tracker: github.com/balena-io-modules/balena-auth/issues
- Source Code: github.com/balena-io-modules/balena-auth

Before submitting a PR, please make sure that you include tests, and that tslint runs without any warning:

`sh
$ npm run lint
``

License
-------

The project is licensed under the Apache 2.0 license.