OAuth2授權(quán)服務(wù)器Id Server一鍵生成配置原理

OAuth2客戶端的配置參數(shù)非常多猜旬,雖然Id Server通過控制臺可視化解決了創(chuàng)建OAuth2客戶端的問題觉义。但是如何進(jìn)一步降低OAuth2的使用難度,把創(chuàng)建的OAuth2客戶端轉(zhuǎn)化為配置成為了剛需,從技術(shù)角度上感覺也并不是很難實現(xiàn)蹭沛。

我們先來看看效果赂韵,點擊配置生成按鈕即可直接生成Spring Security的客戶端yaml配置:

這個效果是如何實現(xiàn)的呢?

highlightjs

主要依托于highlightjs這個代碼高亮庫嫌蚤,平常我們在各大技術(shù)社區(qū)看到的五顏六色的代碼塊很多就依賴的這個JS庫辐益,連我自己的技術(shù)博客felord.cn都用了這個類庫來做代碼片段美化。它使用起來很簡單:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <link rel="stylesheet"
          >
    <script src="http://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.5.1/highlight.min.js"></script>
    <script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
<pre >
    <code class="yaml">
      spring:
        #
        application:
          name: id-server
    </code>
</pre>
</body>
</html>

引入一個風(fēng)格樣式和highlight.js庫脱吱,再加一個初始化腳本就完成了智政。然后在<pre><code>中編寫帶縮進(jìn)的代碼就可以了,注意code標(biāo)簽要加上對應(yīng)語言或者腳本的class類箱蝠,出來就是這樣的效果:

實現(xiàn)

到這里思路就很明確了续捂,把參數(shù)項的值動態(tài)化就可以了,我期望達(dá)到這樣的效果:

<pre >
    <code class="yaml">
      spring:
        #
        application:
          name: ${appName}
    </code>
</pre>

但事實上我大意了宦搬,我用了thymeleaf模板牙瓢,我沒有找到thymeleaf可以固化配置項到頁面的辦法,所以這個帶縮進(jìn)的格式得后端生成间校,然后按照thymeleaf的要求渲染矾克,于是我寫了一個非常復(fù)雜的方法:

    @GetMapping("/system/client/yaml/{id}")
    public String yaml(Model model, @PathVariable String id) {
        OAuth2Client oauth2Client = clientRepository.findClientById(id);

        String clientName = oauth2Client.getClientName();
        String clientId = oauth2Client.getClientId();

        Set<RedirectUri> redirectUris = oauth2Client.getRedirectUris();
        String uris = redirectUris.stream()
                .map(RedirectUri::getRedirectUri)
                .collect(Collectors.joining(","));
        Set<OAuth2GrantType> authorizationGrantTypes = oauth2Client.getAuthorizationGrantTypes();
        String types = authorizationGrantTypes.stream()
                .map(OAuth2GrantType::getGrantTypeName)
                .collect(Collectors.joining(","));
        String method = oauth2Client.getClientAuthenticationMethods().stream()
                .map(ClientAuthMethod::getClientAuthenticationMethod)
                .collect(Collectors.joining(","));
        String scopes = Stream.concat(
                        oauth2Client.getScopes().stream()
                                .map(OAuth2Scope::getScope), Stream.of(OidcScopes.OPENID))
                .collect(Collectors.joining(","));
        
        LinkedHashMap<String, Object> client = new LinkedHashMap<>();
        LinkedHashMap<String, Object> clientRegistration = new LinkedHashMap<>();
        clientRegistration.put("client-id", clientId);
        clientRegistration.put("client-secret", "請?zhí)顚懩愕腛Auth2客戶端密碼");
        clientRegistration.put("redirect-uri", "請從" + uris + "指定一個");
        clientRegistration.put("authorization-grant-type", "請從 " + types + " 指定一個");
        clientRegistration.put("client-authentication-method", method);
        clientRegistration.put("scope", scopes);
        client.put("registration",
                Collections.singletonMap(clientName, clientRegistration));
        client.put("provider", Collections.singletonMap(clientName,
                Collections.singletonMap("issuer-uri", "http://localhost:9000")));

        Map<String, Object> spring =
                Collections.singletonMap("spring",
                        Collections.singletonMap("security",
                                Collections.singletonMap("oauth2",
                                        Collections.singletonMap("client", client))));

        DumperOptions dumperOptions = new DumperOptions();
        dumperOptions.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
        Yaml yaml = new Yaml(dumperOptions);
        String dump = yaml.dump(spring);
        model.addAttribute("yaml", dump);
        return "/system/client/yaml";
    }

效果自然是有的,但是非常差強(qiáng)人意憔足。

無法生成注釋胁附,而且換行不受控制,尤其套了9個Map讓我抓狂四瘫。

優(yōu)化

