Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Segui 1
Vota 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Albero (Tree): 0f75e31513
Rami (Branch) Tag
${ item.name }
Crea branch ${ searchTerm }
da '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/secrets.html

514 lines
33KB
Originale Blame Cronologia 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="secrets — Generate secure random numbers for managing secrets" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/secrets.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/secrets.py The secrets module is used for generating cryptographically strong random numbers suitable for managing data such as passwords, account authentication, security tokens, ..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/secrets.py The secrets module is used for generating cryptographically strong random numbers suitable for managing data such as passwords, account authentication, security tokens, ..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>secrets — Generate secure random numbers for managing secrets &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="Generic Operating System Services" href="allos.html" />

  39.     <link rel="prev" title="hmac — Keyed-Hashing for Message Authentication" href="hmac.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/secrets.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code> — Generate secure random numbers for managing secrets</a><ul>

  99. <li><a class="reference internal" href="#random-numbers">Random numbers</a></li>

  100. <li><a class="reference internal" href="#generating-tokens">Generating tokens</a><ul>

  101. <li><a class="reference internal" href="#how-many-bytes-should-tokens-use">How many bytes should tokens use?</a></li>

  102. </ul>

  103. </li>

  104. <li><a class="reference internal" href="#other-functions">Other functions</a></li>

  105. <li><a class="reference internal" href="#recipes-and-best-practices">Recipes and best practices</a></li>

  106. </ul>

  107. </li>

  108. </ul>

  109. 

  110.   </div>

  111.   <div>

  112.     <h4>Previous topic</h4>

  113.     <p class="topless"><a href="hmac.html"

  114.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">hmac</span></code> — Keyed-Hashing for Message Authentication</a></p>

  115.   </div>

  116.   <div>

  117.     <h4>Next topic</h4>

  118.     <p class="topless"><a href="allos.html"

  119.                           title="next chapter">Generic Operating System Services</a></p>

  120.   </div>

  121.   <div role="note" aria-label="source link">

  122.     <h3>This Page</h3>

  123.     <ul class="this-page-menu">

  124.       <li><a href="../bugs.html">Report a Bug</a></li>

  125.       <li>

  126.         <a href="https://github.com/python/cpython/blob/main/Doc/library/secrets.rst"

  127.             rel="nofollow">Show Source

  128.         </a>

  129.       </li>

  130.     </ul>

  131.   </div>

  132.         </nav>

  133.     </div>

  134. </div>

  135. 

  136.   

  137.     <div class="related" role="navigation" aria-label="related navigation">

  138.       <h3>Navigation</h3>

  139.       <ul>

  140.         <li class="right" style="margin-right: 10px">

  141.           <a href="../genindex.html" title="General Index"

  142.              accesskey="I">index</a></li>

  143.         <li class="right" >

  144.           <a href="../py-modindex.html" title="Python Module Index"

  145.              >modules</a> |</li>

  146.         <li class="right" >

  147.           <a href="allos.html" title="Generic Operating System Services"

  148.              accesskey="N">next</a> |</li>

  149.         <li class="right" >

  150.           <a href="hmac.html" title="hmac — Keyed-Hashing for Message Authentication"

  151.              accesskey="P">previous</a> |</li>

  152. 

  153.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  154.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  155.           <li class="switchers">

  156.             <div class="language_switcher_placeholder"></div>

  157.             <div class="version_switcher_placeholder"></div>

  158.           </li>

  159.           <li>

  160.               

  161.           </li>

  162.     <li id="cpython-language-and-version">

  163.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  164.     </li>

  165. 

  166.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  167.           <li class="nav-item nav-item-2"><a href="crypto.html" accesskey="U">Cryptographic Services</a> &#187;</li>

  168.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code> — Generate secure random numbers for managing secrets</a></li>

  169.                 <li class="right">

  170.                     

  171. 

  172.     <div class="inline-search" role="search">

  173.         <form class="inline-search" action="../search.html" method="get">

  174.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  175.           <input type="submit" value="Go" />

  176.         </form>

  177.     </div>

  178.                      |

  179.                 </li>

  180.             <li class="right">

  181. <label class="theme-selector-label">

  182.     Theme

  183.     <select class="theme-selector" oninput="activateTheme(this.value)">

  184.         <option value="auto" selected>Auto</option>

  185.         <option value="light">Light</option>

  186.         <option value="dark">Dark</option>

  187.     </select>

  188. </label> |</li>

  189.             

  190.       </ul>

  191.     </div>    

  192. 

  193.     <div class="document">

  194.       <div class="documentwrapper">

  195.         <div class="bodywrapper">

  196.           <div class="body" role="main">

  197.             

  198.   <section id="module-secrets">

  199. <span id="secrets-generate-secure-random-numbers-for-managing-secrets"></span><h1><a class="reference internal" href="#module-secrets" title="secrets: Generate secure random numbers for managing secrets."><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code></a> — Generate secure random numbers for managing secrets<a class="headerlink" href="#module-secrets" title="Link to this heading">¶</a></h1>

  200. <div class="versionadded">

  201. <p><span class="versionmodified added">New in version 3.6.</span></p>

  202. </div>

  203. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/secrets.py">Lib/secrets.py</a></p>

  204. <hr class="docutils" />

  205. <p>The <a class="reference internal" href="#module-secrets" title="secrets: Generate secure random numbers for managing secrets."><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code></a> module is used for generating cryptographically strong

  206. random numbers suitable for managing data such as passwords, account

  207. authentication, security tokens, and related secrets.</p>

  208. <p>In particular, <a class="reference internal" href="#module-secrets" title="secrets: Generate secure random numbers for managing secrets."><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code></a> should be used in preference to the

  209. default pseudo-random number generator in the <a class="reference internal" href="random.html#module-random" title="random: Generate pseudo-random numbers with various common distributions."><code class="xref py py-mod docutils literal notranslate"><span class="pre">random</span></code></a> module, which

  210. is designed for modelling and simulation, not security or cryptography.</p>

  211. <div class="admonition seealso">

  212. <p class="admonition-title">See also</p>

  213. <p><span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0506/"><strong>PEP 506</strong></a></p>

  214. </div>

  215. <section id="random-numbers">

  216. <h2>Random numbers<a class="headerlink" href="#random-numbers" title="Link to this heading">¶</a></h2>

  217. <p>The <a class="reference internal" href="#module-secrets" title="secrets: Generate secure random numbers for managing secrets."><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code></a> module provides access to the most secure source of

  218. randomness that your operating system provides.</p>

  219. <dl class="py class">

  220. <dt class="sig sig-object py" id="secrets.SystemRandom">

  221. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">secrets.</span></span><span class="sig-name descname"><span class="pre">SystemRandom</span></span><a class="headerlink" href="#secrets.SystemRandom" title="Link to this definition">¶</a></dt>

  222. <dd><p>A class for generating random numbers using the highest-quality

  223. sources provided by the operating system.  See

  224. <a class="reference internal" href="random.html#random.SystemRandom" title="random.SystemRandom"><code class="xref py py-class docutils literal notranslate"><span class="pre">random.SystemRandom</span></code></a> for additional details.</p>

  225. </dd></dl>

  226. 

  227. <dl class="py function">

  228. <dt class="sig sig-object py" id="secrets.choice">

  229. <span class="sig-prename descclassname"><span class="pre">secrets.</span></span><span class="sig-name descname"><span class="pre">choice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sequence</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#secrets.choice" title="Link to this definition">¶</a></dt>

  230. <dd><p>Return a randomly chosen element from a non-empty sequence.</p>

  231. </dd></dl>

  232. 

  233. <dl class="py function">

  234. <dt class="sig sig-object py" id="secrets.randbelow">

  235. <span class="sig-prename descclassname"><span class="pre">secrets.</span></span><span class="sig-name descname"><span class="pre">randbelow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#secrets.randbelow" title="Link to this definition">¶</a></dt>

  236. <dd><p>Return a random int in the range [0, <em>n</em>).</p>

  237. </dd></dl>

  238. 

  239. <dl class="py function">

  240. <dt class="sig sig-object py" id="secrets.randbits">

  241. <span class="sig-prename descclassname"><span class="pre">secrets.</span></span><span class="sig-name descname"><span class="pre">randbits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">k</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#secrets.randbits" title="Link to this definition">¶</a></dt>

  242. <dd><p>Return an int with <em>k</em> random bits.</p>

  243. </dd></dl>

  244. 

  245. </section>

  246. <section id="generating-tokens">

  247. <h2>Generating tokens<a class="headerlink" href="#generating-tokens" title="Link to this heading">¶</a></h2>

  248. <p>The <a class="reference internal" href="#module-secrets" title="secrets: Generate secure random numbers for managing secrets."><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code></a> module provides functions for generating secure

  249. tokens, suitable for applications such as password resets,

  250. hard-to-guess URLs, and similar.</p>

  251. <dl class="py function">

  252. <dt class="sig sig-object py" id="secrets.token_bytes">

  253. <span class="sig-prename descclassname"><span class="pre">secrets.</span></span><span class="sig-name descname"><span class="pre">token_bytes</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">nbytes=None</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#secrets.token_bytes" title="Link to this definition">¶</a></dt>

  254. <dd><p>Return a random byte string containing <em>nbytes</em> number of bytes.

  255. If <em>nbytes</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code> or not supplied, a reasonable default is

  256. used.</p>

  257. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">token_bytes</span><span class="p">(</span><span class="mi">16</span><span class="p">)</span>  

  258. <span class="go">b&#39;\xebr\x17D*t\xae\xd4\xe3S\xb6\xe2\xebP1\x8b&#39;</span>

  259. </pre></div>

  260. </div>

  261. </dd></dl>

  262. 

  263. <dl class="py function">

  264. <dt class="sig sig-object py" id="secrets.token_hex">

  265. <span class="sig-prename descclassname"><span class="pre">secrets.</span></span><span class="sig-name descname"><span class="pre">token_hex</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">nbytes=None</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#secrets.token_hex" title="Link to this definition">¶</a></dt>

  266. <dd><p>Return a random text string, in hexadecimal.  The string has <em>nbytes</em>

  267. random bytes, each byte converted to two hex digits.  If <em>nbytes</em> is

  268. <code class="docutils literal notranslate"><span class="pre">None</span></code> or not supplied, a reasonable default is used.</p>

  269. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">token_hex</span><span class="p">(</span><span class="mi">16</span><span class="p">)</span>  

  270. <span class="go">&#39;f9bf78b9a18ce6d46a0cd2b0b86df9da&#39;</span>

  271. </pre></div>

  272. </div>

  273. </dd></dl>

  274. 

  275. <dl class="py function">

  276. <dt class="sig sig-object py" id="secrets.token_urlsafe">

  277. <span class="sig-prename descclassname"><span class="pre">secrets.</span></span><span class="sig-name descname"><span class="pre">token_urlsafe</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">nbytes=None</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#secrets.token_urlsafe" title="Link to this definition">¶</a></dt>

  278. <dd><p>Return a random URL-safe text string, containing <em>nbytes</em> random

  279. bytes.  The text is Base64 encoded, so on average each byte results

  280. in approximately 1.3 characters.  If <em>nbytes</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code> or not

  281. supplied, a reasonable default is used.</p>

  282. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">token_urlsafe</span><span class="p">(</span><span class="mi">16</span><span class="p">)</span>  

  283. <span class="go">&#39;Drmhze6EPcv0fN_81Bj-nA&#39;</span>

  284. </pre></div>

  285. </div>

  286. </dd></dl>

  287. 

  288. <section id="how-many-bytes-should-tokens-use">

  289. <h3>How many bytes should tokens use?<a class="headerlink" href="#how-many-bytes-should-tokens-use" title="Link to this heading">¶</a></h3>

  290. <p>To be secure against

  291. <a class="reference external" href="https://en.wikipedia.org/wiki/Brute-force_attack">brute-force attacks</a>,

  292. tokens need to have sufficient randomness.  Unfortunately, what is

  293. considered sufficient will necessarily increase as computers get more

  294. powerful and able to make more guesses in a shorter period.  As of 2015,

  295. it is believed that 32 bytes (256 bits) of randomness is sufficient for

  296. the typical use-case expected for the <a class="reference internal" href="#module-secrets" title="secrets: Generate secure random numbers for managing secrets."><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code></a> module.</p>

  297. <p>For those who want to manage their own token length, you can explicitly

  298. specify how much randomness is used for tokens by giving an <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>

  299. argument to the various <code class="docutils literal notranslate"><span class="pre">token_*</span></code> functions.  That argument is taken

  300. as the number of bytes of randomness to use.</p>

  301. <p>Otherwise, if no argument is provided, or if the argument is <code class="docutils literal notranslate"><span class="pre">None</span></code>,

  302. the <code class="docutils literal notranslate"><span class="pre">token_*</span></code> functions will use a reasonable default instead.</p>

  303. <div class="admonition note">

  304. <p class="admonition-title">Note</p>

  305. <p>That default is subject to change at any time, including during

  306. maintenance releases.</p>

  307. </div>

  308. </section>

  309. </section>

  310. <section id="other-functions">

  311. <h2>Other functions<a class="headerlink" href="#other-functions" title="Link to this heading">¶</a></h2>

  312. <dl class="py function">

  313. <dt class="sig sig-object py" id="secrets.compare_digest">

  314. <span class="sig-prename descclassname"><span class="pre">secrets.</span></span><span class="sig-name descname"><span class="pre">compare_digest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#secrets.compare_digest" title="Link to this definition">¶</a></dt>

  315. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if strings or

  316. <a class="reference internal" href="../glossary.html#term-bytes-like-object"><span class="xref std std-term">bytes-like objects</span></a>

  317. <em>a</em> and <em>b</em> are equal, otherwise <code class="docutils literal notranslate"><span class="pre">False</span></code>,

  318. using a “constant-time compare” to reduce the risk of

  319. <a class="reference external" href="https://codahale.com/a-lesson-in-timing-attacks/">timing attacks</a>.

  320. See <a class="reference internal" href="hmac.html#hmac.compare_digest" title="hmac.compare_digest"><code class="xref py py-func docutils literal notranslate"><span class="pre">hmac.compare_digest()</span></code></a> for additional details.</p>

  321. </dd></dl>

  322. 

  323. </section>

  324. <section id="recipes-and-best-practices">

  325. <h2>Recipes and best practices<a class="headerlink" href="#recipes-and-best-practices" title="Link to this heading">¶</a></h2>

  326. <p>This section shows recipes and best practices for using <a class="reference internal" href="#module-secrets" title="secrets: Generate secure random numbers for managing secrets."><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code></a>

  327. to manage a basic level of security.</p>

  328. <p>Generate an eight-character alphanumeric password:</p>

  329. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">string</span>

  330. <span class="kn">import</span> <span class="nn">secrets</span>

  331. <span class="n">alphabet</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_letters</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">digits</span>

  332. <span class="n">password</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">secrets</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">alphabet</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">8</span><span class="p">))</span>

  333. </pre></div>

  334. </div>

  335. <div class="admonition note">

  336. <p class="admonition-title">Note</p>

  337. <p>Applications should not

  338. <a class="reference external" href="https://cwe.mitre.org/data/definitions/257.html">store passwords in a recoverable format</a>,

  339. whether plain text or encrypted.  They should be salted and hashed

  340. using a cryptographically strong one-way (irreversible) hash function.</p>

  341. </div>

  342. <p>Generate a ten-character alphanumeric password with at least one

  343. lowercase character, at least one uppercase character, and at least

  344. three digits:</p>

  345. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">string</span>

  346. <span class="kn">import</span> <span class="nn">secrets</span>

  347. <span class="n">alphabet</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">ascii_letters</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">digits</span>

  348. <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>

  349.     <span class="n">password</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">secrets</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">alphabet</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">10</span><span class="p">))</span>

  350.     <span class="k">if</span> <span class="p">(</span><span class="nb">any</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">islower</span><span class="p">()</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">password</span><span class="p">)</span>

  351.             <span class="ow">and</span> <span class="nb">any</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">isupper</span><span class="p">()</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">password</span><span class="p">)</span>

  352.             <span class="ow">and</span> <span class="nb">sum</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">isdigit</span><span class="p">()</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">password</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">3</span><span class="p">):</span>

  353.         <span class="k">break</span>

  354. </pre></div>

  355. </div>

  356. <p>Generate an <a class="reference external" href="https://xkcd.com/936/">XKCD-style passphrase</a>:</p>

  357. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">secrets</span>

  358. <span class="c1"># On standard Linux systems, use a convenient dictionary file.</span>

  359. <span class="c1"># Other platforms may need to provide their own word-list.</span>

  360. <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">&#39;/usr/share/dict/words&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>

  361.     <span class="n">words</span> <span class="o">=</span> <span class="p">[</span><span class="n">word</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">word</span> <span class="ow">in</span> <span class="n">f</span><span class="p">]</span>

  362.     <span class="n">password</span> <span class="o">=</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">secrets</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">words</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">4</span><span class="p">))</span>

  363. </pre></div>

  364. </div>

  365. <p>Generate a hard-to-guess temporary URL containing a security token

  366. suitable for password recovery applications:</p>

  367. <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">secrets</span>

  368. <span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://example.com/reset=&#39;</span> <span class="o">+</span> <span class="n">secrets</span><span class="o">.</span><span class="n">token_urlsafe</span><span class="p">()</span>

  369. </pre></div>

  370. </div>

  371. </section>

  372. </section>

  373. 

  374. 

  375.             <div class="clearer"></div>

  376.           </div>

  377.         </div>

  378.       </div>

  379.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  380.         <div class="sphinxsidebarwrapper">

  381.   <div>

  382.     <h3><a href="../contents.html">Table of Contents</a></h3>

  383.     <ul>

  384. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code> — Generate secure random numbers for managing secrets</a><ul>

  385. <li><a class="reference internal" href="#random-numbers">Random numbers</a></li>

  386. <li><a class="reference internal" href="#generating-tokens">Generating tokens</a><ul>

  387. <li><a class="reference internal" href="#how-many-bytes-should-tokens-use">How many bytes should tokens use?</a></li>

  388. </ul>

  389. </li>

  390. <li><a class="reference internal" href="#other-functions">Other functions</a></li>

  391. <li><a class="reference internal" href="#recipes-and-best-practices">Recipes and best practices</a></li>

  392. </ul>

  393. </li>

  394. </ul>

  395. 

  396.   </div>

  397.   <div>

  398.     <h4>Previous topic</h4>

  399.     <p class="topless"><a href="hmac.html"

  400.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">hmac</span></code> — Keyed-Hashing for Message Authentication</a></p>

  401.   </div>

  402.   <div>

  403.     <h4>Next topic</h4>

  404.     <p class="topless"><a href="allos.html"

  405.                           title="next chapter">Generic Operating System Services</a></p>

  406.   </div>

  407.   <div role="note" aria-label="source link">

  408.     <h3>This Page</h3>

  409.     <ul class="this-page-menu">

  410.       <li><a href="../bugs.html">Report a Bug</a></li>

  411.       <li>

  412.         <a href="https://github.com/python/cpython/blob/main/Doc/library/secrets.rst"

  413.             rel="nofollow">Show Source

  414.         </a>

  415.       </li>

  416.     </ul>

  417.   </div>

  418.         </div>

  419. <div id="sidebarbutton" title="Collapse sidebar">

  420. <span>«</span>

  421. </div>

  422. 

  423.       </div>

  424.       <div class="clearer"></div>

  425.     </div>  

  426.     <div class="related" role="navigation" aria-label="related navigation">

  427.       <h3>Navigation</h3>

  428.       <ul>

  429.         <li class="right" style="margin-right: 10px">

  430.           <a href="../genindex.html" title="General Index"

  431.              >index</a></li>

  432.         <li class="right" >

  433.           <a href="../py-modindex.html" title="Python Module Index"

  434.              >modules</a> |</li>

  435.         <li class="right" >

  436.           <a href="allos.html" title="Generic Operating System Services"

  437.              >next</a> |</li>

  438.         <li class="right" >

  439.           <a href="hmac.html" title="hmac — Keyed-Hashing for Message Authentication"

  440.              >previous</a> |</li>

  441. 

  442.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  443.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  444.           <li class="switchers">

  445.             <div class="language_switcher_placeholder"></div>

  446.             <div class="version_switcher_placeholder"></div>

  447.           </li>

  448.           <li>

  449.               

  450.           </li>

  451.     <li id="cpython-language-and-version">

  452.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  453.     </li>

  454. 

  455.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  456.           <li class="nav-item nav-item-2"><a href="crypto.html" >Cryptographic Services</a> &#187;</li>

  457.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">secrets</span></code> — Generate secure random numbers for managing secrets</a></li>

  458.                 <li class="right">

  459.                     

  460. 

  461.     <div class="inline-search" role="search">

  462.         <form class="inline-search" action="../search.html" method="get">

  463.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  464.           <input type="submit" value="Go" />

  465.         </form>

  466.     </div>

  467.                      |

  468.                 </li>

  469.             <li class="right">

  470. <label class="theme-selector-label">

  471.     Theme

  472.     <select class="theme-selector" oninput="activateTheme(this.value)">

  473.         <option value="auto" selected>Auto</option>

  474.         <option value="light">Light</option>

  475.         <option value="dark">Dark</option>

  476.     </select>

  477. </label> |</li>

  478.             

  479.       </ul>

  480.     </div>  

  481.     <div class="footer">

  482.     &copy; 

  483.       <a href="../copyright.html">

  484.     

  485.     Copyright

  486.     

  487.       </a>

  488.      2001-2024, Python Software Foundation.

  489.     <br />

  490.     This page is licensed under the Python Software Foundation License Version 2.

  491.     <br />

  492.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  493.     <br />

  494.     

  495.       See <a href="/license.html">History and License</a> for more information.<br />

  496.     

  497.     

  498.     <br />

  499. 

  500.     The Python Software Foundation is a non-profit corporation.

  501. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  502. <br />

  503.     <br />

  504.       Last updated on Apr 09, 2024 (13:47 UTC).

  505.     

  506.       <a href="/bugs.html">Found a bug</a>?

  507.     

  508.     <br />

  509. 

  510.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  511.     </div>

  512. 

  513.   </body>

  514. </html>
上海开阖软件有限公司 沪ICP备12045867号-1