diff --git a/README.md b/README.md index 511edee1..0b8c20d4 100644 --- a/README.md +++ b/README.md @@ -205,6 +205,7 @@ It can also be set using environment variables: - AWS Cognito - Battle.net - Discord +- Dropbox - Facebook - GitHub - GitLab diff --git a/playground/.env.example b/playground/.env.example index 80d469bf..a37239c2 100644 --- a/playground/.env.example +++ b/playground/.env.example @@ -67,4 +67,7 @@ NUXT_OAUTH_YANDEX_CLIENT_ID= NUXT_OAUTH_YANDEX_CLIENT_SECRET= # TikTok NUXT_OAUTH_TIKTOK_CLIENT_KEY= -NUXT_OAUTH_TIKTOK_CLIENT_SECRET= \ No newline at end of file +NUXT_OAUTH_TIKTOK_CLIENT_SECRET= +# Dropbox +NUXT_OAUTH_DROPBOX_CLIENT_ID= +NUXT_OAUTH_DROPBOX_CLIENT_SECRET= diff --git a/playground/app.vue b/playground/app.vue index 4a0e0d80..8f0fbc17 100644 --- a/playground/app.vue +++ b/playground/app.vue @@ -156,6 +156,12 @@ const providers = computed(() => disabled: Boolean(user.value?.tiktok), icon: 'i-simple-icons-tiktok', }, + { + label: user.value?.dropbox || 'Dropbox', + to: '/auth/dropbox', + disabled: Boolean(user.value?.dropbox), + icon: 'i-simple-icons-dropbox', + }, ].map(p => ({ ...p, prefetch: false, diff --git a/playground/auth.d.ts b/playground/auth.d.ts index 01d9a753..bc56eca1 100644 --- a/playground/auth.d.ts +++ b/playground/auth.d.ts @@ -22,6 +22,7 @@ declare module '#auth-utils' { vk?: string yandex?: string tiktok?: string + dropbox?: string } interface UserSession { diff --git a/playground/server/routes/auth/dropbox.get.ts b/playground/server/routes/auth/dropbox.get.ts new file mode 100644 index 00000000..75e738ed --- /dev/null +++ b/playground/server/routes/auth/dropbox.get.ts @@ -0,0 +1,15 @@ +export default oauthDropboxEventHandler({ + config: { + emailRequired: true, + }, + async onSuccess(event, { user }) { + await setUserSession(event, { + user: { + dropbox: user.email, + }, + loggedInAt: Date.now(), + }) + + return sendRedirect(event, '/') + }, +}) diff --git a/src/module.ts b/src/module.ts index 93f5de18..1694eeb4 100644 --- a/src/module.ts +++ b/src/module.ts @@ -220,5 +220,11 @@ export default defineNuxtModule({ clientSecret: '', redirectURL: '', }) + // Dropbox OAuth + runtimeConfig.oauth.dropbox = defu(runtimeConfig.oauth.dropbox, { + clientId: '', + clientSecret: '', + redirectURL: '', + }) }, }) diff --git a/src/runtime/server/lib/oauth/dropbox.ts b/src/runtime/server/lib/oauth/dropbox.ts new file mode 100644 index 00000000..50ed4d57 --- /dev/null +++ b/src/runtime/server/lib/oauth/dropbox.ts @@ -0,0 +1,141 @@ +import type { H3Event } from 'h3' +import { eventHandler, getQuery, sendRedirect } from 'h3' +import { withQuery } from 'ufo' +import { defu } from 'defu' +import { handleMissingConfiguration, handleAccessTokenErrorResponse, getOAuthRedirectURL, requestAccessToken } from '../utils' +import { useRuntimeConfig, createError } from '#imports' +import type { OAuthConfig } from '#auth-utils' + +export interface OAuthDropboxConfig { + /** + * Dropbox Client ID + * @default process.env.NUXT_OAUTH_DROPBOX_CLIENT_ID + */ + clientId?: string + + /** + * Dropbox OAuth Client Secret + * @default process.env.NUXT_OAUTH_DROPBOX_CLIENT_SECRET + */ + clientSecret?: string + + /** + * Dropbox OAuth Scope + * @default [] + * @see https://developers.dropbox.com/oauth-guide#dropbox-api-permissions + * @example ['email', 'profile'] + */ + scope?: string[] + + /** + * Require email from user, adds the ['email'] scope if not present + * @default false + */ + emailRequired?: boolean + + /** + * Dropbox OAuth Authorization URL + * @default 'https://www.dropbox.com/oauth2/authorize' + */ + authorizationURL?: string + + /** + * Dropbox OAuth Token URL + * @default 'https://api.dropboxapi.com/oauth2/token' + */ + tokenURL?: string + + /** + * Extra authorization parameters to provide to the authorization URL + * @see https://www.dropbox.com/developers/documentation/http/documentation#authorization + * @example { locale: 'en-US' } + */ + authorizationParams?: Record + /** + * Redirect URL to to allow overriding for situations like prod failing to determine public hostname + * @default process.env.NUXT_OAUTH_DROPBOX_REDIRECT_URL or current URL + */ + redirectURL?: string +} + +export function oauthDropboxEventHandler({ config, onSuccess, onError }: OAuthConfig) { + return eventHandler(async (event: H3Event) => { + config = defu(config, useRuntimeConfig(event).oauth?.dropbox, { + authorizationURL: 'https://www.dropbox.com/oauth2/authorize', + tokenURL: 'https://api.dropboxapi.com/oauth2/token', + authorizationParams: {}, + }) as OAuthDropboxConfig + + const query = getQuery<{ code?: string }>(event) + + if (!config.clientId) { + return handleMissingConfiguration(event, 'dropbox', ['clientId'], onError) + } + + const redirectURL = config.redirectURL || getOAuthRedirectURL(event) + if (!query.code) { + config.scope = config.scope || [] + if (!config.scope.includes('openid')) { + config.scope.push('openid') + } + if (config.emailRequired && !config.scope.includes('email')) { + config.scope.push('email') + } + + // Redirect to Dropbox Oauth page + return sendRedirect( + event, + withQuery(config.authorizationURL as string, { + response_type: 'code', + client_id: config.clientId, + redirect_uri: redirectURL, + scope: config.scope.join(' '), + ...config.authorizationParams, + }), + ) + } + + const tokens = await requestAccessToken(config.tokenURL as string, { + headers: { + Authorization: `Basic ${Buffer.from(`${config.clientId}:${config.clientSecret}`).toString('base64')}`, + }, + params: { + grant_type: 'authorization_code', + redirect_uri: redirectURL, + code: query.code, + }, + }) + + if (tokens.error) { + return handleAccessTokenErrorResponse(event, 'dropbox', tokens, onError) + } + + const accessToken = tokens.access_token + + // TODO: improve typing + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const users: any = await $fetch('https://api.dropboxapi.com/2/openid/userinfo', { + method: 'POST', + headers: { + Authorization: `Bearer ${accessToken}`, + }, + }) + + const user = users + + if (!user) { + const error = createError({ + statusCode: 500, + message: 'Could not get Dropbox user', + data: tokens, + }) + if (!onError) throw error + return onError(event, error) + } + + return onSuccess(event, { + tokens, + user, + }) + }) +} diff --git a/src/runtime/types/oauth-config.ts b/src/runtime/types/oauth-config.ts index 76d495af..dd154c51 100644 --- a/src/runtime/types/oauth-config.ts +++ b/src/runtime/types/oauth-config.ts @@ -1,6 +1,6 @@ import type { H3Event, H3Error } from 'h3' -export type OAuthProvider = 'auth0' | 'battledotnet' | 'cognito' | 'discord' | 'facebook' | 'github' | 'gitlab' | 'google' | 'instagram' | 'keycloak' | 'linkedin' | 'microsoft' | 'paypal' | 'spotify' | 'steam' | 'tiktok' | 'twitch' | 'vk' | 'x' | 'xsuaa' | 'yandex' | (string & {}) +export type OAuthProvider = 'auth0' | 'battledotnet' | 'cognito' | 'discord' | 'dropbox' | 'facebook' | 'github' | 'gitlab' | 'google' | 'instagram' | 'keycloak' | 'linkedin' | 'microsoft' | 'paypal' | 'spotify' | 'steam' | 'tiktok' | 'twitch' | 'vk' | 'x' | 'xsuaa' | 'yandex' | (string & {}) export type OnError = (event: H3Event, error: H3Error) => Promise | void