是不是我把問題想得太復(fù)雜了呢汉嗽?于是最終我把yaml的格式模板這樣做了:

        String yml = "spring:\n" +
                "  security:\n" +
                "    oauth2:\n" +
                "      client:\n" +
                "        registration:\n" +
                "             # 這里為客戶端名稱可自行更改\n" +
                "          " + clientName + ":\n" +
                "            client-id: " + clientId + "\n" +
                "             # 密碼為注冊客戶端時的密碼\n" +
                "            client-secret: 請?zhí)顚懩洃浀腛Auth2客戶端密碼\n" +
                "             # 只能選擇一個\n" +
                "            redirect-uri: 請從" + uris + "指定一個\n" +
                "             # 只能選擇一個\n" +
                "            authorization-grant-type: " + types + "三選一\n" +
                "            client-authentication-method: " + method + "\n" +
                "            scope: " + scopes + "\n" +
                "        provider:\n" +
                "          " + clientName + ":\n" +
                "             # 要保證授權(quán)服務(wù)器地址可以被客戶端訪問\n" +
                "            issuer-uri: http://localhost:9000";


        model.addAttribute("yaml", yml);

當(dāng)然這是為了兼容Java8,如果換了Java17直接就用字符串模板了找蜜,甚至這里我還能寫注釋饼暑,最終的效果是這樣的:

效果比上一個方案好了很多,當(dāng)然或許你還有更好的方案,讓我們集思廣益弓叛。

關(guān)于Id Server

倉庫地址:https://github.com/NotFound403/id-server 歡迎star彰居。

Id Server是一個基于Spring Authorization Server的開源的授權(quán)服務(wù)器,大大降低OAuth2授權(quán)服務(wù)器的學(xué)習(xí)使用難度撰筷,提供UI控制臺陈惰,動態(tài)權(quán)限控制,方便OAuth2客戶端管理毕籽,可以一鍵生成Spring Security配置抬闯,開箱即用,少量配置修改就可部署关筒,代碼開源溶握,方便二次開發(fā),支持OAuth2四種客戶端認(rèn)證方式和三種授權(quán)模式蒸播。歡迎學(xué)習(xí)使用并參與代碼貢獻(xiàn)睡榆。

關(guān)注公眾號:碼農(nóng)小胖哥,獲取更多資訊

個人博客:https://felord.cn

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末袍榆,一起剝皮案震驚了整個濱河市胀屿,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌包雀,老刑警劉巖宿崭,帶你破解...
    沈念sama閱讀 206,839評論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異馏艾,居然都是意外死亡劳曹,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,543評論 2 382
  • 文/潘曉璐 我一進(jìn)店門琅摩,熙熙樓的掌柜王于貴愁眉苦臉地迎上來铁孵,“玉大人,你說我怎么就攤上這事房资⊥扇埃” “怎么了?”我有些...
    開封第一講書人閱讀 153,116評論 0 344
  • 文/不壞的土叔 我叫張陵轰异,是天一觀的道長岖沛。 經(jīng)常有香客問我,道長搭独,這世上最難降的妖魔是什么婴削? 我笑而不...
    開封第一講書人閱讀 55,371評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮牙肝,結(jié)果婚禮上唉俗,老公的妹妹穿的比我還像新娘嗤朴。我一直安慰自己,他們只是感情好虫溜,可當(dāng)我...
    茶點故事閱讀 64,384評論 5 374
  • 文/花漫 我一把揭開白布雹姊。 她就那樣靜靜地躺著,像睡著了一般衡楞。 火紅的嫁衣襯著肌膚如雪吱雏。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,111評論 1 285
  • 那天瘾境,我揣著相機(jī)與錄音歧杏,去河邊找鬼。 笑死寄雀,一個胖子當(dāng)著我的面吹牛得滤,可吹牛的內(nèi)容都是我干的陨献。 我是一名探鬼主播盒犹,決...
    沈念sama閱讀 38,416評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼眨业!你這毒婦竟也來了急膀?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,053評論 0 259
  • 序言:老撾萬榮一對情侶失蹤龄捡,失蹤者是張志新(化名)和其女友劉穎卓嫂,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體聘殖,經(jīng)...
    沈念sama閱讀 43,558評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡晨雳,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,007評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了奸腺。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片餐禁。...
    茶點故事閱讀 38,117評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖突照,靈堂內(nèi)的尸體忽然破棺而出帮非,到底是詐尸還是另有隱情,我是刑警寧澤讹蘑,帶...
    沈念sama閱讀 33,756評論 4 324
  • 正文 年R本政府宣布末盔,位于F島的核電站,受9級特大地震影響座慰,放射性物質(zhì)發(fā)生泄漏陨舱。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,324評論 3 307
  • 文/蒙蒙 一版仔、第九天 我趴在偏房一處隱蔽的房頂上張望游盲。 院中可真熱鬧心剥,春花似錦、人聲如沸背桐。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,315評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽链峭。三九已至畦娄,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間弊仪,已是汗流浹背熙卡。 一陣腳步聲響...
    開封第一講書人閱讀 31,539評論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留励饵,地道東北人驳癌。 一個月前我還...
    沈念sama閱讀 45,578評論 2 355
  • 正文 我出身青樓,卻偏偏與公主長得像役听,于是被迫代替她去往敵國和親颓鲜。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,877評論 2 345

推薦閱讀更多精彩內(nèi)容