消息!使用 IdentityServer 保护 Vue 前端
2022-12-20 08:24:52    
前情提要

《使用 IdentityServer 保护 Web 应用(AntD Pro 前端 + SpringBoot 后端)》中记录了使用 IdentityServer 保护前后端的过程,其中的前端工程是以 UMI Js 为例。今天,再来记录一下使用 IdentityServer 保护 Vue 前端的过程,和 UMI Js 项目使用 umi plugin 的方式不同,本文没有使用 Vue 相关的插件,而是直接使用了 oidc-client js。


【资料图】

另外,我对 Vue 这个框架非常不熟,在 vue-router 这里稍微卡住了一段时间,后来瞎试居然又成功了。针对这个问题,我还去 StackOverflow 上问了,但并没有收到有效的回复:https://stackoverflow.com/questions/74769607/how-to-access-vues-methods-from-navigation-guard

准备工作

首先,需要在 IdentityServer 服务器端注册该 Vue 前端应用,仍然以代码写死这个客户端为例:

new Client{ClientId = "vue-client",ClientSecrets = { new Secret("vue-client".Sha256()) },ClientName = "vue client",AllowedGrantTypes = GrantTypes.Implicit,AllowAccessTokensViaBrowser = true,RequireClientSecret = false,RequirePkce = true,RedirectUris ={"http://localhost:8080/callback","http://localhost:8080/static/silent-renew.html",},AllowedCorsOrigins = { "http://localhost:8080" },AllowedScopes = { "openid", "profile", "email" },AllowOfflineAccess = true,AccessTokenLifetime = 90,AbsoluteRefreshTokenLifetime = 0,RefreshTokenUsage = TokenUsage.OneTimeOnly,RefreshTokenExpiration = TokenExpiration.Sliding,UpdateAccessTokenClaimsOnRefresh = true,RequireConsent = false,};

在 Vue 工程里安装 oidc-client

yarn add oidc-client

在 Vue 里配置 IdentityServer 服务器信息

在项目里添加一个 src/security/security.js文件:

import Oidc from "oidc-client"function getIdPUrl() {return "https://id6.azurewebsites.net";}Oidc.Log.logger = console;Oidc.Log.level = Oidc.Log.DEBUG;const mgr = new Oidc.UserManager({authority: getIdPUrl(),client_id: "vue-client",redirect_uri: window.location.origin + "/callback",response_type: "id_token token",scope: "openid profile email",post_logout_redirect_uri: window.location.origin + "/logout",userStore: new Oidc.WebStorageStateStore({store: window.localStorage}),automaticSilentRenew: true,silent_redirect_uri: window.location.origin + "/silent-renew.html",accessTokenExpiringNotificationTime: 10,})export default mgr

在 main.js 里注入登录相关的数据和方法数据

不借助任何状态管理包,直接将相关的数据添加到 Vue 的 app 对象上:

import mgr from "@/security/security";const globalData = {isAuthenticated: false,user: "",mgr: mgr}

方法

const globalMethods = {async authenticate(returnPath) {console.log("authenticate")const user = await this.$root.getUser();if (user) {this.isAuthenticated = true;this.user = user} else {await this.$root.signIn(returnPath)}},async getUser() {try {return await this.mgr.getUser();} catch (err) {console.error(err);}},signIn(returnPath) {returnPath ? this.mgr.signinRedirect({state: returnPath}) : this.mgr.signinRedirect();}}

修改 Vue 的实例化代码

new Vue({router,data: globalData,methods: globalMethods,render: h => h(App),}).$mount("#app")

修改 router

在 src/router/index.js中,给需要登录的路由添加 meta 字段:

Vue.use(VueRouter)const router = new VueRouter({{path: "/private",name: "private page",component: resolve => require(["@/pages/private.vue"], resolve),meta: {requiresAuth: true}}});export default router

接着,正如在配置中体现出来的,需要一个回调页面来接收登录后的授权信息,这可以通过添加一个 src/views/CallbackPage.vue文件来实现:

<script>export default {async created() {try {const result = await this.$root.mgr.signinRedirectCallback();const returnUrl = result.state ?? "/";await this.$router.push({path: returnUrl})}catch(e){await this.$router.push({name: "Unauthorized"})}}}</script>

然后,需要在路由里配置好这个回调页面:

import CallbackPage from "@/views/CallbackPage.vue";Vue.use(VueRouter)const router = new VueRouter({routes: {path: "/private",name: "private page",component: resolve => require(["@/pages/private.vue"], resolve),meta: {requiresAuth: true}},{path: "/callback",name: "callback",component: CallbackPage}});export default router

