From 901699fe64b9710df849d6b8a0f842956fdddb2c Mon Sep 17 00:00:00 2001 From: Ali BARIN Date: Tue, 26 Oct 2021 18:11:09 +0200 Subject: [PATCH] feat: introduce discord authentication --- packages/backend/package.json | 4 +- .../src/apps/discord/assets/favicon.svg | 4 + packages/backend/src/apps/discord/index.ts | 91 ++++++++ packages/backend/src/apps/discord/info.json | 218 ++++++++++++++++++ yarn.lock | 114 ++++++++- 5 files changed, 428 insertions(+), 3 deletions(-) create mode 100644 packages/backend/src/apps/discord/assets/favicon.svg create mode 100644 packages/backend/src/apps/discord/index.ts create mode 100644 packages/backend/src/apps/discord/info.json diff --git a/packages/backend/package.json b/packages/backend/package.json index be09a6e1..3e7f5edb 100644 --- a/packages/backend/package.json +++ b/packages/backend/package.json @@ -15,9 +15,11 @@ "db:migrate": "knex migrate:latest" }, "dependencies": { + "axios": "0.24.0", "bcrypt": "^5.0.1", "cors": "^2.8.5", "debug": "~2.6.9", + "discord.js": "13.2.0", "dotenv": "^10.0.0", "express": "~4.16.1", "express-graphql": "^0.12.0", @@ -41,7 +43,7 @@ } ], "homepage": "https://github.com/automatisch/automatisch#readme", - "main": "src/backend.js", + "main": "src/app.ts", "directories": { "src": "src", "test": "__tests__" diff --git a/packages/backend/src/apps/discord/assets/favicon.svg b/packages/backend/src/apps/discord/assets/favicon.svg new file mode 100644 index 00000000..0483a9d3 --- /dev/null +++ b/packages/backend/src/apps/discord/assets/favicon.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/packages/backend/src/apps/discord/index.ts b/packages/backend/src/apps/discord/index.ts new file mode 100644 index 00000000..d1d82006 --- /dev/null +++ b/packages/backend/src/apps/discord/index.ts @@ -0,0 +1,91 @@ +import { URLSearchParams } from 'url'; +import DiscordApi from 'discord.js'; +import axios, { AxiosInstance } from 'axios'; +import App from '../../models/app'; +import Field from '../../types/field'; + +export default class Discord { + client?: any + connectionData: any + appData: any + scope: string[] = ['identify', 'email'] + httpClient: AxiosInstance = axios.create({ + baseURL: 'https://discord.com/api/' + }) + + constructor(connectionData: any) { + this.connectionData = connectionData; + this.appData = App.findOneByKey('discord'); + } + + get oauthRedirectUrl() { + return this.appData.fields.find((field: Field) => field.key == 'oAuthRedirectUrl').value; + } + + async createAuthLink() { + const searchParams = new URLSearchParams({ + client_id: this.connectionData.consumerKey, + redirect_uri: this.oauthRedirectUrl, + response_type: 'code', + scope: this.scope.join(' '), + }); + + const url = `https://discord.com/api/oauth2/authorize?${searchParams.toString()}`; + + return { url }; + } + + async verifyCredentials() { + const params = new URLSearchParams({ + client_id: this.connectionData.consumerKey, + redirect_uri: this.oauthRedirectUrl, + response_type: 'code', + scope: this.scope.join(' '), + client_secret: this.connectionData.consumerSecret, + code: this.connectionData.oauthVerifier, + grant_type: 'authorization_code', + }); + const { data: verifiedCredentials }: any = await this.httpClient.post('/oauth2/token', params.toString()); + + const { + access_token: accessToken, + refresh_token: refreshToken, + expires_in: expiresIn, + scope: scope, + token_type: tokenType, + } = verifiedCredentials; + + const { data: user }: any = await this.httpClient.get('/users/@me', { + headers: { + Authorization: `${tokenType} ${accessToken}`, + }, + }); + + return { + consumerKey: this.connectionData.consumerKey, + consumerSecret: this.connectionData.consumerSecret, + accessToken, + refreshToken, + expiresIn, + scope, + tokenType, + userId: user.id, + screenName: user.username, + email: user.email, + }; + } + + async isStillVerified() { + try { + await this.httpClient.get('/users/@me', { + headers: { + Authorization: `${this.connectionData.tokenType} ${this.connectionData.accessToken}`, + }, + }); + + return true; + } catch { + return false + } + } +} diff --git a/packages/backend/src/apps/discord/info.json b/packages/backend/src/apps/discord/info.json new file mode 100644 index 00000000..2b21c824 --- /dev/null +++ b/packages/backend/src/apps/discord/info.json @@ -0,0 +1,218 @@ +{ + "name": "Discord", + "key": "discord", + "iconUrl": "{BASE_URL}/apps/discord/assets/favicon.svg", + "docUrl": "https://automatisch.io/docs/discord", + "primaryColor": "2DAAE1", + "fields": [ + { + "key": "oAuthRedirectUrl", + "label": "OAuth Redirect URL", + "type": "string", + "required": true, + "readOnly": true, + "value": "https://localhost:3001/app/discord/connections/add", + "placeholder": null, + "description": "When asked to input an OAuth callback or redirect URL in Discord OAuth, enter the URL above.", + "docUrl": "https://automatisch.io/docs/discord#oauth-redirect-url", + "clickToCopy": true + }, + { + "key": "consumerKey", + "label": "Consumer Key", + "type": "string", + "required": true, + "readOnly": false, + "value": null, + "placeholder": null, + "description": null, + "docUrl": "https://automatisch.io/docs/discord#consumer-key", + "clickToCopy": false + }, + { + "key": "consumerSecret", + "label": "Consumer Secret", + "type": "string", + "required": true, + "readOnly": false, + "value": null, + "placeholder": null, + "description": null, + "docUrl": "https://automatisch.io/docs/discord#consumer-secret", + "clickToCopy": false + } + ], + "authenticationSteps": [ + { + "step": 1, + "type": "mutation", + "name": "createConnection", + "fields": [ + { + "name": "key", + "value": "{key}" + }, + { + "name": "data", + "value": null, + "fields": [ + { + "name": "consumerKey", + "value": "{fields.consumerKey}" + }, + { + "name": "consumerSecret", + "value": "{fields.consumerSecret}" + } + ] + } + ] + }, + { + "step": 2, + "type": "mutation", + "name": "createAuthLink", + "fields": [ + { + "name": "id", + "value": "{createConnection.id}" + } + ] + }, + { + "step": 3, + "type": "openWithPopup", + "name": "openAuthPopup", + "fields": [ + { + "name": "url", + "value": "{createAuthLink.url}" + } + ] + }, + { + "step": 4, + "type": "mutation", + "name": "updateConnection", + "fields": [ + { + "name": "id", + "value": "{createConnection.id}" + }, + { + "name": "data", + "value": null, + "fields": [ + { + "name": "oauthVerifier", + "value": "{openAuthPopup.code}" + } + ] + } + ] + }, + { + "step": 5, + "type": "mutation", + "name": "verifyConnection", + "fields": [ + { + "name": "id", + "value": "{createConnection.id}" + } + ] + } + ], + "reconnectionSteps": [ + { + "step": 1, + "type": "mutation", + "name": "resetConnection", + "fields": [ + { + "name": "id", + "value": "{connection.id}" + } + ] + }, + { + "step": 2, + "type": "mutation", + "name": "updateConnection", + "fields": [ + { + "name": "id", + "value": "{connection.id}" + }, + { + "name": "data", + "value": null, + "fields": [ + { + "name": "consumerKey", + "value": "{fields.consumerKey}" + }, + { + "name": "consumerSecret", + "value": "{fields.consumerSecret}" + } + ] + } + ] + }, + { + "step": 3, + "type": "mutation", + "name": "createAuthLink", + "fields": [ + { + "name": "id", + "value": "{connection.id}" + } + ] + }, + { + "step": 4, + "type": "openWithPopup", + "name": "openAuthPopup", + "fields": [ + { + "name": "url", + "value": "{createAuthLink.url}" + } + ] + }, + { + "step": 5, + "type": "mutation", + "name": "updateConnection", + "fields": [ + { + "name": "id", + "value": "{connection.id}" + }, + { + "name": "data", + "value": null, + "fields": [ + { + "name": "oauthVerifier", + "value": "{openAuthPopup.code}" + } + ] + } + ] + }, + { + "step": 6, + "type": "mutation", + "name": "verifyConnection", + "fields": [ + { + "name": "id", + "value": "{connection.id}" + } + ] + } + ] +} diff --git a/yarn.lock b/yarn.lock index bb3997e9..c447c058 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1265,6 +1265,31 @@ enabled "2.0.x" kuler "^2.0.0" +"@discordjs/builders@^0.6.0": + version "0.6.0" + resolved "https://registry.yarnpkg.com/@discordjs/builders/-/builders-0.6.0.tgz#4724d18990a97d84d0250eba5b50991b71a450a5" + integrity sha512-mH3Gx61LKk2CD05laCI9K5wp+a3NyASHDUGx83DGJFkqJlRlSV5WMJNY6RS37A5SjqDtGMF4wVR9jzFaqShe6Q== + dependencies: + "@sindresorhus/is" "^4.0.1" + discord-api-types "^0.22.0" + ow "^0.27.0" + ts-mixer "^6.0.0" + tslib "^2.3.1" + +"@discordjs/collection@^0.2.1": + version "0.2.1" + resolved "https://registry.yarnpkg.com/@discordjs/collection/-/collection-0.2.1.tgz#ea4bc7b41b7b7b6daa82e439141222ec95c469b2" + integrity sha512-vhxqzzM8gkomw0TYRF3tgx7SwElzUlXT/Aa41O7mOcyN6wIJfj5JmDWaO5XGKsGSsNx7F3i5oIlrucCCWV1Nog== + +"@discordjs/form-data@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@discordjs/form-data/-/form-data-3.0.1.tgz#5c9e6be992e2e57d0dfa0e39979a850225fb4697" + integrity sha512-ZfFsbgEXW71Rw/6EtBdrP5VxBJy4dthyC0tpQKGKmYFImlmmrykO14Za+BiIVduwjte0jXEBlhSKf0MWbFp9Eg== + dependencies: + asynckit "^0.4.0" + combined-stream "^1.0.8" + mime-types "^2.1.12" + "@emotion/babel-plugin@^11.3.0": version "11.3.0" resolved "https://registry.yarnpkg.com/@emotion/babel-plugin/-/babel-plugin-11.3.0.tgz#3a16850ba04d8d9651f07f3fb674b3436a4fb9d7" @@ -2724,11 +2749,21 @@ estree-walker "^1.0.1" picomatch "^2.2.2" +"@sapphire/async-queue@^1.1.5": + version "1.1.7" + resolved "https://registry.yarnpkg.com/@sapphire/async-queue/-/async-queue-1.1.7.tgz#7f23fc0fdf888d25a04876c2fbf3a207ddf4a2c8" + integrity sha512-EBRERa9NqK/EV6DIPBVtjjdHBsu/DSdMuYAydmoIyIPONzp0UAxf2G6JGJ52WkiONtPRx6KNuqB5Q8dm14fwyw== + "@sindresorhus/is@^0.14.0": version "0.14.0" resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-0.14.0.tgz#9fb3a3cf3132328151f353de4632e01e52102bea" integrity sha512-9NET910DNaIPngYnLLPeg+Ogzqsi9uM4mSboU5y6p8S5DzMTVEsJZrawi+BoDNUVBa2DhJqQYUFvMDfgU062LQ== +"@sindresorhus/is@^4.0.1": + version "4.2.0" + resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-4.2.0.tgz#667bfc6186ae7c9e0b45a08960c551437176e1ca" + integrity sha512-VkE3KLBmJwcCaVARtQpfuKcKv8gcBmUubrfHGF84dXuuW6jgsRYxPtzcIhPyK9WAPpRt2/xY6zkD9MnRaJzSyw== + "@sinonjs/commons@^1.6.0", "@sinonjs/commons@^1.7.0", "@sinonjs/commons@^1.8.3": version "1.8.3" resolved "https://registry.yarnpkg.com/@sinonjs/commons/-/commons-1.8.3.tgz#3802ddd21a50a949b6721ddd72da36e67e7f1b2d" @@ -3348,6 +3383,13 @@ anymatch "^3.0.0" source-map "^0.6.0" +"@types/ws@^8.2.0": + version "8.2.0" + resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.2.0.tgz#75faefbe2328f3b833cb8dc640658328990d04f3" + integrity sha512-cyeefcUCgJlEk+hk2h3N+MqKKsPViQgF5boi9TTHSK+PoR9KWBb/C5ccPcDyAqgsbAYHTwulch725DV84+pSpg== + dependencies: + "@types/node" "*" + "@types/yargs-parser@*": version "20.2.1" resolved "https://registry.yarnpkg.com/@types/yargs-parser/-/yargs-parser-20.2.1.tgz#3b9ce2489919d9e4fea439b76916abc34b2df129" @@ -4228,6 +4270,13 @@ axe-core@^4.0.2: resolved "https://registry.yarnpkg.com/axe-core/-/axe-core-4.3.3.tgz#b55cd8e8ddf659fe89b064680e1c6a4dceab0325" integrity sha512-/lqqLAmuIPi79WYfRpy2i8z+x+vxU3zX2uAm0gs1q52qTuKwolOj1P8XbufpXcsydrpKx2yGn2wzAnxCMV86QA== +axios@0.24.0: + version "0.24.0" + resolved "https://registry.yarnpkg.com/axios/-/axios-0.24.0.tgz#804e6fa1e4b9c5288501dd9dff56a7a0940d20d6" + integrity sha512-Q6cWsys88HoPgAaFAVUb0WpPk0O8iTeisR9IMqy9G8AbO4NlpVknrnQS03zzF9PGAWgO3cgletO3VjV/P7VztA== + dependencies: + follow-redirects "^1.14.4" + axobject-query@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/axobject-query/-/axobject-query-2.2.0.tgz#943d47e10c0b704aa42275e20edf3722648989be" @@ -6410,6 +6459,30 @@ dir-glob@^3.0.1: dependencies: path-type "^4.0.0" +discord-api-types@^0.22.0: + version "0.22.0" + resolved "https://registry.yarnpkg.com/discord-api-types/-/discord-api-types-0.22.0.tgz#34dc57fe8e016e5eaac5e393646cd42a7e1ccc2a" + integrity sha512-l8yD/2zRbZItUQpy7ZxBJwaLX/Bs2TGaCthRppk8Sw24LOIWg12t9JEreezPoYD0SQcC2htNNo27kYEpYW/Srg== + +discord-api-types@^0.23.1: + version "0.23.1" + resolved "https://registry.yarnpkg.com/discord-api-types/-/discord-api-types-0.23.1.tgz#832d0ee2b3c8e2eae02947c1dbf38121d6d357d5" + integrity sha512-igWmn+45mzXRWNEPU25I/pr8MwxHb767wAr51oy3VRLRcTlp5ADBbrBR0lq3SA1Rfw3MtM4TQu1xo3kxscfVdQ== + +discord.js@13.2.0: + version "13.2.0" + resolved "https://registry.yarnpkg.com/discord.js/-/discord.js-13.2.0.tgz#db2e7f643bbc661d1c63b3ebad0ccc6572c0065b" + integrity sha512-nyxUvL8wuQG38zx13wUMkpcA8koFszyiXdkSLwwM9opKW2LC2H5gD0cTZxImeJ6GtEnKPWT8xBiE8lLBmbNIhw== + dependencies: + "@discordjs/builders" "^0.6.0" + "@discordjs/collection" "^0.2.1" + "@discordjs/form-data" "^3.0.1" + "@sapphire/async-queue" "^1.1.5" + "@types/ws" "^8.2.0" + discord-api-types "^0.23.1" + node-fetch "^2.6.1" + ws "^8.2.3" + dns-equal@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/dns-equal/-/dns-equal-1.0.0.tgz#b39e7f1da6eb0a75ba9c17324b34753c47e0654d" @@ -7620,7 +7693,7 @@ fn.name@1.x.x: resolved "https://registry.yarnpkg.com/fn.name/-/fn.name-1.1.0.tgz#26cad8017967aea8731bc42961d04a3d5988accc" integrity sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw== -follow-redirects@^1.0.0: +follow-redirects@^1.0.0, follow-redirects@^1.14.4: version "1.14.4" resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.4.tgz#838fdf48a8bbdd79e52ee51fb1c94e3ed98b9379" integrity sha512-zwGkiSXC1MUJG/qmeIFH2HBJx9u0V46QGUe3YR1fXG8bXQxq7fLj0RjLZQ5nubr9qNJUZrH+xUcwXEoXNpfS+g== @@ -10255,6 +10328,11 @@ lodash.get@^4.4.2: resolved "https://registry.yarnpkg.com/lodash.get/-/lodash.get-4.4.2.tgz#2d177f652fa31e939b4438d5341499dfa3825e99" integrity sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk= +lodash.isequal@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.isequal/-/lodash.isequal-4.5.0.tgz#415c4478f2bcc30120c22ce10ed3226f7d3e18e0" + integrity sha1-QVxEePK8wwEgwizhDtMib30+GOA= + lodash.ismatch@^4.4.0: version "4.4.0" resolved "https://registry.yarnpkg.com/lodash.ismatch/-/lodash.ismatch-4.4.0.tgz#756cb5150ca3ba6f11085a78849645f188f85f37" @@ -11611,6 +11689,18 @@ osenv@^0.1.4: os-homedir "^1.0.0" os-tmpdir "^1.0.0" +ow@^0.27.0: + version "0.27.0" + resolved "https://registry.yarnpkg.com/ow/-/ow-0.27.0.tgz#d44da088e8184fa11de64b5813206f9f86ab68d0" + integrity sha512-SGnrGUbhn4VaUGdU0EJLMwZWSupPmF46hnTRII7aCLCrqixTAC5eKo8kI4/XXf1eaaI8YEVT+3FeGNJI9himAQ== + dependencies: + "@sindresorhus/is" "^4.0.1" + callsites "^3.1.0" + dot-prop "^6.0.1" + lodash.isequal "^4.5.0" + type-fest "^1.2.1" + vali-date "^1.0.0" + p-cancelable@^1.0.0: version "1.1.0" resolved "https://registry.yarnpkg.com/p-cancelable/-/p-cancelable-1.1.0.tgz#d078d15a3af409220c886f1d9a0ca2e441ab26cc" @@ -15421,6 +15511,11 @@ ts-invariant@^0.9.0: dependencies: tslib "^2.1.0" +ts-mixer@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/ts-mixer/-/ts-mixer-6.0.0.tgz#4e631d3a36e3fa9521b973b132e8353bc7267f9f" + integrity sha512-nXIb1fvdY5CBSrDIblLn73NW0qRDk5yJ0Sk1qPBF560OdJfQp9jhl+0tzcY09OZ9U+6GpeoI9RjwoIKFIoB9MQ== + ts-node@^10.2.1: version "10.3.0" resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.3.0.tgz#a797f2ed3ff50c9a5d814ce400437cb0c1c048b4" @@ -15459,7 +15554,7 @@ tslib@^1.8.1, tslib@^1.9.0: resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00" integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg== -tslib@^2.0.3, tslib@^2.1.0, tslib@^2.3.0: +tslib@^2.0.3, tslib@^2.1.0, tslib@^2.3.0, tslib@^2.3.1: version "2.3.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.3.1.tgz#e8a335add5ceae51aa261d32a490158ef042ef01" integrity sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw== @@ -15577,6 +15672,11 @@ type-fest@^0.8.1: resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.8.1.tgz#09e249ebde851d3b1e48d27c105444667f17b83d" integrity sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA== +type-fest@^1.2.1: + version "1.4.0" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-1.4.0.tgz#e9fb813fe3bf1744ec359d55d1affefa76f14be1" + integrity sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA== + type-is@~1.6.16, type-is@~1.6.17, type-is@~1.6.18: version "1.6.18" resolved "https://registry.yarnpkg.com/type-is/-/type-is-1.6.18.tgz#4e552cd05df09467dcbc4ef739de89f2cf37c131" @@ -15910,6 +16010,11 @@ v8-to-istanbul@^7.0.0: convert-source-map "^1.6.0" source-map "^0.7.3" +vali-date@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/vali-date/-/vali-date-1.0.0.tgz#1b904a59609fb328ef078138420934f6b86709a6" + integrity sha1-G5BKWWCfsyjvB4E4Qgk09rhnCaY= + validate-npm-package-license@^3.0.1, validate-npm-package-license@^3.0.4: version "3.0.4" resolved "https://registry.yarnpkg.com/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz#fc91f6b9c7ba15c857f4cb2c5defeec39d4f410a" @@ -16525,6 +16630,11 @@ ws@^7.3.1, ws@^7.4.6: resolved "https://registry.yarnpkg.com/ws/-/ws-7.5.5.tgz#8b4bc4af518cfabd0473ae4f99144287b33eb881" integrity sha512-BAkMFcAzl8as1G/hArkxOxq3G7pjUqQ3gzYbLL0/5zNkph70e+lCoxBGnm6AW1+/aiNeV4fnKqZ8m4GZewmH2w== +ws@^8.2.3: + version "8.2.3" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.2.3.tgz#63a56456db1b04367d0b721a0b80cae6d8becbba" + integrity sha512-wBuoj1BDpC6ZQ1B7DWQBYVLphPWkm8i9Y0/3YdHjHKHiohOJ1ws+3OccDWtH+PoC9DZD5WOTrJvNbWvjS6JWaA== + xdg-basedir@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/xdg-basedir/-/xdg-basedir-4.0.0.tgz#4bc8d9984403696225ef83a1573cbbcb4e79db13"