Skip to content

Commit

Permalink
⚡ Parse single-line private key for Google service account (n8n-io#2132)
Browse files Browse the repository at this point in the history 
* ⚡ Parse single-line private key

* ✏️ Update description and placeholder

* ⚡ Some improvements

Co-authored-by: Jan Oberhauser <[email protected]>
Co-authored-by: Jan Oberhauser <[email protected]>
  • Loading branch information
@ivov @janober
3 people authored Dec 24, 2021
1 parent 231c760 commit 26eac80
Show file tree
Hide file tree
Showing 9 changed files with 93 additions and 29 deletions.
6 changes: 3 additions & 3 deletions packages/nodes-base/credentials/GoogleApi.credentials.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ export class GoogleApi implements ICredentialType {
default: '',
description: 'The Google Service account similar to [email protected].',
required: true,

},
{
displayName: 'Private Key',
name: 'privateKey',
type: 'string',
default: '',
description: 'Use the multiline editor. Make sure there are exactly 3 lines.<br />-----BEGIN PRIVATE KEY-----<br />KEY IN A SINGLE LINE<br />-----END PRIVATE KEY-----',
placeholder: '-----BEGIN PRIVATE KEY-----\nXIYEvQIBADANBg<...>0IhA7TMoGYPQc=\n-----END PRIVATE KEY-----\n',
description: 'Enter the private key located in the JSON file downloaded from Google Cloud Console',
required: true,
},
{
displayName: ' Impersonate a User',
displayName: 'Impersonate a User',
name: 'inpersonate',
type: 'boolean',
default: false,
Expand Down
19 changes: 15 additions & 4 deletions packages/nodes-base/nodes/Google/Books/GenericFunctions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ import * as moment from 'moment-timezone';

import * as jwt from 'jsonwebtoken';

interface IGoogleAuthCredentials {
delegatedEmail?: string;
email: string;
inpersonate: boolean;
privateKey: string;
}

export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, headers: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const authenticationMethod = this.getNodeParameter('authentication', 0, 'serviceAccount') as string;
const options: OptionsWithUri = {
Expand All @@ -37,13 +44,16 @@ export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleF
}

if (authenticationMethod === 'serviceAccount') {
const credentials = await this.getCredentials('googleApi');
const credentials = await this.getCredentials('googleApi') as {
email: string;
privateKey: string;
};

if (credentials === undefined) {
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}

const { access_token } = await getAccessToken.call(this, credentials as IDataObject);
const { access_token } = await getAccessToken.call(this, credentials as unknown as IGoogleAuthCredentials);

options.headers!.Authorization = `Bearer ${access_token}`;
//@ts-ignore
Expand Down Expand Up @@ -78,7 +88,7 @@ export async function googleApiRequestAllItems(this: IExecuteFunctions | ILoadOp
return returnData;
}

function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, credentials: IDataObject): Promise<IDataObject> {
function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, credentials: IGoogleAuthCredentials): Promise<IDataObject> {
//https://developers.google.com/identity/protocols/oauth2/service-account#httprest

const scopes = [
Expand All @@ -87,7 +97,8 @@ function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoa

const now = moment().unix();

const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n');
credentials.email = credentials.email.trim();
const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n').trim();

const signature = jwt.sign(
{
Expand Down
14 changes: 11 additions & 3 deletions packages/nodes-base/nodes/Google/Docs/GenericFunctions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ import * as moment from 'moment-timezone';

import * as jwt from 'jsonwebtoken';

interface IGoogleAuthCredentials {
delegatedEmail?: string;
email: string;
inpersonate: boolean;
privateKey: string;
}

export async function googleApiRequest(
this: IExecuteFunctions | ILoadOptionsFunctions,
method: string,
Expand Down Expand Up @@ -50,7 +57,7 @@ export async function googleApiRequest(
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}

const { access_token } = await getAccessToken.call(this, credentials as IDataObject);
const { access_token } = await getAccessToken.call(this, credentials as unknown as IGoogleAuthCredentials);

options.headers!.Authorization = `Bearer ${access_token}`;
return await this.helpers.request!(options);
Expand Down Expand Up @@ -84,7 +91,7 @@ export async function googleApiRequestAllItems(this: IExecuteFunctions | ILoadOp
return returnData;
}

function getAccessToken(this: IExecuteFunctions | ILoadOptionsFunctions, credentials: IDataObject): Promise<IDataObject> {
function getAccessToken(this: IExecuteFunctions | ILoadOptionsFunctions, credentials: IGoogleAuthCredentials): Promise<IDataObject> {
//https://developers.google.com/identity/protocols/oauth2/service-account#httprest

const scopes = [
Expand All @@ -95,7 +102,8 @@ function getAccessToken(this: IExecuteFunctions | ILoadOptionsFunctions, credent

const now = moment().unix();

const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n');
credentials.email = credentials.email.trim();
const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n').trim();

const signature = jwt.sign(
{
Expand Down
14 changes: 11 additions & 3 deletions packages/nodes-base/nodes/Google/Drive/GenericFunctions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ import * as moment from 'moment-timezone';

import * as jwt from 'jsonwebtoken';

interface IGoogleAuthCredentials {
delegatedEmail?: string;
email: string;
inpersonate: boolean;
privateKey: string;
}

export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IPollFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const authenticationMethod = this.getNodeParameter('authentication', 0, 'serviceAccount') as string;

Expand Down Expand Up @@ -47,7 +54,7 @@ export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleF
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}

const { access_token } = await getAccessToken.call(this, credentials as IDataObject);
const { access_token } = await getAccessToken.call(this, credentials as unknown as IGoogleAuthCredentials);

options.headers!.Authorization = `Bearer ${access_token}`;
return await this.helpers.request!(options);
Expand Down Expand Up @@ -83,7 +90,7 @@ export async function googleApiRequestAllItems(this: IExecuteFunctions | ILoadOp
return returnData;
}

function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IPollFunctions, credentials: IDataObject): Promise<IDataObject> {
function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IPollFunctions, credentials: IGoogleAuthCredentials): Promise<IDataObject> {
//https://developers.google.com/identity/protocols/oauth2/service-account#httprest

const scopes = [
Expand All @@ -94,7 +101,8 @@ function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoa

const now = moment().unix();

const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n');
credentials.email = credentials.email.trim();
const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n').trim();

const signature = jwt.sign(
{
Expand Down
15 changes: 11 additions & 4 deletions packages/nodes-base/nodes/Google/Gmail/GenericFunctions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import {
} from 'request';

import {
ParsedMail,
simpleParser,
} from 'mailparser';

Expand All @@ -29,6 +28,13 @@ import * as moment from 'moment-timezone';

import * as jwt from 'jsonwebtoken';

interface IGoogleAuthCredentials {
delegatedEmail?: string;
email: string;
inpersonate: boolean;
privateKey: string;
}

const mailComposer = require('nodemailer/lib/mail-composer');

export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string,
Expand Down Expand Up @@ -63,7 +69,7 @@ export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleF
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}

const { access_token } = await getAccessToken.call(this, credentials as IDataObject);
const { access_token } = await getAccessToken.call(this, credentials as unknown as IGoogleAuthCredentials);

options.headers!.Authorization = `Bearer ${access_token}`;
//@ts-ignore
Expand Down Expand Up @@ -202,7 +208,7 @@ export function extractEmail(s: string) {
return data.substring(0, data.length - 1);
}

function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, credentials: IDataObject): Promise<IDataObject> {
function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, credentials: IGoogleAuthCredentials): Promise<IDataObject> {
//https://developers.google.com/identity/protocols/oauth2/service-account#httprest

const scopes = [
Expand All @@ -216,7 +222,8 @@ function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoa

const now = moment().unix();

const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n');
credentials.email = credentials.email.trim();
const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n').trim();

const signature = jwt.sign(
{
Expand Down
15 changes: 11 additions & 4 deletions packages/nodes-base/nodes/Google/Sheet/GenericFunctions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import {
} from 'n8n-core';

import {
ICredentialDataDecryptedObject,
ICredentialTestFunctions,
IDataObject, NodeApiError, NodeOperationError,
} from 'n8n-workflow';
Expand All @@ -18,6 +17,13 @@ import * as moment from 'moment-timezone';

import * as jwt from 'jsonwebtoken';

export interface IGoogleAuthCredentials {
delegatedEmail?: string;
email: string;
inpersonate: boolean;
privateKey: string;
}

export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, headers: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const authenticationMethod = this.getNodeParameter('authentication', 0, 'serviceAccount') as string;
const options: OptionsWithUri = {
Expand Down Expand Up @@ -45,7 +51,7 @@ export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleF
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}

const { access_token } = await getAccessToken.call(this, credentials as ICredentialDataDecryptedObject);
const { access_token } = await getAccessToken.call(this, credentials as unknown as IGoogleAuthCredentials);

options.headers!.Authorization = `Bearer ${access_token}`;
//@ts-ignore
Expand Down Expand Up @@ -82,7 +88,7 @@ export async function googleApiRequestAllItems(this: IExecuteFunctions | ILoadOp
return returnData;
}

export function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | ICredentialTestFunctions, credentials: ICredentialDataDecryptedObject): Promise<IDataObject> {
export function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | ICredentialTestFunctions, credentials: IGoogleAuthCredentials): Promise<IDataObject> {
//https://developers.google.com/identity/protocols/oauth2/service-account#httprest

const scopes = [
Expand All @@ -93,7 +99,8 @@ export function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions

const now = moment().unix();

const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n');
credentials.email = credentials.email.trim();
const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n').trim();

const signature = jwt.sign(
{
Expand Down
3 changes: 2 additions & 1 deletion packages/nodes-base/nodes/Google/Sheet/GoogleSheets.node.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
getAccessToken,
googleApiRequest,
hexToRgb,
IGoogleAuthCredentials,
} from './GenericFunctions';

export class GoogleSheets implements INodeType {
Expand Down Expand Up @@ -1018,7 +1019,7 @@ export class GoogleSheets implements INodeType {
credentialTest: {
async googleApiCredentialTest(this: ICredentialTestFunctions, credential: ICredentialsDecrypted): Promise<NodeCredentialTestResult> {
try {
const tokenRequest = await getAccessToken.call(this, credential.data!);
const tokenRequest = await getAccessToken.call(this, credential.data! as unknown as IGoogleAuthCredentials);
if (!tokenRequest.access_token) {
return {
status: 'Error',
Expand Down
22 changes: 18 additions & 4 deletions packages/nodes-base/nodes/Google/Slides/GenericFunctions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,20 @@ import {
ICredentialDataDecryptedObject,
IDataObject,
NodeApiError,
NodeOperationError,
} from 'n8n-workflow';

import * as moment from 'moment-timezone';

import * as jwt from 'jsonwebtoken';

interface IGoogleAuthCredentials {
delegatedEmail?: string;
email: string;
inpersonate: boolean;
privateKey: string;
}

export async function googleApiRequest(
this: IExecuteFunctions | ILoadOptionsFunctions,
method: string,
Expand Down Expand Up @@ -46,8 +54,13 @@ export async function googleApiRequest(

try {
if (authenticationMethod === 'serviceAccount') {
const credentials = await this.getCredentials('googleApi') as { access_token: string, email: string, privateKey: string };
const { access_token } = await getAccessToken.call(this, credentials);
const credentials = await this.getCredentials('googleApi');

if (credentials === undefined) {
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}

const { access_token } = await getAccessToken.call(this, credentials as unknown as IGoogleAuthCredentials);
options.headers.Authorization = `Bearer ${access_token}`;
return await this.helpers.request!(options);

Expand All @@ -65,7 +78,7 @@ export async function googleApiRequest(

function getAccessToken(
this: IExecuteFunctions | ILoadOptionsFunctions,
credentials: ICredentialDataDecryptedObject,
credentials: IGoogleAuthCredentials,
) {
// https://developers.google.com/identity/protocols/oauth2/service-account#httprest

Expand All @@ -76,7 +89,8 @@ function getAccessToken(

const now = moment().unix();

const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n');
credentials.email = credentials.email.trim();
const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n').trim();

const signature = jwt.sign(
{
Expand Down
14 changes: 11 additions & 3 deletions packages/nodes-base/nodes/Google/Translate/GenericFunctions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ import * as moment from 'moment-timezone';

import * as jwt from 'jsonwebtoken';

interface IGoogleAuthCredentials {
delegatedEmail?: string;
email: string;
inpersonate: boolean;
privateKey: string;
}

export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, headers: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const authenticationMethod = this.getNodeParameter('authentication', 0, 'serviceAccount') as string;
const options: OptionsWithUri = {
Expand Down Expand Up @@ -43,7 +50,7 @@ export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleF
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}

const { access_token } = await getAccessToken.call(this, credentials as IDataObject);
const { access_token } = await getAccessToken.call(this, credentials as unknown as IGoogleAuthCredentials);

options.headers!.Authorization = `Bearer ${access_token}`;
//@ts-ignore
Expand Down Expand Up @@ -76,7 +83,7 @@ export async function googleApiRequestAllItems(this: IExecuteFunctions | ILoadOp
return returnData;
}

function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, credentials: IDataObject): Promise<IDataObject> {
function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, credentials: IGoogleAuthCredentials): Promise<IDataObject> {
//https://developers.google.com/identity/protocols/oauth2/service-account#httprest

const scopes = [
Expand All @@ -86,7 +93,8 @@ function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoa

const now = moment().unix();

const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n');
credentials.email = credentials.email.trim();
const privateKey = (credentials.privateKey as string).replace(/\\n/g, '\n').trim();

const signature = jwt.sign(
{
Expand Down

0 comments on commit 26eac80

Please sign in to comment.