mirror of
https://github.com/alibaba/arthas.git
synced 2024-04-21 10:21:39 +00:00
391 lines
18 KiB
HTML
391 lines
18 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="zh-CN" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="zh-CN" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>auth — Arthas 3.5.6 文档</title>
|
||
|
||
|
||
|
||
|
||
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
<script type="text/javascript" src="_static/translations.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/overrides.css" type="text/css" />
|
||
<link rel="index" title="索引" href="genindex.html" />
|
||
<link rel="search" title="搜索" href="search.html" />
|
||
<link rel="next" title="options" href="options.html" />
|
||
<link rel="prev" title="pwd" href="pwd.html" />
|
||
<script>
|
||
if (window.location.href.startsWith("https://alibaba.github.io/arthas/")) {
|
||
window.location.href = "https://arthas.aliyun.com/doc/" + window.location.href.substr("https://alibaba.github.io/arthas/".length);
|
||
}
|
||
</script>
|
||
|
||
<script src="_static/center_page.js"></script>
|
||
<link rel="stylesheet" href="https://g.alicdn.com/code/lib/highlight.js/9.13.1/styles/github.min.css">
|
||
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> Arthas
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
3.5.6
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference external" href="https://arthas.aliyun.com/">首页</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://arthas.aliyun.com/doc/en/">English Docs</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://arthas.aliyun.com/doc/arthas-tutorials.html?language=cn">在线教程(katacoda)</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://start.aliyun.com/handson-lab?category=arthas">在线教程(阿里云)</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="install-detail.html">安装</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="download.html">下载</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="quick-start.html">快速入门</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="advanced-use.html">进阶使用</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="commands.html">命令列表</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="dashboard.html">dashboard</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="thread.html">thread</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="jvm.html">jvm</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="memory.html">memory</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="sysprop.html">sysprop</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="sysenv.html">sysenv</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmoption.html">vmoption</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="perfcounter.html">perfcounter</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="logger.html">logger</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mbean.html">mbean</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getstatic.html">getstatic</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="ognl.html">ognl</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="sc.html">sc</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="sm.html">sm</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="dump.html">dump</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="heapdump.html">heapdump</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmtool.html">vmtool</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="jad.html">jad</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="classloader.html">classloader</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mc.html">mc</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="retransform.html">retransform</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="redefine.html">redefine</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="monitor.html">monitor</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="watch.html">watch</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="trace.html">trace</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="stack.html">stack</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tt.html">tt</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="profiler.html">profiler</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="cat.html">cat</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="echo.html">echo</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="grep.html">grep</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="base64.html">base64</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tee.html">tee</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="pwd.html">pwd</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">auth</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id1">配置用户名和密码</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#id2">本地连接不鉴权</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#telnet-console">在telnet console里鉴权</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#web-console">Web console密码验证</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#http-api">HTTP API 验证</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#authorization-header">Authorization Header方式（推荐）</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#url">URL 参数传递方式</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="options.html">options</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="commands.html#arthas">Arthas 基础命令</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="web-console.html">WebConsole</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tunnel.html">Arthas Tunnel</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="http-api.html">Http API</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker.html">Docker</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="spring-boot-starter.html">Arthas Spring Boot Starter</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="idea-plugin.html">IDEA 插件</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/issues?q=label%3Auser-case">用户案例</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ/常见问题</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas">Star me at GitHub</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md#">编译调试/参与贡献</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://github.com/alibaba/arthas/releases">Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="contact-us.html">QQ群/钉钉群</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">Arthas</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li><a href="commands.html">命令列表</a> »</li>
|
||
|
||
<li>auth</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
|
||
<a href="https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/auth.md" class="fa fa-github"> Edit on GitHub</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="auth">
|
||
<h1>auth<a class="headerlink" href="#auth" title="永久链接至标题">¶</a></h1>
|
||
<blockquote>
|
||
<div><p>验证当前会话</p>
|
||
</div></blockquote>
|
||
<div class="section" id="id1">
|
||
<h2>配置用户名和密码<a class="headerlink" href="#id1" title="永久链接至标题">¶</a></h2>
|
||
<p>在attach时，可以在命令行指定密码。比如：</p>
|
||
<div class="highlight-default notranslate"><pre class="literal-block">java -jar arthas-boot.jar --password ppp</pre>
|
||
</div>
|
||
<ul>
|
||
<li><p>可以通过 <code class="docutils literal notranslate"><span class="pre">--username</span></code> 选项来指定用户，默认值是<code class="docutils literal notranslate"><span class="pre">arthas</span></code>。</p></li>
|
||
<li><p>也可以在 <code class="docutils literal notranslate"><span class="pre">arthas.properties</span></code> 里中配置 username/password。命令行的优先级大于配置文件。</p></li>
|
||
<li><p>如果只配置<code class="docutils literal notranslate"><span class="pre">username</span></code>，没有配置<code class="docutils literal notranslate"><span class="pre">password</span></code>，则会生成随机密码，打印在<code class="docutils literal notranslate"><span class="pre">~/logs/arthas/arthas.log</span></code>中</p>
|
||
<div class="highlight-default notranslate"><pre class="literal-block">Using generated security password: 0vUBJpRIppkKuZ7dYzYqOKtranj4unGh</pre>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="id2">
|
||
<h2>本地连接不鉴权<a class="headerlink" href="#id2" title="永久链接至标题">¶</a></h2>
|
||
<p>默认情况下，在<code class="docutils literal notranslate"><span class="pre">arthas.properties</span></code>文件里有配置：</p>
|
||
<div class="highlight-default notranslate"><pre class="literal-block">arthas.localConnectionNonAuth=true</pre>
|
||
</div>
|
||
<p>当配置密码时，使用本地连接，也不需要鉴权。默认配置值是true，方便本地连接使用。只有远程连接时，才需要鉴权。</p>
|
||
</div>
|
||
<div class="section" id="telnet-console">
|
||
<h2>在telnet console里鉴权<a class="headerlink" href="#telnet-console" title="永久链接至标题">¶</a></h2>
|
||
<p>连接到arthas后，直接执行命令会提示需要鉴权：</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">[arthas@37430]$ help
|
||
Error! command not permitted, try to use 'auth' command to authenticates.</pre></div>
|
||
</div>
|
||
<p>使用<code class="docutils literal notranslate"><span class="pre">auth</span></code>命令来鉴权，成功之后可以执行其它命令。</p>
|
||
<div class="highlight-default notranslate"><pre class="literal-block">[arthas@37430]$ auth ppp
|
||
Authentication result: true</pre>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p>可以通过 <code class="docutils literal notranslate"><span class="pre">--username</span></code> 选项来指定用户，默认值是<code class="docutils literal notranslate"><span class="pre">arthas</span></code>。</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="web-console">
|
||
<h2>Web console密码验证<a class="headerlink" href="#web-console" title="永久链接至标题">¶</a></h2>
|
||
<p>打开浏览器，会有弹窗提示需要输入 用户名 和 密码。</p>
|
||
<p>成功之后，则可以直接连接上 web console。</p>
|
||
</div>
|
||
<div class="section" id="http-api">
|
||
<h2>HTTP API 验证<a class="headerlink" href="#http-api" title="永久链接至标题">¶</a></h2>
|
||
<div class="section" id="authorization-header">
|
||
<h3>Authorization Header方式（推荐）<a class="headerlink" href="#authorization-header" title="永久链接至标题">¶</a></h3>
|
||
<p>Arthas 采用的是 HTTP 标准的 Basic Authorization，客户端请求时增加对应的header即可。</p>
|
||
<ul class="simple">
|
||
<li><p>参考：<a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication">https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication</a></p></li>
|
||
</ul>
|
||
<p>例如，用户名是：<code class="docutils literal notranslate"><span class="pre">admin</span></code>，密码是 <code class="docutils literal notranslate"><span class="pre">admin</span></code>，则组合为字符串： <code class="docutils literal notranslate"><span class="pre">admin:admin</span></code>，base64结果是： <code class="docutils literal notranslate"><span class="pre">YWRtaW46YWRtaW4=</span></code>，则HTTP 请求增加<code class="docutils literal notranslate"><span class="pre">Authorization</span></code> header：</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">curl 'http://localhost:8563/api' \
|
||
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
|
||
--data-raw '{"action":"exec","command":"version"}' </pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="url">
|
||
<h3>URL 参数传递方式<a class="headerlink" href="#url" title="永久链接至标题">¶</a></h3>
|
||
<p>为了方便各种特殊情况，支持了以 parameters 方式传递username和password。比如：</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight hljs"><pre class="bash">curl 'http://localhost:8563/api?password=admin' \
|
||
--data-raw '{"action":"exec","command":"version"}' </pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="options.html" class="btn btn-neutral float-right" title="options" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="pwd.html" class="btn btn-neutral float-left" title="pwd" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2018-2020, Alibaba Middleware Group, and contributors
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
<div class="github-fork-ribbon-wrapper right">
|
||
<div class="github-fork-ribbon">
|
||
<a href="https://github.com/alibaba/arthas" target="_blank">Fork me at GitHub</a>
|
||
</div>
|
||
</div>
|
||
|
||
<script type="text/javascript" src="_static/add_badges.js"></script>
|
||
|
||
<script src="https://g.alicdn.com/code/lib/highlight.js/9.13.1/highlight.min.js"></script>
|
||
<script src="https://g.alicdn.com/code/lib/highlightjs-line-numbers.js/2.5.0/highlightjs-line-numbers.min.js"></script>
|
||
<script>
|
||
document.querySelectorAll('div.hljs > pre').forEach(function(block) {
|
||
hljs.highlightBlock(block);
|
||
hljs.lineNumbersBlock(block);
|
||
});
|
||
</script>
|
||
|
||
|
||
<script type="text/javascript">document.write(unescape("%3Cspan style='display:none;' id='cnzz_stat_icon_1279151497'%3E%3C/span%3E%3Cscript src='https://s4.cnzz.com/z_stat.php%3Fid%3D1279151497' type='text/javascript'%3E%3C/script%3E"));</script>
|
||
|
||
<script>
|
||
var _hmt = _hmt || [];
|
||
(function() {
|
||
var hm = document.createElement("script");
|
||
hm.src = "https://hm.baidu.com/hm.js?d5c5e25b100f0eb51a4c35c8a86ea9b4";
|
||
var s = document.getElementsByTagName("script")[0];
|
||
s.parentNode.insertBefore(hm, s);
|
||
})();
|
||
</script>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |