arc-plugin-oauth
Advanced tools
A plugin for adding OAuth to Architect apps. It includes mocking for local development so no provider keys are needed until you are ready to deploy.
To get started follow these steps:
npm i arc-plugin-oauth@app
oauth-example
@http
get /
@plugins
arc-plugin-oauth
@oauth
use-mock true
//src/shared/mock-allow.mjs
export default {
mockProviderAccounts: {
'Jane Doe': {
login: 'janedoe',
name: 'Jane Doe'
},
'John Smith': {
login: 'johnsmith',
name: 'John Smith'
}
},
appAccounts: {
janedoe: {
role: 'member',
name: 'Jane Doe'
},
johnsmith: {
role: 'member',
name: 'John Smith'
}
}
}
//src/http/get-index/index.mjs
import arc from '@architect/functions'
import arcOauth from 'arc-plugin-oauth'
const auth = arcOauth.auth
export const handler = arc.http.async(auth, index)
async function index(req) {
return {
html: `
<html>
<head>
</head>
<body>
<p> You are Authenticated </p>
<form method="post" action="/logout" >
<button type="submit">Logout</button>
</form>
</body>
</html>
`
}
}
The plugin adds the following built-in routes:
get /auth: The primary route for decoding and verifying OAuth tokens from providers. This is the route that OAuth redirects are pointed to.get /login: A basic login page. This route can be replaced with a custom version using the loginHref helper.post /logout: Post route that clears the session cookies causing the user to be logged out.get /mock/auth: Acts as a mock provider for local development. If mocking is disabled this route is not included.By default all routes are included. They can be customized using the routes parameter parameter.
The plugin is configured under the @oauth pragma in the app manifest file. With zero config it provides a working OAuth setup for Github.
@plugins
arc-plugin-oauth
@oauth
@plugins
arc-plugin-oauth
@oauth
provider github
use-mock true
match-property login
include-properties name login
routes login auth logout mock
allow-list allow.mjs
mock-list mock-allow.mjs
after-auth-redirect /
un-auth-redirect /login
provider:
OAuth provider to use
use-mock:
Use mock OAuth provider for local development
match-property:
Provider property to match against app accounts for authorization.
logininclude-properties:
Additional provider account properties to keep in session.
routes:
Built-in routes to include.
routes auth logout mock will remove the login route)allow-list:
Use simple allow list for authorization.
allow-list oauth/custom-allow-file.mjs points to src/shared/oauth/custom-allow-file.mjsmock-list:
Custom mock allow list. Any subdirectory in the shared folder may be specified.
after-auth-redirect:
URL to redirect to after authentication.
un-auth-redirect:
URL to redirect to for unauthorized users.
custom-authorize:
URL to redirect after login for custom authorization.loginHref helperProvides url for a login button. The built-in login route provides basic functionality to get started. It is un-styled. To build a custom login page or to add a login button from anywhere in the app do the following:
# app.arc manifest
...
@http
get /login # adds a custom '/login' route
@oauth
routes auth logout # removes the built-in '/login' route
Use the loginHref() function as shown below to point to initiate the login. This is a function that is executed in the handler because it needs to access the environment variable ARC_OAUTH_REDIRECT_URL at execution time (see setup OAuth Providers).
// src/http/get-login/index.mjs
import arc from '@architect/functions'
import arcOauth from 'arc-plugin-oauth'
const href = arcOauth.loginHref()
export const handler = arc.http.async(login)
async function login () {
return {
statusCode: 200,
html: `<a href="${href}">Login with Github</a>`
}
}
auth and authRedirect helpersThe auth middleware checks to see if the user is authenticated before passing execution to the next middleware. In the example below if the user is not authenticated they will be redirected to the login page instead of passing to the index handler.
//src/http/get-index/index.mjs
import arc from '@architect/functions'
import arcOauth from 'arc-plugin-oauth'
const auth = arcOauth.auth
export const handler = arc.http.async(auth, index)
async function index(req) {
return {
html: `
<body>
<p> You are Authenticated </p>
</body>
`
}
}
In order to redirect to a custom route instead of to the configured default use the authRedirect handler as follows:
//src/http/get-index/index.mjs
import arc from '@architect/functions'
import arcOauth from 'arc-plugin-oauth'
const authRedirect = arcOauth.authRedirect
export const handler = arc.http.async(authRedirect('/signup'), index)
checkAuth helperIf you want to check authentication status without using the middleware to redirect you can use the checkAuth helper. This helper returns the authentication user for branching or other logic. It returns false if unauthenticated.
//src/http/get-index/index.mjs
import arc from '@architect/functions'
import arcOauth from 'arc-plugin-oauth'
const checkAuth = arcOauth.checkAuth
export const handler = arc.http.async(index)
async function index(req) {
const authenticated = checkAuth(req)
if(authenticated) {
return {
html: ` <p> You are Authenticated </p> `
}
} else{
return {
html: ` <p> You are a Guest </p> `
}
}
}
Authentication and authorization are tightly coupled. Authentication is verifying that a user is who they say they are. Authorization is verifying that they are allowed to do what they are requesting. OAuth handles the first concern, but the application must handle the second.
This plugin has a simple way to specify a list of authorized users covering authorization for many use cases. If your application requires database backed user accounts or other advanced authorization needs see advanced authorization below.
The allow-list is a file that exports a map from oauth users to authorized application users. For a basic application where a small number of users can be manually added to the allow list this may work for the full application authorization. The allow list is specified in the manifest file as:
@oauth
allow-list allow.mjs
This file should be put in the src/shared/ folder. The default is allow.mjs. A sample list is shown below:
export default {
appAccounts: {
janedoe: {
role: 'member',
name: 'Jane Doe'
},
johnsmith: {
role: 'member',
name: 'John Smith'
}
}
}
In this example the oauth user with a login of 'janedoe' will be assigned an application user account { role: 'member', name: 'Jane Doe' }.
The Mocking for user accounts is similar to the allow list above, but it adds mock values for the oauth provider accounts as well. The mock list defaults to src/shared/mock-allow.mjs or it can be specified with mock-list custom-mock.mjs in the @oauth pragma. A sample mock-allow is shown below.
//src/shared/mock-allow.mjs
export default {
mockProviderAccounts: {
'Jane Doe': {
login: 'janedoe',
name: 'Jane Doe'
},
'John Smith': {
login: 'johnsmith',
name: 'John Smith'
}
},
appAccounts: {
janedoe: {
role: 'member',
name: 'Jane Doe'
},
johnsmith: {
role: 'member',
name: 'John Smith'
}
}
}
In this example the mockProviderAccounts are shown as options in the login flow. The corresponding app accounts are exported from the mock file as well.
Authorization can be done against user accounts stored in a database or other source. To do this allow-list must be disabled, which is the default configuration if there is no allow-list setting under the @oauth pragma.
Next an '/authorization' route can be setup in the app that contains the user authorization logic.
# app.arc manifest
@http
get /authorization
The custom authorize route is set as with the custom-authorize parameter:
@oauth
custom-authorize /authorize
Finally the authorization handler can be added as follows:
// src/http/get-authorization/index.mjs
import arc from '@architect/functions'
import begin from '@begin/data'
export const handler = arc.http.async(authorize)
async function authorize (req) {
const data = await begin()
const providerAccount = req?.session?.oauth
const session = req?.session
if (providerAccount) {
const matchOn = process.env.ARC_OAUTH_MATCH_PROPERTY
const appUser = await data.get({table:'users',key:providerAccount[matchOn]})
if (appUser) {
const newSession = { ...session, account:appUser}
return {
session:newSession,
location: process.env.ARC_OAUTH_AFTER_AUTH
}
}
else {
return {
statusCode: 401,
body: 'not authorized'
}
}
}
else {
return {
statusCode: 302,
location: process.env.ARC_OAUTH_UN_AUTH_REDIRECT
}
}
}
If the new application user account is assigned to sessions.account then all the auth helper functions (auth, checkAuth etc.) will work as before.
The application user object should be stored in session.account to ensure auth helper functions work correctly. Any of the application account user properties can be accessed there. The oauth account properties that are included with the include-properties configuration can be found in the req.session.oauth object.
To configure an OAuth provider (i.e. Github) for a staging or production environment the following environment variables should be set:
FAQs
Architect OAuth Plugin
The npm package arc-plugin-oauth receives a total of 1 weekly downloads. As such, arc-plugin-oauth popularity was classified as not popular.
We found that arc-plugin-oauth demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.