diff options
Diffstat (limited to 'doc/html/appdev/refs/api/krb5_c_encrypt.html')
| -rw-r--r-- | doc/html/appdev/refs/api/krb5_c_encrypt.html | 28 |
1 files changed, 13 insertions, 15 deletions
diff --git a/doc/html/appdev/refs/api/krb5_c_encrypt.html b/doc/html/appdev/refs/api/krb5_c_encrypt.html index 35f90cacc1be..22bde162e003 100644 --- a/doc/html/appdev/refs/api/krb5_c_encrypt.html +++ b/doc/html/appdev/refs/api/krb5_c_encrypt.html @@ -1,33 +1,31 @@ + <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - - <title>krb5_c_encrypt - Encrypt data using a key (operates on keyblock). — MIT Kerberos Documentation</title> - + <title>krb5_c_encrypt - Encrypt data using a key (operates on keyblock). — MIT Kerberos Documentation</title> <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" /> <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" /> - <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../../', - VERSION: '1.16', + VERSION: '1.21.1', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </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> <link rel="author" title="About these documents" href="../../../about.html" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> <link rel="copyright" title="Copyright" href="../../../copyright.html" /> - <link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" /> - <link rel="up" title="krb5 API" href="index.html" /> <link rel="next" title="krb5_c_encrypt_iov - Encrypt data in place supporting AEAD (operates on keyblock)." href="krb5_c_encrypt_iov.html" /> <link rel="prev" title="krb5_c_derive_prfplus - Derive a key using some input data (via RFC 6113 PRF+)." href="krb5_c_derive_prfplus.html" /> </head> @@ -61,13 +59,13 @@ <div class="documentwrapper"> <div class="bodywrapper"> - <div class="body"> + <div class="body" role="main"> <div class="section" id="krb5-c-encrypt-encrypt-data-using-a-key-operates-on-keyblock"> <h1>krb5_c_encrypt - Encrypt data using a key (operates on keyblock).<a class="headerlink" href="#krb5-c-encrypt-encrypt-data-using-a-key-operates-on-keyblock" title="Permalink to this headline">¶</a></h1> <dl class="function"> <dt id="c.krb5_c_encrypt"> -<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <tt class="descname">krb5_c_encrypt</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em> context</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> key</em>, <a class="reference internal" href="../types/krb5_keyusage.html#c.krb5_keyusage" title="krb5_keyusage">krb5_keyusage</a><em> usage</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> cipher_state</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> input</em>, <a class="reference internal" href="../types/krb5_enc_data.html#c.krb5_enc_data" title="krb5_enc_data">krb5_enc_data</a> *<em> output</em><big>)</big><a class="headerlink" href="#c.krb5_c_encrypt" title="Permalink to this definition">¶</a></dt> +<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <code class="descname">krb5_c_encrypt</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em> context</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> key</em>, <a class="reference internal" href="../types/krb5_keyusage.html#c.krb5_keyusage" title="krb5_keyusage">krb5_keyusage</a><em> usage</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> cipher_state</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> input</em>, <a class="reference internal" href="../types/krb5_enc_data.html#c.krb5_enc_data" title="krb5_enc_data">krb5_enc_data</a> *<em> output</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_encrypt" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <table class="docutils field-list" frame="void" rules="none"> @@ -76,7 +74,7 @@ <tbody valign="top"> <tr class="field-odd field"><th class="field-name">param:</th><td class="field-body"><p class="first"><strong>[in]</strong> <strong>context</strong> - Library context</p> <p><strong>[in]</strong> <strong>key</strong> - Encryption key</p> -<p><strong>[in]</strong> <strong>usage</strong> - Key usage (see <tt class="xref py py-data docutils literal"><span class="pre">KRB5_KEYUSAGE</span></tt> types)</p> +<p><strong>[in]</strong> <strong>usage</strong> - Key usage (see <code class="xref py py-data docutils literal"><span class="pre">KRB5_KEYUSAGE</span></code> types)</p> <p><strong>[inout]</strong> <strong>cipher_state</strong> - Cipher state; specify NULL if not needed</p> <p><strong>[in]</strong> <strong>input</strong> - Data to be encrypted</p> <p class="last"><strong>[out]</strong> <strong>output</strong> - Encrypted data</p> @@ -98,7 +96,7 @@ <p>This function encrypts the data block <em>input</em> and stores the output into <em>output</em> . The actual encryption key will be derived from <em>key</em> and <em>usage</em> if key derivation is specified for the encryption type. If non-null, <em>cipher_state</em> specifies the beginning state for the encryption operation, and is updated with the state to be passed as input to the next operation.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> -<p class="last">The caller must initialize <em>output</em> and allocate at least enough space for the result (using <a class="reference internal" href="krb5_c_encrypt_length.html#c.krb5_c_encrypt_length" title="krb5_c_encrypt_length"><tt class="xref c c-func docutils literal"><span class="pre">krb5_c_encrypt_length()</span></tt></a> to determine the amount of space needed). <em>output->length</em> will be set to the actual length of the ciphertext.</p> +<p class="last">The caller must initialize <em>output</em> and allocate at least enough space for the result (using <a class="reference internal" href="krb5_c_encrypt_length.html#c.krb5_c_encrypt_length" title="krb5_c_encrypt_length"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_encrypt_length()</span></code></a> to determine the amount of space needed). <em>output->length</em> will be set to the actual length of the ciphertext.</p> </div> </div> @@ -158,8 +156,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.16</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT. + <div class="right" ><i>Release: 1.21.1</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. </div> <div class="left"> |