@eggjs/security 5.0.0-beta.34 → 5.0.0-beta.36

package/dist/app/extend/context.js

@@ -1,243 +1,188 @@
-import { debuglog } from 'node:util';
-import { nanoid } from 'nanoid/non-secure';
-import Tokens from 'csrf';
-import { Context } from 'egg';
-import * as utils from "../../lib/utils.js";
-const debug = debuglog('egg/security/app/extend/context');
+import { checkIfIgnore, getFromUrl, isSafeDomain } from "../../lib/utils.js";
+import { Context } from "egg";
+import { debuglog } from "node:util";
+import Tokens from "csrf";
+import { nanoid } from "nanoid/non-secure";
+
+//#region src/app/extend/context.ts
+const debug = debuglog("egg/security/app/extend/context");
 const tokens = new Tokens();
-const _CSRF_SECRET = Symbol('egg-security#_CSRF_SECRET');
-const NEW_CSRF_SECRET = Symbol('egg-security#NEW_CSRF_SECRET');
-const NONCE_CACHE = Symbol('egg-security#NONCE_CACHE');
-const SECURITY_OPTIONS = Symbol('egg-security#SECURITY_OPTIONS');
+const _CSRF_SECRET = Symbol("egg-security#_CSRF_SECRET");
+const NEW_CSRF_SECRET = Symbol("egg-security#NEW_CSRF_SECRET");
+const NONCE_CACHE = Symbol("egg-security#NONCE_CACHE");
+const SECURITY_OPTIONS = Symbol("egg-security#SECURITY_OPTIONS");
 function findToken(obj, keys) {
-    if (!obj)
-        return;
-    if (!keys || !keys.length)
-        return;
-    if (typeof keys === 'string')
-        return obj[keys];
-    for (const key of keys) {
-        if (obj[key])
-            return obj[key];
-    }
+	if (!obj) return;
+	if (!keys || !keys.length) return;
+	if (typeof keys === "string") return obj[keys];
+	for (const key of keys) if (obj[key]) return obj[key];
 }
