Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 22x 13x 12x 11x 11x 11x 11x 11x 11x 11x 11x 1x 10x 10x 10x 10x 9x 8x 7x 7x 7x 1x 6x 6x 1x 5x 1x 4x 4x 4x 4x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 6x 2x 3x 1x 1x 1x 2x 1x 1x 4x 4x 4x 1x 21x 21x 15x 33x 32x 32x 20x 20x 18x 18x 2x 16x 16x 16x 13x 3x 30x 14x 30x 5x 9x | import http from 'http';
import querystring from 'querystring';
import {v4 as uuidv4} from 'uuid';
import Cookies from 'cookies';
import {Context} from '../../context';
import nonce from '../../utils/nonce';
import validateHmac from '../../utils/hmac-validator';
import validateShop from '../../utils/shop-validator';
import safeCompare from '../../utils/safe-compare';
import decodeSessionToken from '../../utils/decode-session-token';
import {Session} from '../session';
import {HttpClient} from '../../clients/http_client/http_client';
import {DataType} from '../../clients/http_client/types';
import * as ShopifyErrors from '../../error';
import {AuthQuery, AccessTokenResponse, OnlineAccessResponse, OnlineAccessInfo} from './types';
const ShopifyOAuth = {
SESSION_COOKIE_NAME: 'shopify_app_session',
/**
* Initializes a session and cookie for the OAuth process, and returns the necessary authorization url.
*
* @param request Current HTTP Request
* @param response Current HTTP Response
* @param shop Shop url: {shop}.myshopify.com
* @param redirect Redirect url for callback
* @param isOnline Boolean value. If true, appends 'per-user' grant options to authorization url to receive online access token.
* During final oauth request, will receive back the online access token and current online session information.
* Defaults to offline access.
*/
async beginAuth(
request: http.IncomingMessage,
response: http.ServerResponse,
shop: string,
redirectPath: string,
isOnline = false,
): Promise<string> {
Context.throwIfUninitialized();
Context.throwIfPrivateApp('Cannot perform OAuth for private apps');
const cookies = new Cookies(request, response, {
keys: [Context.API_SECRET_KEY],
secure: true,
});
const state = nonce();
const session = new Session(isOnline ? uuidv4() : this.getOfflineSessionId(shop));
session.shop = shop;
session.state = state;
session.isOnline = isOnline;
const sessionStored = await Context.SESSION_STORAGE.storeSession(session);
if (!sessionStored) {
throw new ShopifyErrors.SessionStorageError(
'OAuth Session could not be saved. Please check your session storage functionality.',
);
}
cookies.set(ShopifyOAuth.SESSION_COOKIE_NAME, session.id, {
signed: true,
expires: new Date(Date.now() + 60000),
sameSite: 'lax',
secure: true,
});
/* eslint-disable @typescript-eslint/naming-convention */
const query = {
client_id: Context.API_KEY,
scope: Context.SCOPES.toString(),
redirect_uri: `https://${Context.HOST_NAME}${redirectPath}`,
state,
'grant_options[]': isOnline ? 'per-user' : '',
};
/* eslint-enable @typescript-eslint/naming-convention */
const queryString = querystring.stringify(query);
return `https://${shop}/admin/oauth/authorize?${queryString}`;
},
/**
* Validates the received callback query.
* If valid, will make the subsequent request to update the current session with the appropriate access token.
* Throws errors for missing sessions and invalid callbacks.
*
* @param request Current HTTP Request
* @param response Current HTTP Response
* @param query Current HTTP Request Query, containing the information to be validated.
* Depending on framework, this may need to be cast as "unknown" before being passed.
*/
async validateAuthCallback(
request: http.IncomingMessage,
response: http.ServerResponse,
query: AuthQuery,
): Promise<void> {
Context.throwIfUninitialized();
Context.throwIfPrivateApp('Cannot perform OAuth for private apps');
const cookies = new Cookies(request, response, {
keys: [Context.API_SECRET_KEY],
secure: true,
});
const sessionCookie = this.getCookieSessionId(request, response);
if (!sessionCookie) {
throw new ShopifyErrors.CookieNotFound(
`Cannot complete OAuth process. Could not find an OAuth cookie for shop url: ${query.shop}`,
);
}
const currentSession = await Context.SESSION_STORAGE.loadSession(sessionCookie);
if (!currentSession) {
throw new ShopifyErrors.SessionNotFound(
`Cannot complete OAuth process. No session found for the specified shop url: ${query.shop}`,
);
}
if (!validQuery(query, currentSession)) {
throw new ShopifyErrors.InvalidOAuthError('Invalid OAuth callback.');
}
/* eslint-disable @typescript-eslint/naming-convention */
const body = {
client_id: Context.API_KEY,
client_secret: Context.API_SECRET_KEY,
code: query.code,
};
/* eslint-enable @typescript-eslint/naming-convention */
const postParams = {
path: '/admin/oauth/access_token',
type: DataType.JSON,
data: body,
};
const client = new HttpClient(currentSession.shop);
const postResponse = await client.post(postParams);
if (currentSession.isOnline) {
const responseBody = postResponse.body as OnlineAccessResponse;
const {access_token, scope, ...rest} = responseBody; // eslint-disable-line @typescript-eslint/naming-convention
const sessionExpiration = new Date(Date.now() + responseBody.expires_in * 1000);
currentSession.accessToken = access_token;
currentSession.expires = sessionExpiration;
currentSession.scope = scope;
currentSession.onlineAccessInfo = rest;
} else {
const responseBody = postResponse.body as AccessTokenResponse;
currentSession.accessToken = responseBody.access_token;
currentSession.scope = responseBody.scope;
}
// If this is an offline session, we're no longer interested in the cookie. If it is online in an embedded app, we
// want the cookie session to expire a few seconds from now to give the app time to load itself to set up a JWT.
// Otherwise, we want to leave the cookie session alone until the actual expiration.
let oauthSessionExpiration = currentSession.expires;
if (!currentSession.isOnline) {
oauthSessionExpiration = new Date();
} else if (Context.IS_EMBEDDED_APP) {
// If this is an online session for an embedded app, prepare a JWT session to be used going forward
const onlineInfo = currentSession.onlineAccessInfo as OnlineAccessInfo;
const jwtSessionId = this.getJwtSessionId(currentSession.shop, `${onlineInfo.associated_user.id}`);
const jwtSession = Session.cloneSession(currentSession, jwtSessionId);
await Context.SESSION_STORAGE.storeSession(jwtSession);
// Make sure the current OAuth session expires along with the cookie
oauthSessionExpiration = new Date(Date.now() + 30000);
currentSession.expires = oauthSessionExpiration;
}
cookies.set(ShopifyOAuth.SESSION_COOKIE_NAME, currentSession.id, {
signed: true,
expires: oauthSessionExpiration,
sameSite: 'lax',
secure: true,
});
const sessionStored = await Context.SESSION_STORAGE.storeSession(currentSession);
if (!sessionStored) {
throw new ShopifyErrors.SessionStorageError(
'OAuth Session could not be saved. Please check your session storage functionality.',
);
}
},
/**
* Loads the current session id from the session cookie.
*
* @param request HTTP request object
* @param response HTTP response object
*/
getCookieSessionId(request: http.IncomingMessage, response: http.ServerResponse): string | undefined {
const cookies = new Cookies(request, response, {
secure: true,
keys: [Context.API_SECRET_KEY],
});
return cookies.get(this.SESSION_COOKIE_NAME, {signed: true});
},
/**
* Builds a JWT session id from the current shop and user.
*
* @param shop Shopify shop domain
* @param userId Current actor id
*/
getJwtSessionId(shop: string, userId: string): string {
return `${shop}_${userId}`;
},
/**
* Builds an offline session id for the given shop.
*
* @param shop Shopify shop domain
*/
getOfflineSessionId(shop: string): string {
return `offline_${shop}`;
},
/**
* Extracts the current session id from the request / response pair.
*
* @param request HTTP request object
* @param response HTTP response object
* @param isOnline Whether to load online (default) or offline sessions (optional)
*/
getCurrentSessionId(
request: http.IncomingMessage,
response: http.ServerResponse,
IisOnline = true,
): string | undefined {
let currentSessionId: string | undefined;
if (Context.IS_EMBEDDED_APP) {
const authHeader = request.headers.authorization;
if (authHeader) {
const matches = authHeader.match(/^Bearer (.+)$/);
if (!matches) {
throw new ShopifyErrors.MissingJwtTokenError('Missing Bearer token in authorization header');
}
const jwtPayload = decodeSessionToken(matches[1]);
const shop = jwtPayload.dest.replace(/^https:\/\//, '');
if (isOnline) {
currentSessionId = this.getJwtSessionId(shop, jwtPayload.sub);
} else {
currentSessionId = this.getOfflineSessionId(shop);
}
}
}
// Non-embedded apps will always load sessions using cookies. However, we fall back to the cookie session for
// embedded apps to allow apps to load their skeleton page after OAuth, so they can set up App Bridge and get a new
// JWT.
if (!currentSessionId) {
// We still want to get the offline session id from the cookie to make sure it's validated
currentSessionId = this.getCookieSessionId(request, response);
}
return currentSessionId;
},
};
/**
* Uses the validation utils validateHmac, validateShop, and safeCompare to assess whether the callback is valid.
*
* @param query Current HTTP Request Query
* @param session Current session
*/
function validQuery(query: AuthQuery, session: Session): boolean {
return validateHmac(query) && validateShop(query.shop) && safeCompare(query.state, session.state as string);
}
export {ShopifyOAuth};
|