diff --git a/packages/backend/src/apps/gitea/assets/favicon.svg b/packages/backend/src/apps/gitea/assets/favicon.svg new file mode 100644 index 00000000..afeeacb7 --- /dev/null +++ b/packages/backend/src/apps/gitea/assets/favicon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/backend/src/apps/gitea/auth/generate-auth-url.js b/packages/backend/src/apps/gitea/auth/generate-auth-url.js new file mode 100644 index 00000000..106efa1f --- /dev/null +++ b/packages/backend/src/apps/gitea/auth/generate-auth-url.js @@ -0,0 +1,24 @@ +import { URLSearchParams } from 'url'; + +export default async function generateAuthUrl($) { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value; + const state = Math.random().toString(); + const searchParams = new URLSearchParams({ + client_id: $.auth.data.clientId, + redirect_uri: redirectUri, + response_type: 'code', + state: state, + }); + + const url = `${ + $.auth.data.instanceUrl + }/login/oauth/authorize?${searchParams.toString()}`; + + await $.auth.set({ + url, + originalState: state, + }); +} diff --git a/packages/backend/src/apps/gitea/auth/index.js b/packages/backend/src/apps/gitea/auth/index.js new file mode 100644 index 00000000..fa6f70a9 --- /dev/null +++ b/packages/backend/src/apps/gitea/auth/index.js @@ -0,0 +1,59 @@ +import generateAuthUrl from './generate-auth-url.js'; +import verifyCredentials from './verify-credentials.js'; +import refreshToken from './refresh-token.js'; +import isStillVerified from './is-still-verified.js'; + +export default { + fields: [ + { + key: 'oAuthRedirectUrl', + label: 'OAuth Redirect URL', + type: 'string', + required: true, + readOnly: true, + value: '{WEB_APP_URL}/app/gitea/connections/add', + placeholder: null, + description: + 'When asked to input a redirect URL in Gitea, enter the URL above.', + clickToCopy: true, + }, + { + key: 'instanceUrl', + label: 'Instance URL', + type: 'string', + required: true, + readOnly: false, + value: null, + placeholder: null, + description: null, + clickToCopy: false, + }, + { + key: 'clientId', + label: 'Client ID', + type: 'string', + required: true, + readOnly: false, + value: null, + placeholder: null, + description: null, + clickToCopy: false, + }, + { + key: 'clientSecret', + label: 'Client Secret', + type: 'string', + required: true, + readOnly: false, + value: null, + placeholder: null, + description: null, + clickToCopy: false, + }, + ], + + generateAuthUrl, + verifyCredentials, + isStillVerified, + refreshToken, +}; diff --git a/packages/backend/src/apps/gitea/auth/is-still-verified.js b/packages/backend/src/apps/gitea/auth/is-still-verified.js new file mode 100644 index 00000000..aa7196a9 --- /dev/null +++ b/packages/backend/src/apps/gitea/auth/is-still-verified.js @@ -0,0 +1,8 @@ +import getCurrentUser from '../common/get-current-user.js'; + +const isStillVerified = async ($) => { + const currentUser = await getCurrentUser($); + return !!currentUser.email; +}; + +export default isStillVerified; diff --git a/packages/backend/src/apps/gitea/auth/refresh-token.js b/packages/backend/src/apps/gitea/auth/refresh-token.js new file mode 100644 index 00000000..f8d0fbc8 --- /dev/null +++ b/packages/backend/src/apps/gitea/auth/refresh-token.js @@ -0,0 +1,29 @@ +import { URLSearchParams } from 'node:url'; + +const refreshToken = async ($) => { + const params = new URLSearchParams({ + client_id: $.auth.data.clientId, + client_secret: $.auth.data.clientSecret, + grant_type: 'refresh_token', + refresh_token: $.auth.data.refreshToken, + }); + + const { data } = await $.http.post( + `${$.auth.data.instanceUrl}/login/oauth/access_token`, + params.toString(), + { + additionalProperties: { + skipAddingBaseUrl: true, + }, + } + ); + + await $.auth.set({ + accessToken: data.access_token, + expiresIn: data.expires_in, + tokenType: data.token_type, + refreshToken: data.refresh_token, + }); +}; + +export default refreshToken; diff --git a/packages/backend/src/apps/gitea/auth/verify-credentials.js b/packages/backend/src/apps/gitea/auth/verify-credentials.js new file mode 100644 index 00000000..580a305a --- /dev/null +++ b/packages/backend/src/apps/gitea/auth/verify-credentials.js @@ -0,0 +1,50 @@ +import getCurrentUser from '../common/get-current-user.js'; +import { URLSearchParams } from 'url'; + +const verifyCredentials = async ($) => { + if ($.auth.data.originalState !== $.auth.data.state) { + throw new Error(`The 'state' parameter does not match.`); + } + const oauthRedirectUrlField = $.app.auth.fields.find( + (field) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value; + const params = new URLSearchParams({ + client_id: $.auth.data.clientId, + client_secret: $.auth.data.clientSecret, + code: $.auth.data.code, + grant_type: 'authorization_code', + redirect_uri: redirectUri, + }); + + const { data } = await $.http.post( + `${$.auth.data.instanceUrl}/login/oauth/access_token`, + params.toString(), + { + additionalProperties: { + skipAddingBaseUrl: true, + }, + } + ); + + await $.auth.set({ + accessToken: data.access_token, + tokenType: data.token_type, + }); + + const currentUser = await getCurrentUser($); + const screenName = [currentUser.username, currentUser.email] + .filter(Boolean) + .join(' @ '); + + await $.auth.set({ + clientId: $.auth.data.clientId, + clientSecret: $.auth.data.clientSecret, + expiresIn: data.expires_in, + refreshToken: data.refresh_token, + repoOwner: currentUser.username, + screenName, + }); +}; + +export default verifyCredentials; diff --git a/packages/backend/src/apps/gitea/common/add-auth-header.js b/packages/backend/src/apps/gitea/common/add-auth-header.js new file mode 100644 index 00000000..02477aa4 --- /dev/null +++ b/packages/backend/src/apps/gitea/common/add-auth-header.js @@ -0,0 +1,9 @@ +const addAuthHeader = ($, requestConfig) => { + if ($.auth.data?.accessToken) { + requestConfig.headers.Authorization = `${$.auth.data.tokenType} ${$.auth.data.accessToken}`; + } + + return requestConfig; +}; + +export default addAuthHeader; diff --git a/packages/backend/src/apps/gitea/common/get-current-user.js b/packages/backend/src/apps/gitea/common/get-current-user.js new file mode 100644 index 00000000..66a86b4f --- /dev/null +++ b/packages/backend/src/apps/gitea/common/get-current-user.js @@ -0,0 +1,6 @@ +const getCurrentUser = async ($) => { + const { data: currentUser } = await $.http.get(`/user`); + return currentUser; +}; + +export default getCurrentUser; diff --git a/packages/backend/src/apps/gitea/common/set-base-url.js b/packages/backend/src/apps/gitea/common/set-base-url.js new file mode 100644 index 00000000..895f0b60 --- /dev/null +++ b/packages/backend/src/apps/gitea/common/set-base-url.js @@ -0,0 +1,14 @@ +const setBaseUrl = ($, requestConfig) => { + if (requestConfig.additionalProperties?.skipAddingBaseUrl) + return requestConfig; + + const instanceUrl = $.auth.data.instanceUrl; + + if (instanceUrl) { + requestConfig.baseURL = `${instanceUrl}/api/v1`; + } + + return requestConfig; +}; + +export default setBaseUrl; diff --git a/packages/backend/src/apps/gitea/index.js b/packages/backend/src/apps/gitea/index.js new file mode 100644 index 00000000..32c6a2ed --- /dev/null +++ b/packages/backend/src/apps/gitea/index.js @@ -0,0 +1,17 @@ +import defineApp from '../../helpers/define-app.js'; +import addAuthHeader from './common/add-auth-header.js'; +import auth from './auth/index.js'; +import setBaseUrl from './common/set-base-url.js'; + +export default defineApp({ + name: 'Gitea', + key: 'gitea', + iconUrl: '{BASE_URL}/apps/gitea/assets/favicon.svg', + authDocUrl: '{DOCS_URL}/apps/gitea/connection', + supportsConnections: true, + baseUrl: '', + apiBaseUrl: '', + primaryColor: '609926', + beforeRequest: [setBaseUrl, addAuthHeader], + auth, +}); diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index 6e9d171f..3eb087e8 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -122,6 +122,12 @@ export default defineConfig({ { text: 'Connection', link: '/apps/ghost/connection' }, ], }, + { + text: 'Gitea', + collapsible: true, + collapsed: true, + items: [{ text: 'Connection', link: '/apps/gitea/connection' }], + }, { text: 'GitHub', collapsible: true, diff --git a/packages/docs/pages/apps/gitea/connection.md b/packages/docs/pages/apps/gitea/connection.md new file mode 100644 index 00000000..ce5f78eb --- /dev/null +++ b/packages/docs/pages/apps/gitea/connection.md @@ -0,0 +1,16 @@ +# Gitea + +:::info +This page explains the steps you need to follow to set up the Gitea +connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +1. Go to your Gitea Settings panel. +2. Click on the **Applications** button. +3. Create a new OAuth2 application under **Manage OAuth2 Applications**. +4. Copy **OAuth Redirect URL** from Automatisch to **Redirect URIs. Please use a new line for every URI.** field. +5. Copy **Client ID** to **Client ID** field on Automatisch. +6. Copy **Client Secret** to **Client Secret** field on Automatisch. +7. Add your instance url in the **Instance URL** field on Automatisch. +8. Click **Submit** button on Automatisch. +9. Congrats! Start using your new Gitea connection within the flows. diff --git a/packages/docs/pages/public/favicons/gitea.svg b/packages/docs/pages/public/favicons/gitea.svg new file mode 100644 index 00000000..afeeacb7 --- /dev/null +++ b/packages/docs/pages/public/favicons/gitea.svg @@ -0,0 +1 @@ + \ No newline at end of file