Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add client credentials grant type to OAuth2 - N8N-3836 #3489

Merged
merged 9 commits into from
Jun 14, 2022
Merged

Add client credentials grant type to OAuth2 - N8N-3836 #3489

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a135d39
:zap: Add OAuth2 client credentials grant type
RicardoE105 Jun 6, 2022
8a9df7e
:zap: Improvements
RicardoE105 Jun 6, 2022
0c8a1e2
Merge master
RicardoE105 Jun 9, 2022
be50959
:zap: Improvements
RicardoE105 Jun 9, 2022
0ac9342
:bug: Fix linting issue
RicardoE105 Jun 9, 2022
ea7e582
:bug: Fix typo
RicardoE105 Jun 9, 2022
9e1323b
:bug: Fix small issue with type
RicardoE105 Jun 9, 2022
518a6dc
:bug: When token expire get a new one instead of refreshing it
RicardoE105 Jun 10, 2022
b2c0105
:zap: Fix issue that it did not display it correctly for OAuth1
janober Jun 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 38 additions & 9 deletions packages/core/src/NodeExecuteFunctions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ import {
WorkflowExecuteMode,
LoggerProxy as Logger,
IExecuteData,
OAuth2GranType,
IOAuth2Credentials,
} from 'n8n-workflow';

import { Agent } from 'https';
Expand Down Expand Up @@ -881,19 +883,46 @@ export async function requestOAuth2(
oAuth2Options?: IOAuth2Options,
isN8nRequest = false,
) {
const credentials = await this.getCredentials(credentialsType);
const credentials = (await this.getCredentials(credentialsType)) as unknown as IOAuth2Credentials;

if (credentials.oauthTokenData === undefined) {
// Only the OAuth2 with authorization code grant needs connection
if (
credentials.grantType === OAuth2GranType.authorizationCode &&
credentials.oauthTokenData === undefined
) {
throw new Error('OAuth credentials not connected!');
}

const oAuthClient = new clientOAuth2({
clientId: credentials.clientId as string,
clientSecret: credentials.clientSecret as string,
accessTokenUri: credentials.accessTokenUrl as string,
clientId: credentials.clientId,
clientSecret: credentials.clientSecret,
accessTokenUri: credentials.accessTokenUrl,
scopes: credentials.scope.split(' '),
});

const oauthTokenData = credentials.oauthTokenData as clientOAuth2.Data;
let oauthTokenData = credentials.oauthTokenData as clientOAuth2.Data;
// if it's the first time using the credentials, get the access token and save it into the DB.
if (credentials.grantType === OAuth2GranType.clientCredentials && oauthTokenData === undefined) {
const { data } = await oAuthClient.credentials.getToken();

// Find the credentials
if (!node.credentials || !node.credentials[credentialsType]) {
throw new Error(
`The node "${node.name}" does not have credentials of type "${credentialsType}"!`,
);
}

const nodeCredentials = node.credentials[credentialsType];

// Save the refreshed token
await additionalData.credentialsHelper.updateCredentials(
nodeCredentials,
credentialsType,
credentials as unknown as ICredentialDataDecryptedObject,
);

oauthTokenData = data;
}

const token = oAuthClient.createToken(
get(oauthTokenData, oAuth2Options?.property as string) || oauthTokenData.accessToken,
Expand Down Expand Up @@ -926,8 +955,8 @@ export async function requestOAuth2(

if (oAuth2Options?.includeCredentialsOnRefreshOnBody) {
const body: IDataObject = {
client_id: credentials.clientId as string,
client_secret: credentials.clientSecret as string,
client_id: credentials.clientId,
client_secret: credentials.clientSecret,
};
tokenRefreshOptions.body = body;
// Override authorization property so the credentails are not included in it
Expand Down Expand Up @@ -960,7 +989,7 @@ export async function requestOAuth2(
await additionalData.credentialsHelper.updateCredentials(
nodeCredentials,
credentialsType,
credentials,
credentials as unknown as ICredentialDataDecryptedObject,
);

Logger.debug(
Expand Down
2 changes: 1 addition & 1 deletion packages/editor-ui/src/components/CredentialEdit/CredentialEdit.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ export default mixins(showMessage, nodeHelpers).extend({
['oAuth1Api', 'oAuth2Api'].includes(this.credentialTypeName) ||
this.parentTypes.includes('oAuth1Api') ||
this.parentTypes.includes('oAuth2Api')
);
) && (this.credentialData.grantType === 'authorizationCode');
},
isOAuthConnected(): boolean {
return this.isOAuthType && !!this.credentialData.oauthTokenData;
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/AcuitySchedulingOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export class AcuitySchedulingOAuth2Api implements ICredentialType {
displayName = 'AcuityScheduling OAuth2 API';
documentationUrl = 'acuityScheduling';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/AsanaOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ export class AsanaOAuth2Api implements ICredentialType {
displayName = 'Asana OAuth2 API';
documentationUrl = 'asana';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/BitlyOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export class BitlyOAuth2Api implements ICredentialType {
'oAuth2Api',
];
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/BoxOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ export class BoxOAuth2Api implements ICredentialType {
displayName = 'Box OAuth2 API';
documentationUrl = 'box';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/CiscoWebexOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ export class CiscoWebexOAuth2Api implements ICredentialType {
];
displayName = 'Cisco Webex OAuth2 API';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/ClickUpOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ export class ClickUpOAuth2Api implements ICredentialType {
displayName = 'ClickUp OAuth2 API';
documentationUrl = 'clickUp';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/DriftOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export class DriftOAuth2Api implements ICredentialType {
displayName = 'Drift OAuth2 API';
documentationUrl = 'drift';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/DropboxOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ export class DropboxOAuth2Api implements ICredentialType {
displayName = 'Dropbox OAuth2 API';
documentationUrl = 'dropbox';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/EventbriteOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export class EventbriteOAuth2Api implements ICredentialType {
displayName = 'Eventbrite OAuth2 API';
documentationUrl = 'eventbrite';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/FormstackOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ export class FormstackOAuth2Api implements ICredentialType {
displayName = 'Formstack OAuth2 API';
documentationUrl = 'formstackTrigger';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/GetResponseOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ export class GetResponseOAuth2Api implements ICredentialType {
];
displayName = 'GetResponse OAuth2 API';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/GithubOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export class GithubOAuth2Api implements ICredentialType {
displayName = 'GitHub OAuth2 API';
documentationUrl = 'github';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Github Server',
name: 'server',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/GitlabOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export class GitlabOAuth2Api implements ICredentialType {
displayName = 'GitLab OAuth2 API';
documentationUrl = 'gitlab';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Gitlab Server',
name: 'server',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/GoToWebinarOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ export class GoToWebinarOAuth2Api implements ICredentialType {
displayName = 'GoToWebinar OAuth2 API';
documentationUrl = 'goToWebinar';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/GoogleOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export class GoogleOAuth2Api implements ICredentialType {
documentationUrl = 'google';
icon = 'file:Google.svg';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/HarvestOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ export class HarvestOAuth2Api implements ICredentialType {
];
displayName = 'Harvest OAuth2 API';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/HelpScoutOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ export class HelpScoutOAuth2Api implements ICredentialType {
displayName = 'HelpScout OAuth2 API';
documentationUrl = 'helpScout';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/HubspotDeveloperApi.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ export class HubspotDeveloperApi implements ICredentialType {
'oAuth2Api',
];
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/HubspotOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ export class HubspotOAuth2Api implements ICredentialType {
displayName = 'HubSpot OAuth2 API';
documentationUrl = 'hubspot';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/KeapOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ export class KeapOAuth2Api implements ICredentialType {
displayName = 'Keap OAuth2 API';
documentationUrl = 'keap';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/LineNotifyOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ export class LineNotifyOAuth2Api implements ICredentialType {
displayName = 'Line Notify OAuth2 API';
documentationUrl = 'line';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/LinkedInOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export class LinkedInOAuth2Api implements ICredentialType {
displayName = 'LinkedIn OAuth2 API';
documentationUrl = 'linkedIn';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Organization Support',
name: 'organizationSupport',
Expand Down
6 changes: 6 additions & 0 deletions packages/nodes-base/credentials/MailchimpOAuth2Api.credentials.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export class MailchimpOAuth2Api implements ICredentialType {
displayName = 'Mailchimp OAuth2 API';
documentationUrl = 'mailchimp';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
Expand Down
Loading