mirror of
https://github.com/orbien-org/orbien.git
synced 2026-09-23 16:01:33 +00:00
17 lines
18 KiB
HTML
17 lines
18 KiB
HTML
<!doctype html><html lang=zh-Hans dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-features/authentication" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.10.2"><title data-rh=true>身份认证 | Orbien</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:image content=https://orbien-org.github.io/orbien/img/logo.png /><meta data-rh=true name=twitter:image content=https://orbien-org.github.io/orbien/img/logo.png /><meta data-rh=true property=og:url content=https://orbien-org.github.io/orbien/docs/features/authentication /><meta data-rh=true property=og:locale content=zh_Hans /><meta data-rh=true name=docusaurus_locale content=zh-Hans /><meta data-rh=true name=docsearch:language content=zh-Hans /><meta data-rh=true name=docusaurus_version content=current /><meta data-rh=true name=docusaurus_tag content=docs-default-current /><meta data-rh=true name=docsearch:version content=current /><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current /><meta data-rh=true property=og:title content="身份认证 | Orbien"/><meta data-rh=true name=description content="客户端连接服务端时的 Token 鉴权。服务端未配置 token（或为空）时不校验。"/><meta data-rh=true property=og:description content="客户端连接服务端时的 Token 鉴权。服务端未配置 token（或为空）时不校验。"/><link data-rh=true rel=icon href=/orbien/img/favicon.ico /><link data-rh=true rel=canonical href=https://orbien-org.github.io/orbien/docs/features/authentication /><link data-rh=true rel=alternate href=https://orbien-org.github.io/orbien/docs/features/authentication hreflang=zh-Hans /><link data-rh=true rel=alternate href=https://orbien-org.github.io/orbien/docs/features/authentication hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://orbien-org.github.io/orbien/docs/features/authentication","name":"身份认证","position":1}]}</script><link rel=stylesheet href=/orbien/assets/css/styles.1c6ecd7d.css /><script src=/orbien/assets/js/runtime~main.2658eb0e.js defer></script><script src=/orbien/assets/js/main.c70b2bce.js defer></script></head><body><svg style="display: none;"><defs>
|
||
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme-806")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/orbien/img/logo.png /><div role=region aria-label=跳到主要内容><a class=skipToContent_Sb3a href=#__docusaurus_skipToContent_fallback>跳到主要内容</a></div><nav aria-label=主导航 class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label=切换导航栏 aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/orbien/><div class=navbar__logo><img src=/orbien/img/logo.png alt=Orbien class="themedComponent_dt6d themedComponent--light_XcPj"/><img src=/orbien/img/logo.png alt=Orbien class="themedComponent_dt6d themedComponent--dark_QMpS"/></div><b class="navbar__title text--truncate">Orbien</b></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href=https://github.com/orbien-org/orbien target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_zdlW><use href=#theme-svg-external-link /></svg></a><div class="toggle_WfRr colorModeToggle_oVbE"><button class="clean-btn toggleButton_qxDU toggleButtonDisabled_MZUj" type=button disabled title="system mode" aria-label="切换浅色/暗黑模式（当前为system mode）"><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_SFy4 lightToggleIcon_r_0k"><path fill=currentColor d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_SFy4 darkToggleIcon_pwnq"><path fill=currentColor d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_SFy4 systemToggleIcon_gB86"><path fill=currentColor d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"/></svg></button></div><div class=navbarSearchContainer_Pcjl></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_BsZ3"><div class=docsWrapper_pyt2><button aria-label=回到顶部 class="clean-btn theme-back-to-top-button backToTopButton_FsEm" type=button></button><div class=docRoot_dSts><aside class="theme-doc-sidebar-container docSidebarContainer_i4lw"><div class=sidebarViewport_LX4L><div class=sidebar_RCgn><nav aria-label=文档侧边栏 class="menu thin-scrollbar menu_ahLp"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/intro><span class=linkLabel_TUNj>介绍</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/download><span class=linkLabel_TUNj>下载</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/quickstart><span class=linkLabel_TUNj>快速开始</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/docker><span class=linkLabel_TUNj>Docker 安装</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_aOsC menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/orbien/docs/proxies/tcp><span class=categoryLinkLabel_Tfj5>代理协议</span></a></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_aOsC menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/orbien/docs/transport/protocol/tcp><span class=categoryLinkLabel_Tfj5>传输与安全</span></a></div><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_aOsC menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role=button aria-expanded=true href=/orbien/docs/features/authentication><span class=categoryLinkLabel_Tfj5>功能</span></a></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/orbien/docs/features/authentication><span class=linkLabel_TUNj>身份认证</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/orbien/docs/features/dashboard><span class=linkLabel_TUNj>管理界面</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/orbien/docs/features/proxy-bind><span class=linkLabel_TUNj>代理绑定地址</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/orbien/docs/features/bandwidth><span class=linkLabel_TUNj>带宽限制</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/orbien/docs/features/real-ip><span class=linkLabel_TUNj>获取真实 IP</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_aOsC menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/orbien/docs/integrations/springboot><span class=categoryLinkLabel_Tfj5>集成</span></a></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/performance><span class=linkLabel_TUNj>性能测试</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/roadmap><span class=linkLabel_TUNj>路线图</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/license><span class=linkLabel_TUNj>许可证</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/orbien/docs/community><span class=linkLabel_TUNj>社区和贡献</span></a></ul></nav></div></div></aside><main class=docMainContainer_Tq_9><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_I2C9"><div class=docItemContainer_FZQ_><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_DwGs" aria-label=页面路径><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label=主页面 class=breadcrumbs__link href=/orbien/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_Ripd><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><span class=breadcrumbs__link>功能</span><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>身份认证</span></ul></nav><div class="tocCollapsible_xf3c theme-doc-toc-mobile tocMobile_OEfg"><button type=button class="clean-btn tocCollapsibleButton_pqXY">本页总览</button></div><div class="theme-doc-markdown markdown"><header><h1>身份认证</h1></header>
|
||
<p>客户端连接服务端时的 Token 鉴权。服务端未配置 <code>token</code>（或为空）时不校验。</p>
|
||
<p>两端 <code>token</code> 必须一致，否则登录失败（<code>authorization failed</code>）。</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_zfeO" id=示例>示例<a href=#示例 class=hash-link aria-label=示例的直接链接 title=示例的直接链接 translate=no></a></h2>
|
||
<p>服务端：</p>
|
||
<div class="language-toml codeBlockContainer_AFDL theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_tC79><pre tabindex=0 class="prism-code language-toml codeBlock_fCJ5 thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_HQxl><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic># orbien-server.toml</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token punctuation" style=color:#393A34>[</span><span class="token table class-name">auth</span><span class="token punctuation" style=color:#393A34>]</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token key property" style=color:#36acaa>token</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>=</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"YOUR_TOKEN"</span><br/></div></code></pre></div></div>
|
||
<p>客户端：</p>
|
||
<div class="language-toml codeBlockContainer_AFDL theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_tC79><pre tabindex=0 class="prism-code language-toml codeBlock_fCJ5 thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_HQxl><div class=token-line style=color:#393A34><span class="token comment" style=color:#999988;font-style:italic># orbien.toml</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token punctuation" style=color:#393A34>[</span><span class="token table class-name">auth</span><span class="token punctuation" style=color:#393A34>]</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"></span><span class="token key property" style=color:#36acaa>token</span><span class="token plain"> </span><span class="token punctuation" style=color:#393A34>=</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>"YOUR_TOKEN"</span><br/></div></code></pre></div></div>
|
||
<h2 class="anchor anchorTargetStickyNavbar_zfeO" id=参数>参数<a href=#参数 class=hash-link aria-label=参数的直接链接 title=参数的直接链接 translate=no></a></h2>
|
||
<table><thead><tr><th>参数<th>必填<th>默认值<th>说明<tbody><tr><td><code>auth.token</code><td>否<td><td>共享密钥；服务端为空表示关闭鉴权；两端需一致</table>
|
||
<h2 class="anchor anchorTargetStickyNavbar_zfeO" id=命令行>命令行<a href=#命令行 class=hash-link aria-label=命令行的直接链接 title=命令行的直接链接 translate=no></a></h2>
|
||
<p>服务端也可通过参数设置（会覆盖配置文件中的 <code>token</code>）：</p>
|
||
<div class="language-shell codeBlockContainer_AFDL theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_tC79><pre tabindex=0 class="prism-code language-shell codeBlock_fCJ5 thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_HQxl><div class=token-line style=color:#393A34><span class="token plain">./orbien-server </span><span class="token parameter variable" style=color:#36acaa>-c</span><span class="token plain"> orbien-server.toml </span><span class="token parameter variable" style=color:#36acaa>-t</span><span class="token plain"> YOUR_TOKEN</span><br/></div></code></pre></div></div>
|
||
<table><thead><tr><th>参数<th>默认值<th>说明<tbody><tr><td><code>-t</code> / <code>--token</code><td><td>共享密钥</table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_zwwA"><a href=https://github.com/orbien-org/orbien/tree/main/docs/docs/features/authentication.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_OVCj aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>编辑此页</a></div><div class="col lastUpdated_V1Ko"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label=文件选项卡><a class="pagination-nav__link pagination-nav__link--prev" href=/orbien/docs/transport/tls><div class=pagination-nav__sublabel>上一页</div><div class=pagination-nav__label>TLS</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/orbien/docs/features/dashboard><div class=pagination-nav__sublabel>下一页</div><div class=pagination-nav__label>管理界面</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_fdog thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#示例 class="table-of-contents__link toc-highlight">示例</a><li><a href=#参数 class="table-of-contents__link toc-highlight">参数</a><li><a href=#命令行 class="table-of-contents__link toc-highlight">命令行</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2026 Orbien. Apache-2.0.</div></div></div></footer></div></body> |