n8n/packages/nodes-base/nodes/Bitwarden/GenericFunctions.ts
Omar Ajoue 7ce7285f7a
Load credentials from the database (#1741)
* Changes to types so that credentials can be always loaded from DB

This first commit changes all return types from the execute functions
and calls to get credentials to be async so we can use await.

This is a first step as previously credentials were loaded in memory and
always available. We will now be loading them from the DB which requires
turning the whole call chain async.

* Fix updated files

* Removed unnecessary credential loading to improve performance

* Fix typo

*  Fix issue

* Updated new nodes to load credentials async

*  Remove not needed comment

Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-08-20 18:57:30 +02:00

161 lines
3.8 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodePropertyOptions,
NodeApiError,
} from 'n8n-workflow';
import {
OptionsWithUri,
} from 'request';
/**
* Make an authenticated API request to Bitwarden.
*/
export async function bitwardenApiRequest(
this: IExecuteFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
qs: IDataObject,
body: IDataObject,
token: string,
): Promise<any> { // tslint:disable-line:no-any
const baseUrl = await getBaseUrl.call(this);
const options: OptionsWithUri = {
headers: {
'user-agent': 'n8n',
Authorization: `Bearer ${token}`,
'Content-Type': 'application/json',
},
method,
qs,
body,
uri: `${baseUrl}${endpoint}`,
json: true,
};
if (!Object.keys(body).length) {
delete options.body;
}
if (!Object.keys(qs).length) {
delete options.qs;
}
try {
return await this.helpers.request!(options);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
/**
* Retrieve the access token needed for every API request to Bitwarden.
*/
export async function getAccessToken(
this: IExecuteFunctions | ILoadOptionsFunctions,
): Promise<any> { // tslint:disable-line:no-any
const credentials = await this.getCredentials('bitwardenApi') as IDataObject;
const options: OptionsWithUri = {
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
method: 'POST',
form: {
client_id: credentials.clientId,
client_secret: credentials.clientSecret,
grant_type: 'client_credentials',
scope: 'api.organization',
deviceName: 'n8n',
deviceType: 2, // https://github.com/bitwarden/server/blob/master/src/Core/Enums/DeviceType.cs
deviceIdentifier: 'n8n',
},
uri: await getTokenUrl.call(this),
json: true,
};
try {
const { access_token } = await this.helpers.request!(options);
return access_token;
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
/**
* Supplement a `getAll` operation with `returnAll` and `limit` parameters.
*/
export async function handleGetAll(
this: IExecuteFunctions,
i: number,
method: string,
endpoint: string,
qs: IDataObject,
body: IDataObject,
token: string,
) {
const responseData = await bitwardenApiRequest.call(this, method, endpoint, qs, body, token);
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
if (returnAll) {
return responseData.data;
} else {
const limit = this.getNodeParameter('limit', i) as number;
return responseData.data.slice(0, limit);
}
}
/**
* Return the access token URL based on the user's environment.
*/
async function getTokenUrl(this: IExecuteFunctions | ILoadOptionsFunctions) {
const { environment, domain } = await this.getCredentials('bitwardenApi') as IDataObject;
return environment === 'cloudHosted'
? 'https://identity.bitwarden.com/connect/token'
: `${domain}/identity/connect/token`;
}
/**
* Return the base API URL based on the user's environment.
*/
async function getBaseUrl(this: IExecuteFunctions | ILoadOptionsFunctions) {
const { environment, domain } = await this.getCredentials('bitwardenApi') as IDataObject;
return environment === 'cloudHosted'
? 'https://api.bitwarden.com'
: `${domain}/api`;
}
/**
* Load a resource so that it can be selected by name from a dropdown.
*/
export async function loadResource(
this: ILoadOptionsFunctions,
resource: string,
) {
const returnData: INodePropertyOptions[] = [];
const token = await getAccessToken.call(this);
const endpoint = `/public/${resource}`;
const { data } = await bitwardenApiRequest.call(this, 'GET', endpoint, {}, {}, token);
data.forEach(({ id, name, externalId }: { id: string, name: string, externalId?: string }) => {
returnData.push({
name: externalId || name || id,
value: id,
});
});
return returnData;
}