-export default class SecurityContext extends Context {
-    get securityOptions() {
-        if (!this[SECURITY_OPTIONS]) {
-            this[SECURITY_OPTIONS] = {};
-        }
-        return this[SECURITY_OPTIONS];
-    }
-    /**
-     * Check whether the specific `domain` is in / matches the whiteList or not.
-     * @param {string} domain The assigned domain.
-     * @param {Array<string>} [customWhiteList] The custom white list for domain.
-     * @return {boolean} If the domain is in / matches the whiteList, return true;
-     * otherwise false.
-     */
-    isSafeDomain(domain, customWhiteList) {
-        const domainWhiteList = customWhiteList && customWhiteList.length > 0 ? customWhiteList : this.app.config.security.domainWhiteList;
-        return utils.isSafeDomain(domain, domainWhiteList);
-    }
-    // Add nonce, random characters will be OK.
-    // https://w3c.github.io/webappsec/specs/content-security-policy/#nonce_source
-    get nonce() {
-        if (!this[NONCE_CACHE]) {
-            this[NONCE_CACHE] = nanoid(16);
-        }
-        return this[NONCE_CACHE];
-    }
-    /**
-     * get csrf token, general use in template
-     * @return {String} csrf token
-     * @public
-     */
-    get csrf() {
-        // csrfSecret can be rotate, use NEW_CSRF_SECRET first
-        const secret = this[NEW_CSRF_SECRET] || this.getCsrfSecret();
-        debug('get csrf token, NEW_CSRF_SECRET: %s, _CSRF_SECRET: %s', this[NEW_CSRF_SECRET], this.getCsrfSecret());
-        //  In order to protect against BREACH attacks,
-        //  the token is not simply the secret;
-        //  a random salt is prepended to the secret and used to scramble it.
-        //  http://breachattack.com/
-        return secret ? tokens.create(secret) : '';
-    }
-    /**
-     * get csrf secret from session or cookie
-     * @return {String} csrf secret
-     * @private
-     */
-    getCsrfSecret() {
-        if (this[_CSRF_SECRET]) {
-            return this[_CSRF_SECRET];
-        }
-        let { useSession, sessionName, cookieName: cookieNames, cookieOptions } = this.app.config.security.csrf;
-        // get secret from session or cookie
-        if (useSession) {
-            this[_CSRF_SECRET] = this.session[sessionName] || '';
-        }
-        else {
-            // cookieName support array. so we can change csrf cookie name smoothly
-            if (!Array.isArray(cookieNames)) {
-                cookieNames = [cookieNames];
-            }
-            for (const cookieName of cookieNames) {
-                this[_CSRF_SECRET] = this.cookies.get(cookieName, { signed: cookieOptions.signed }) || '';
-                if (this[_CSRF_SECRET]) {
-                    break;
-                }
-            }
-        }
-        return this[_CSRF_SECRET];
-    }
-    /**
-     * ensure csrf secret exists in session or cookie.
-     * @param {Boolean} [rotate] reset secret even if the secret exists
-     * @public
-     */
-    ensureCsrfSecret(rotate) {
-        const csrfSecret = this.getCsrfSecret();
-        if (csrfSecret && !rotate) {
-            return;
-        }
-        debug('ensure csrf secret, exists: %s, rotate; %s', csrfSecret, rotate);
-        const secret = tokens.secretSync();
-        this[NEW_CSRF_SECRET] = secret;
-        let { useSession, sessionName, cookieDomain, cookieName: cookieNames, cookieOptions, } = this.app.config.security.csrf;
-        if (useSession) {
-            // TODO(fengmk2): need to refactor egg-session plugin to support ctx.session type define
-            this.session[sessionName] = secret;
-        }
-        else {
-            if (typeof cookieDomain === 'function') {
-                cookieDomain = cookieDomain(this);
-            }
-            const cookieOpts = {
-                domain: cookieDomain,
-                ...cookieOptions,
-            };
-            // cookieName support array. so we can change csrf cookie name smoothly
-            if (!Array.isArray(cookieNames)) {
-                cookieNames = [cookieNames];
-            }
-            for (const cookieName of cookieNames) {
-                this.cookies.set(cookieName, secret, cookieOpts);
-            }
-        }
-    }
-    getInputToken() {
-        const { headerName, bodyName, queryName } = this.app.config.security.csrf;
-        // try order: query, body, header
-        const token = findToken(this.request.query, queryName) ||
-            findToken(this.request.body, bodyName) ||
-            (headerName && this.request.get(headerName));
-        debug('get token: %j, secret: %j', token, this.getCsrfSecret());
-        return token;
-    }
-    /**
-     * rotate csrf secret exists in session or cookie.
-     * must rotate the secret when user login
-     * @public
-     */
-    rotateCsrfSecret() {
-        if (!this[NEW_CSRF_SECRET] && this.getCsrfSecret()) {
-            this.ensureCsrfSecret(true);
-        }
-    }
-    /**
-     * assert csrf token/referer is present
-     * @public
-     */
-    assertCsrf() {
-        if (utils.checkIfIgnore(this.app.config.security.csrf, this)) {
-            debug('%s, ignore by csrf options', this.path);
-            return;
-        }
-        const { type } = this.app.config.security.csrf;
-        let message;
-        const messages = [];
-        switch (type) {
-            case 'ctoken':
-                message = this.csrfCtokenCheck();
-                if (message)
-                    this.throw(403, message);
-                break;
-            case 'referer':
-                message = this.csrfRefererCheck();
-                if (message)
-                    this.throw(403, message);
-                break;
-            case 'all':
-                message = this.csrfCtokenCheck();
-                if (message)
-                    this.throw(403, message);
-                message = this.csrfRefererCheck();
-                if (message)
-                    this.throw(403, message);
-                break;
-            case 'any':
-                message = this.csrfCtokenCheck();
-                if (!message)
-                    return;
-                messages.push(message);
-                message = this.csrfRefererCheck();
-                if (!message)
-                    return;
-                messages.push(message);
-                this.throw(403, `both ctoken and referer check error: ${messages.join(', ')}`);
-                break;
-            default:
-                // @oxlint-disable-next-line Invalid type "never" of template literal expression
-                this.throw(`invalid type ${type}`);
-        }
-    }
-    csrfCtokenCheck() {
-        const csrfSecret = this.getCsrfSecret();
-        if (!csrfSecret) {
-            debug('missing csrf token');
-            this.logCsrfNotice('missing csrf token');
-            return 'missing csrf token';
-        }
-        const token = this.getInputToken();
-        // AJAX requests get csrf token from cookie, in this situation token will equal to secret
-        // synchronize form requests' token always changing to protect against BREACH attacks
-        if (token !== csrfSecret && !tokens.verify(csrfSecret, token)) {
-            debug('verify secret and token error');
-            this.logCsrfNotice('invalid csrf token');
-            const { rotateWhenInvalid } = this.app.config.security.csrf;
-            if (rotateWhenInvalid) {
-                this.rotateCsrfSecret();
-            }
-            return 'invalid csrf token';
-        }
-    }
-    csrfRefererCheck() {
-        const { refererWhiteList } = this.app.config.security.csrf;
-        // check Origin/Referer headers
-        const referer = (this.headers.referer ?? this.headers.origin ?? '').toLowerCase();
-        if (!referer) {
-            debug('missing csrf referer or origin');
-            this.logCsrfNotice('missing csrf referer or origin');
-            return 'missing csrf referer or origin';
-        }
-        const host = utils.getFromUrl(referer, 'host');
-        const domainList = refererWhiteList.concat(this.host);
-        if (!host || !utils.isSafeDomain(host, domainList)) {
-            debug('verify referer or origin error');
-            this.logCsrfNotice('invalid csrf referer or origin');
-            return 'invalid csrf referer or origin';
-        }
-    }
-    logCsrfNotice(msg) {
-        if (this.app.config.env === 'local') {
-            this.logger.warn(`${msg}. See https://eggjs.org/zh-CN/core/security/#%E5%AE%89%E5%85%A8%E5%A8%81%E8%83%81-csrf-%E7%9A%84%E9%98%B2%E8%8C%83`);
-        }
-    }
-    async safeCurl(url, options) {
-        return await this.app.safeCurl(url, options);
-    }
-    unsafeRedirect(url, alt) {
-        this.response.unsafeRedirect(url, alt);
-    }
-}
-//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../src/app/extend/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,MAAM,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAE9B,OAAO,KAAK,KAAK,MAAM,oBAAoB,CAAC;AAK5C,MAAM,KAAK,GAAG,QAAQ,CAAC,iCAAiC,CAAC,CAAC;AAE1D,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;AAE5B,MAAM,YAAY,GAAG,MAAM,CAAC,2BAA2B,CAAC,CAAC;AACzD,MAAM,eAAe,GAAG,MAAM,CAAC,8BAA8B,CAAC,CAAC;AAC/D,MAAM,WAAW,GAAG,MAAM,CAAC,0BAA0B,CAAC,CAAC;AACvD,MAAM,gBAAgB,GAAG,MAAM,CAAC,+BAA+B,CAAC,CAAC;AAEjE,SAAS,SAAS,CAAC,GAA2B,EAAE,IAAuB;IACrE,IAAI,CAAC,GAAG;QAAE,OAAO;IACjB,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM;QAAE,OAAO;IAClC,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;AACH,CAAC;AAED,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,OAAO;IAGlD,IAAI,eAAe;QACjB,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC;QAC9B,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAA4B,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,MAAc,EAAE,eAA0B;QACrD,MAAM,eAAe,GACnB,eAAe,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC7G,OAAO,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACrD,CAAC;IAED,2CAA2C;IAC3C,8EAA8E;IAC9E,IAAI,KAAK;QACP,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAW,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,sDAAsD;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;QAC7D,KAAK,CAAC,uDAAuD,EAAE,IAAI,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAC5G,+CAA+C;QAC/C,uCAAuC;QACvC,qEAAqE;QACrE,4BAA4B;QAC5B,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACK,aAAa;QACnB,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,YAAY,CAAW,CAAC;QACtC,CAAC;QACD,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QACxG,oCAAoC;QACpC,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,YAAY,CAAC,GAAI,IAAI,CAAC,OAAe,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,uEAAuE;YACvE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAChC,WAAW,GAAG,CAAC,WAAW,CAAC,CAAC;YAC9B,CAAC;YACD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;gBACrC,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;gBAC1F,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;oBACvB,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAW,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAAgB;QAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACxC,IAAI,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QACD,KAAK,CAAC,4CAA4C,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QACxE,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC;QAC/B,IAAI,EACF,UAAU,EACV,WAAW,EACX,YAAY,EACZ,UAAU,EAAE,WAAW,EACvB,aAAa,GACd,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAElC,IAAI,UAAU,EAAE,CAAC;YACf,wFAAwF;YACvF,IAAI,CAAC,OAAe,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;gBACvC,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;YACpC,CAAC;YACD,MAAM,UAAU,GAAG;gBACjB,MAAM,EAAE,YAAY;gBACpB,GAAG,aAAa;aACjB,CAAC;YACF,uEAAuE;YACvE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAChC,WAAW,GAAG,CAAC,WAAW,CAAC,CAAC;YAC9B,CAAC;YACD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;gBACrC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;IACH,CAAC;IAEO,aAAa;QACnB,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC1E,iCAAiC;QACjC,MAAM,KAAK,GACT,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC;YACxC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;YACtC,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAS,UAAU,CAAC,CAAC,CAAC;QACvD,KAAK,CAAC,2BAA2B,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACnD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,IAAI,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YAC7D,KAAK,CAAC,4BAA4B,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,OAAO;QACT,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC/C,IAAI,OAAO,CAAC;QACZ,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,QAAQ;gBACX,OAAO,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;gBACjC,IAAI,OAAO;oBAAE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACtC,MAAM;YACR,KAAK,SAAS;gBACZ,OAAO,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAClC,IAAI,OAAO;oBAAE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACtC,MAAM;YACR,KAAK,KAAK;gBACR,OAAO,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;gBACjC,IAAI,OAAO;oBAAE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACtC,OAAO,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAClC,IAAI,OAAO;oBAAE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACtC,MAAM;YACR,KAAK,KAAK;gBACR,OAAO,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;gBACjC,IAAI,CAAC,OAAO;oBAAE,OAAO;gBACrB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvB,OAAO,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAClC,IAAI,CAAC,OAAO;oBAAE,OAAO;gBACrB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvB,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,wCAAwC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAC/E,MAAM;YACR;gBACE,gFAAgF;gBAChF,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAEO,eAAe;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACxC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,KAAK,CAAC,oBAAoB,CAAC,CAAC;YAC5B,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YACzC,OAAO,oBAAoB,CAAC;QAC9B,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACnC,yFAAyF;QACzF,qFAAqF;QACrF,IAAI,KAAK,KAAK,UAAU,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,KAAe,CAAC,EAAE,CAAC;YACxE,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACvC,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;YACzC,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC5D,IAAI,iBAAiB,EAAE,CAAC;gBACtB,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,CAAC;YACD,OAAO,oBAAoB,CAAC;QAC9B,CAAC;IACH,CAAC;IAEO,gBAAgB;QACtB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC3D,+BAA+B;QAC/B,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAElF,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,KAAK,CAAC,gCAAgC,CAAC,CAAC;YACxC,IAAI,CAAC,aAAa,CAAC,gCAAgC,CAAC,CAAC;YACrD,OAAO,gCAAgC,CAAC;QAC1C,CAAC;QAED,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC;YACnD,KAAK,CAAC,gCAAgC,CAAC,CAAC;YACxC,IAAI,CAAC,aAAa,CAAC,gCAAgC,CAAC,CAAC;YACrD,OAAO,gCAAgC,CAAC;QAC1C,CAAC;IACH,CAAC;IAEO,aAAa,CAAC,GAAW;QAC/B,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,KAAK,OAAO,EAAE,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,GAAG,GAAG,oHAAoH,CAC3H,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAU,GAAyB,EAAE,OAA2B;QAC5E,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAI,GAAG,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,cAAc,CAAC,GAAW,EAAE,GAAY;QACtC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;CACF"}
+var SecurityContext = class extends Context {
+	get securityOptions() {
+		if (!this[SECURITY_OPTIONS]) this[SECURITY_OPTIONS] = {};
+		return this[SECURITY_OPTIONS];
+	}
+	/**
+	* Check whether the specific `domain` is in / matches the whiteList or not.
+	* @param {string} domain The assigned domain.
+	* @param {Array<string>} [customWhiteList] The custom white list for domain.
+	* @return {boolean} If the domain is in / matches the whiteList, return true;
+	* otherwise false.
+	*/
+	isSafeDomain(domain, customWhiteList) {
+		const domainWhiteList = customWhiteList && customWhiteList.length > 0 ? customWhiteList : this.app.config.security.domainWhiteList;
+		return isSafeDomain(domain, domainWhiteList);
+	}
+	get nonce() {
+		if (!this[NONCE_CACHE]) this[NONCE_CACHE] = nanoid(16);
+		return this[NONCE_CACHE];
+	}
+	/**
+	* get csrf token, general use in template
+	* @return {String} csrf token
+	* @public
+	*/
+	get csrf() {
+		const secret = this[NEW_CSRF_SECRET] || this.getCsrfSecret();
+		debug("get csrf token, NEW_CSRF_SECRET: %s, _CSRF_SECRET: %s", this[NEW_CSRF_SECRET], this.getCsrfSecret());
+		return secret ? tokens.create(secret) : "";
+	}
+	/**
+	* get csrf secret from session or cookie
+	* @return {String} csrf secret
+	* @private
+	*/
+	getCsrfSecret() {
+		if (this[_CSRF_SECRET]) return this[_CSRF_SECRET];
+		let { useSession, sessionName, cookieName: cookieNames, cookieOptions } = this.app.config.security.csrf;
+		if (useSession) this[_CSRF_SECRET] = this.session[sessionName] || "";
+		else {
+			if (!Array.isArray(cookieNames)) cookieNames = [cookieNames];
+			for (const cookieName of cookieNames) {
+				this[_CSRF_SECRET] = this.cookies.get(cookieName, { signed: cookieOptions.signed }) || "";
+				if (this[_CSRF_SECRET]) break;
+			}
+		}
+		return this[_CSRF_SECRET];
+	}
+	/**
+	* ensure csrf secret exists in session or cookie.
+	* @param {Boolean} [rotate] reset secret even if the secret exists
+	* @public
+	*/
+	ensureCsrfSecret(rotate) {
+		const csrfSecret = this.getCsrfSecret();
+		if (csrfSecret && !rotate) return;
+		debug("ensure csrf secret, exists: %s, rotate; %s", csrfSecret, rotate);
+		const secret = tokens.secretSync();
+		this[NEW_CSRF_SECRET] = secret;
+		let { useSession, sessionName, cookieDomain, cookieName: cookieNames, cookieOptions } = this.app.config.security.csrf;
+		if (useSession) this.session[sessionName] = secret;
+		else {
+			if (typeof cookieDomain === "function") cookieDomain = cookieDomain(this);
+			const cookieOpts = {
+				domain: cookieDomain,
+				...cookieOptions
+			};
+			if (!Array.isArray(cookieNames)) cookieNames = [cookieNames];
+			for (const cookieName of cookieNames) this.cookies.set(cookieName, secret, cookieOpts);
+		}
+	}
+	getInputToken() {
+		const { headerName, bodyName, queryName } = this.app.config.security.csrf;
+		const token = findToken(this.request.query, queryName) || findToken(this.request.body, bodyName) || headerName && this.request.get(headerName);
+		debug("get token: %j, secret: %j", token, this.getCsrfSecret());
+		return token;
+	}
+	/**
+	* rotate csrf secret exists in session or cookie.
+	* must rotate the secret when user login
+	* @public
+	*/
+	rotateCsrfSecret() {
+		if (!this[NEW_CSRF_SECRET] && this.getCsrfSecret()) this.ensureCsrfSecret(true);
+	}
+	/**
+	* assert csrf token/referer is present
+	* @public
+	*/
+	assertCsrf() {
+		if (checkIfIgnore(this.app.config.security.csrf, this)) {
+			debug("%s, ignore by csrf options", this.path);
+			return;
+		}
+		const { type } = this.app.config.security.csrf;
+		let message;
+		const messages = [];
+		switch (type) {
+			case "ctoken":
+				message = this.csrfCtokenCheck();
+				if (message) this.throw(403, message);
+				break;
+			case "referer":
+				message = this.csrfRefererCheck();
+				if (message) this.throw(403, message);
+				break;
+			case "all":
+				message = this.csrfCtokenCheck();
+				if (message) this.throw(403, message);
+				message = this.csrfRefererCheck();
+				if (message) this.throw(403, message);
+				break;
+			case "any":
+				message = this.csrfCtokenCheck();
+				if (!message) return;
+				messages.push(message);
+				message = this.csrfRefererCheck();
+				if (!message) return;
+				messages.push(message);
+				this.throw(403, `both ctoken and referer check error: ${messages.join(", ")}`);
+				break;
+			default: this.throw(`invalid type ${type}`);
+		}
+	}
+	csrfCtokenCheck() {
+		const csrfSecret = this.getCsrfSecret();
+		if (!csrfSecret) {
+			debug("missing csrf token");
+			this.logCsrfNotice("missing csrf token");
+			return "missing csrf token";
+		}
+		const token = this.getInputToken();
+		if (token !== csrfSecret && !tokens.verify(csrfSecret, token)) {
+			debug("verify secret and token error");
+			this.logCsrfNotice("invalid csrf token");
+			const { rotateWhenInvalid } = this.app.config.security.csrf;
+			if (rotateWhenInvalid) this.rotateCsrfSecret();
+			return "invalid csrf token";
+		}
+	}
+	csrfRefererCheck() {
+		const { refererWhiteList } = this.app.config.security.csrf;
+		const referer = (this.headers.referer ?? this.headers.origin ?? "").toLowerCase();
+		if (!referer) {
+			debug("missing csrf referer or origin");
+			this.logCsrfNotice("missing csrf referer or origin");
+			return "missing csrf referer or origin";
+		}
+		const host = getFromUrl(referer, "host");
+		const domainList = refererWhiteList.concat(this.host);
+		if (!host || !isSafeDomain(host, domainList)) {
+			debug("verify referer or origin error");
+			this.logCsrfNotice("invalid csrf referer or origin");
+			return "invalid csrf referer or origin";
+		}
+	}
+	logCsrfNotice(msg) {
+		if (this.app.config.env === "local") this.logger.warn(`${msg}. See https://eggjs.org/zh-CN/core/security/#%E5%AE%89%E5%85%A8%E5%A8%81%E8%83%81-csrf-%E7%9A%84%E9%98%B2%E8%8C%83`);
+	}
+	async safeCurl(url, options) {
+		return await this.app.safeCurl(url, options);
+	}
+	unsafeRedirect(url, alt) {
+		this.response.unsafeRedirect(url, alt);
+	}
+};
+
+//#endregion
+export { SecurityContext as default };

