diff options
Diffstat (limited to 'doc/html/appdev/refs/api/krb5_k_encrypt.html')
| -rw-r--r-- | doc/html/appdev/refs/api/krb5_k_encrypt.html | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/doc/html/appdev/refs/api/krb5_k_encrypt.html b/doc/html/appdev/refs/api/krb5_k_encrypt.html new file mode 100644 index 000000000000..c7208d5b86ba --- /dev/null +++ b/doc/html/appdev/refs/api/krb5_k_encrypt.html @@ -0,0 +1,181 @@ +<!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_k_encrypt - Encrypt data using a key (operates on opaque key). — 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.15.1', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </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="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_k_encrypt_iov - Encrypt data in place supporting AEAD (operates on opaque key)." href="krb5_k_encrypt_iov.html" /> + <link rel="prev" title="krb5_k_decrypt_iov - Decrypt data in place supporting AEAD (operates on opaque key)." href="krb5_k_decrypt_iov.html" /> + </head> + <body> + <div class="header-wrapper"> + <div class="header"> + + + <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1> + + <div class="rel"> + + <a href="../../../index.html" title="Full Table of Contents" + accesskey="C">Contents</a> | + <a href="krb5_k_decrypt_iov.html" title="krb5_k_decrypt_iov - Decrypt data in place supporting AEAD (operates on opaque key)." + accesskey="P">previous</a> | + <a href="krb5_k_encrypt_iov.html" title="krb5_k_encrypt_iov - Encrypt data in place supporting AEAD (operates on opaque key)." + accesskey="N">next</a> | + <a href="../../../genindex.html" title="General Index" + accesskey="I">index</a> | + <a href="../../../search.html" title="Enter search criteria" + accesskey="S">Search</a> | + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_k_encrypt - Encrypt data using a key (operates on opaque key).">feedback</a> + </div> + </div> + </div> + + <div class="content-wrapper"> + <div class="content"> + <div class="document"> + + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="krb5-k-encrypt-encrypt-data-using-a-key-operates-on-opaque-key"> +<h1>krb5_k_encrypt - Encrypt data using a key (operates on opaque key).<a class="headerlink" href="#krb5-k-encrypt-encrypt-data-using-a-key-operates-on-opaque-key" title="Permalink to this headline">¶</a></h1> +<dl class="function"> +<dt id="c.krb5_k_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_k_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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</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_k_encrypt" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<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>[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> +</td> +</tr> +</tbody> +</table> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first last simple"> +<li>0 Success; otherwise - Kerberos error codes</li> +</ul> +</td> +</tr> +</tbody> +</table> +<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> +</div> +</div> + + + </div> + </div> + </div> + </div> + <div class="sidebar"> + <h2>On this page</h2> + <ul> +<li><a class="reference internal" href="#">krb5_k_encrypt - Encrypt data using a key (operates on opaque key).</a></li> +</ul> + + <br/> + <h2>Table of contents</h2> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current"> +<li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li> +<li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li> +<li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li> +</ul> + + <br/> + <h4><a href="../../../index.html">Full Table of Contents</a></h4> + <h4>Search</h4> + <form class="search" action="../../../search.html" method="get"> + <input type="text" name="q" size="18" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + </div> + <div class="clearer"></div> + </div> + </div> + + <div class="footer-wrapper"> + <div class="footer" > + <div class="right" ><i>Release: 1.15.1</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT. + </div> + <div class="left"> + + <a href="../../../index.html" title="Full Table of Contents" + >Contents</a> | + <a href="krb5_k_decrypt_iov.html" title="krb5_k_decrypt_iov - Decrypt data in place supporting AEAD (operates on opaque key)." + >previous</a> | + <a href="krb5_k_encrypt_iov.html" title="krb5_k_encrypt_iov - Encrypt data in place supporting AEAD (operates on opaque key)." + >next</a> | + <a href="../../../genindex.html" title="General Index" + >index</a> | + <a href="../../../search.html" title="Enter search criteria" + >Search</a> | + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_k_encrypt - Encrypt data using a key (operates on opaque key).">feedback</a> + </div> + </div> + </div> + + </body> +</html>
\ No newline at end of file |