同时,在这个 router 里添加一个所谓的“全局前置守卫”(https://router.vuejs.org/zh/guide/advanced/navigation-guards.html#%E5%85%A8%E5%B1%80%E5%89%8D%E7%BD%AE%E5%AE%88%E5%8D%AB),注意就是这里,我碰到了问题,并且在 StackOverflow 上提了这个问题。在需要调用前面定义的认证方法时,不能使用 router.app.authenticate,而要使用 router.apps[1].authenticate,这是我通过 inspect router发现的:

...router.beforeEach(async function (to, from, next) {let app = router.app.$data || {isAuthenticated: false}if(app.isAuthenticated) {next()} else if (to.matched.some(record => record.meta.requiresAuth)) {router.apps[1].authenticate(to.path).then(()=>{next()})}else {next()}})export default router

到了这一步,应用就可以跑起来了,在访问 /private 时,浏览器会跳转到 IdentityServer 服务器的登录页面,在登录完成后再跳转回来。

添加 silent-renew.html

注意 security.js,我们启用了 automaticSilentRenew,并且配置了 silent_redirect_uri的路径为 silent-renew.html。它是一个独立的引用了 oidc-client js 的 html 文件,不依赖 Vue,这样方便移植到任何前端项目。

oidc-client.min.js

首先,将我们安装好的 oidc-client 包下的 node_modules/oidc-client/dist/oidc-client.min.js文件,复制粘贴到 public/static目录下。

然后,在这个目录下添加 public/static/silent-renew.html文件。

Silent Renew Token<script src="oidc-client.min.js"></script><script>console.log("renewing tokens");new Oidc.UserManager({userStore: new Oidc.WebStorageStateStore({ store: window.localStorage })}).signinSilentCallback();</script>

给 API 请求添加认证头

最后,给 API 请求添加上认证头。前提是,后端接口也使用同样的 IdentityServer 来保护(如果是 SpringBoot 项目,可以参考《[使用 IdentityServer 保护 Web 应用(AntD Pro 前端 + SpringBoot 后端) - Jeff Tian的文章 - 知乎](https://zhuanlan.zhihu.com/p/533197284) 》);否则,如果 API 是公开的,就不需要这一步了。

对于使用 axios 的 API 客户端,可以利用其 request interceptors,来统一添加这个认证头,比如:

import router from "../router"import Vue from "vue";const v = new Vue({router})const service = axios.create({// 公共接口--这里注意后面会讲baseURL: process.env.BASE_API,// 超时时间 单位是ms,这里设置了3s的超时时间timeout: 20 * 1000});service.interceptors.request.use(config => {const user = v.$root.user;if(user) {const authToken = user.access_token;if(authToken){config.headers.Authorization = `Bearer ${authToken}`;}}return config;}, Promise.reject)export default service

关键词:

下一篇:
上一篇:

消息!使用 IdentityServer 保护 Vue 前端

环球短讯!泰晶科技: 泰晶科技股份有限公司关于2020年限制性股票激励计划首次授予限制性股票第二个解除限售期解除限售条件成就暨股份上市的公告

天天视讯!快易花逾期45年不还会不会上征信

天天要闻:12月15日隆基绿能融资净买入1.10亿元,两市排名第8

【世界速看料】漳州龙文区第一期招商引资实务培训班开班!

世界动态:网贷逾期1年无力偿还产生什么后果

快看:货银对付改革将实施 投资者吃下“定心丸”

全球通讯![快讯]国安达:国安达股份有限公司关于部分董事、监事、高级管理人员股份减持计划时间届满

全球热头条丨百洋医药董秘回复:投资这公司是专业的第三方商业平台能为上游提供全方位的服务,线上是公司的战略渠道

天天微头条丨【机构调研记录】蜂巢基金调研美联新材、七彩化学

世界速讯:警惕新型毒品 濮阳警方拘留两名吸食“上头电子烟”人员

环球新消息丨达实智能董秘回复:公司出资设立的达实旗云是国内领先的健康医疗大数据服务企业,以“健康城市,人人可享”为使命

新消息丨黎姿为父亲庆生罕有分享合照头发眉毛变白曾患脑膜炎失聪听视力皆差

天天视讯!香港11月底外汇基金境外总资产34926亿港元 环比增加308亿港元

每日观察!百度地图行业首发城市“复苏”排行榜

最新资讯:12月13日基金净值:信澳先进智造股票型最新净值1.9003,跌1.93%

世界头条:松炀资源(603863)12月13日主力资金净卖出1337.82万元

微资讯!【新股IPO】美皓集团(01947)下限定价0.84港元 超购40.31倍

全球资讯:非法利用信息网络罪构成条件是什么,怎么处罚的

每日速读!苦姑娘种植方法 苦姑娘怎么种植

每日动态!ST云城: 西安东智房地产有限公司2022年1-6月、2021年度、2020年度审计报告

【时快讯】万通发展(600246.SH):拟设一家通信业务全资子公司、专项保障频率合作项目的顺利推进

微动态丨新野县县纪委监委:以清廉公平引领企业走正道

天天热推荐:东方智造董秘回复:有关公司官网的咨询与搭建工作正在进行中

中国(广西)自由贸易试验区崇左片区连续三年位列广西口岸第一位

国家发展改革委:出现积极变化 直面挑战笃行

玛西普医学科技发展(深圳)有限公司战略总监韩通平接受人民网专访

瞭望·治国理政纪事丨战略空军御风而翔

“与北京冬奥同行”

2021商务印书馆“十大好书评选”揭晓

进博会效应持续释放 “双循环”加速惠及全球

美术作品中的党史 | 第74集《和平使命》

进博奇遇记:走进“舌尖上的进博会” 食品及农产品展区观众络绎不绝

深入推进“昆仑2021”行动 公安机关依法严厉打击利用互联网侵权假冒犯罪

冰雪之约 中国之邀|一路美景!带你解锁“冬奥大道”

数读进博会 | 贸易投资对接会收获满满!超千家中外企业达成200余项合作意向