package/dist/app/extend/helper.d.ts

@@ -1,3 +1,6 @@
-import helpers from '../../lib/helper/index.ts';
+import helpers from "../../lib/helper/index.js";
+
+//#region src/app/extend/helper.d.ts
 declare const securityHelpers: typeof helpers;
-export default securityHelpers;
+//#endregion
+export { securityHelpers as default };

package/dist/app/extend/helper.js

@@ -1,6 +1,8 @@
-import helpers from "../../lib/helper/index.js";
-const securityHelpers = {
-    ...helpers,
-};
-export default securityHelpers;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2FwcC9leHRlbmQvaGVscGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sT0FBTyxNQUFNLDJCQUEyQixDQUFDO0FBRWhELE1BQU0sZUFBZSxHQUFtQjtJQUN0QyxHQUFHLE9BQU87Q0FDWCxDQUFDO0FBRUYsZUFBZSxlQUFlLENBQUMifQ==
+import helper_default$1 from "../../lib/helper/index.js";
+
+//#region src/app/extend/helper.ts
+const securityHelpers = { ...helper_default$1 };
+var helper_default = securityHelpers;
+
+//#endregion
+export { helper_default as default };

package/dist/app/extend/response.d.ts

@@ -1,35 +1,39 @@
-import { Response } from 'egg';
-import SecurityContext from './context.ts';
-export default class SecurityResponse extends Response {
-    ctx: SecurityContext;
-    /**
-     * This is an unsafe redirection, and we WON'T check if the
-     * destination url is safe or not.
-     * Please DO NOT use this method unless in some very special cases,
-     * otherwise there may be security vulnerabilities.
-     *
-     * @function Response#unsafeRedirect
-     * @param {String} url URL to forward
-     * @example
-     * ```js
-     * ctx.response.unsafeRedirect('http://www.domain.com');
-     * ctx.unsafeRedirect('http://www.domain.com');
-     * ```
-     */
-    unsafeRedirect(url: string, alt?: string): void;
-    /**
-     * A safe redirection, and we'll check if the URL is in
-     * a safe domain or not.
-     * We've overridden the default Koa's implementation by adding a
-     * white list as the filter for that.
-     *
-     * @function Response#redirect
-     * @param {String} url URL to forward
-     * @example
-     * ```js
-     * ctx.response.redirect('/login');
-     * ctx.redirect('/login');
-     * ```
-     */
-    redirect(url: string, alt?: string): void;
+import SecurityContext from "./context.js";
+import { Response } from "egg";
+
+//#region src/app/extend/response.d.ts
+declare class SecurityResponse extends Response {
+  ctx: SecurityContext;
+  /**
+  * This is an unsafe redirection, and we WON'T check if the
+  * destination url is safe or not.
+  * Please DO NOT use this method unless in some very special cases,
+  * otherwise there may be security vulnerabilities.
+  *
+  * @function Response#unsafeRedirect
+  * @param {String} url URL to forward
+  * @example
+  * ```js
+  * ctx.response.unsafeRedirect('http://www.domain.com');
+  * ctx.unsafeRedirect('http://www.domain.com');
+  * ```
+  */
+  unsafeRedirect(url: string, alt?: string): void;
+  /**
+  * A safe redirection, and we'll check if the URL is in
+  * a safe domain or not.
+  * We've overridden the default Koa's implementation by adding a
+  * white list as the filter for that.
+  *
+  * @function Response#redirect
+  * @param {String} url URL to forward
+  * @example
+  * ```js
+  * ctx.response.redirect('/login');
+  * ctx.redirect('/login');
+  * ```
+  */
+  redirect(url: string, alt?: string): void;
 }
+//#endregion
+export { SecurityResponse as default };