Webserver for ioBroker adapters

Description

This module provides a webserver, which automatically takes care of
certificate handling using the ioBroker certificates.

How-To

Install via npm i @iobroker/webserver.

Use the webserver in your ioBroker adapter as the following:

- TypeScript:

``typescript
import { WebServer } from '@iobroker/webserver';

const webServer = new WebServer({ app, adapter, secure: true });

// initialize and you can use your server as known
const server = await webServer.init();
`

- JavaScript:

`javascript
const { WebServer } = require('@iobroker/webserver');

const webServer = new WebServer({ app, adapter, secure: true });

// initialize and you can use your server as known
const server = await webServer.init();
`

And so you can use CertificateManager that is used in the WebServer already:

- TypeScript:

`typescript
import { CertificateManager } from '@iobroker/webserver';

// Not required for server
const certManager = new CertificateManager({ adapter });

// get all collections
const collections = await certManager.getAllCollections();
`

- JavaScript:

`javascript
const { CertificateManager } = require('@iobroker/webserver');

// Not required for server
const certManager = new CertificateManager({ adapter });

// get all collections
const collections = await certManager.getAllCollections();
`

OAuth2 support

`typescript
// ... initialization of the webserver
this.webServer.app.use(cookieParser());
this.webServer.app.use(bodyParser.urlencoded({ extended: true }));
this.webServer.app.use(bodyParser.json());
this.webServer.app.use(bodyParser.text());

// Install oauth2 server (Only this line is required)
createOAuth2Server(this, { app: this.webServer.app, secure: this.config.secure, withSession: true });

// Old authentication method
this.webServer.app.use(
session({
secret: this.secret,
saveUninitialized: true,
resave: true,
cookie: { maxAge: (parseInt(this.config.ttl as string, 10) || 3600) * 1000, httpOnly: false }, // default TTL
// @ts-expect-error missing typing
store: this.store!,
}),
);
`

If you want to completely disable old authentication method, the code should looks like:
`typescript
// ... initialization of the webserver
this.webServer.app.use(cookieParser());
this.webServer.app.use(bodyParser.urlencoded({ extended: true }));
this.webServer.app.use(bodyParser.json());
this.webServer.app.use(bodyParser.text());

// Install oauth2 server (Only this line is required)
createOAuth2Server(this, { app: this.webServer.app, secure: this.config.secure });
`

Login with OAuth2 is available under /oauth/token URL:

`http
POST /oauth/token HTTP/1.1
Host: IP:PORT
Content-Type: application/x-www-form-urlencoded
Data: grant_type=password&username=&password=&client_id=ioBroker&stayloggedin=
`
stayloggedin=true means that the token will be stored in the browser and will be used for the next requests and is optional.

The answer is like:
`json
{
"access_token": "21f89e3eee32d3af08a71c1cc44ec72e0e3014a9",
"expires_in": 3600,
"refresh_token": "66d35faa5d53ca8242cfe57367210e76b7ffded7",
"refresh_token_expires_in": "600000",
"token_type": "Bearer"
}
`

Refresh token is available under /oauth/token URL:

`http
POST /oauth/token HTTP/1.1
Host: IP:PORT
Content-Type: application/x-www-form-urlencoded
Data: grant_type=refresh_token&refresh_token=&client_id=ioBroker&stayloggedin=
`

The answer is the same as for the login but with new tokens.

Changelog

$3

- (@GermanBluefox) Added access control options for server
- (@GermanBluefox) Used @iobroker/eslint-config for linting

$3

- (@GermanBluefox) Extend the security checker with the pattern detection and custom URL

$3

- (@GermanBluefox) Changed the error text of the security checker

$3

- (@GermanBluefox) added the security checker

$3

- (raintonr) Fix contexts for SNICallback (#3).

$3

- (@GermanBluefox) Update packages

$3

- (@GermanBluefox) Corrected small error with CA certificate

$3

- (@GermanBluefox) Added check of the cert files

$3

- (@GermanBluefox) Corrected error with getCertificatesAsync

$3

- (@GermanBluefox) Added support for user-configured certificates for fallback

$3

- (@GermanBluefox) Rename Webserver to WebServer`

$3

- (foxriver76) initial release based on https://github.com/ioBroker/ioBroker.js-controller/pull/2104 by @raintonr