<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mbed TLS v2.7.3: x509_csr.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mbed TLS v2.7.3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">x509_csr.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>X.509 certificate signing request parsing and writing.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="config_8h_source.html">config.h</a>"</code><br />
<code>#include "<a class="el" href="x509_8h_source.html">x509.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for x509_csr.h:</div>
<div class="dyncontent">
<div class="center"><img src="x509__csr_8h__incl.png" border="0" usemap="#x509__csr_8h" alt=""/></div>
<map name="x509__csr_8h" id="x509__csr_8h">
</map>
</div>
</div>
<p><a href="x509__csr_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__x509__csr.html">mbedtls_x509_csr</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7892bce1ba95bfe909929f9b9c1362e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a7892bce1ba95bfe909929f9b9c1362e8">mbedtls_x509write_csr_init</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx)</td></tr>
<tr class="memdesc:a7892bce1ba95bfe909929f9b9c1362e8"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a CSR context. <a href="#a7892bce1ba95bfe909929f9b9c1362e8">More...</a><br /></td></tr>
<tr class="separator:a7892bce1ba95bfe909929f9b9c1362e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a954eae166b125cea2115b7db8c896e90"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a954eae166b125cea2115b7db8c896e90">mbedtls_x509write_csr_set_subject_name</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx, const char *subject_name)</td></tr>
<tr class="memdesc:a954eae166b125cea2115b7db8c896e90"><td class="mdescLeft"> </td><td class="mdescRight">Set the subject name for a CSR Subject names should contain a comma-separated list of OID types and values: e.g. "C=UK,O=ARM,CN=mbed TLS Server 1". <a href="#a954eae166b125cea2115b7db8c896e90">More...</a><br /></td></tr>
<tr class="separator:a954eae166b125cea2115b7db8c896e90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4f0b724b1c7006d178e2d71c964f54c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#ac4f0b724b1c7006d178e2d71c964f54c">mbedtls_x509write_csr_set_key</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx, <a class="el" href="structmbedtls__pk__context.html">mbedtls_pk_context</a> *key)</td></tr>
<tr class="memdesc:ac4f0b724b1c7006d178e2d71c964f54c"><td class="mdescLeft"> </td><td class="mdescRight">Set the key for a CSR (public key will be included, private key used to sign the CSR when writing it) <a href="#ac4f0b724b1c7006d178e2d71c964f54c">More...</a><br /></td></tr>
<tr class="separator:ac4f0b724b1c7006d178e2d71c964f54c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2be90e1d59d29b2309670700a8c0420f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a2be90e1d59d29b2309670700a8c0420f">mbedtls_x509write_csr_set_md_alg</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx, <a class="el" href="md_8h.html#a219313cb40503ec3e34a857ab98b2296">mbedtls_md_type_t</a> md_alg)</td></tr>
<tr class="memdesc:a2be90e1d59d29b2309670700a8c0420f"><td class="mdescLeft"> </td><td class="mdescRight">Set the MD algorithm to use for the signature (e.g. MBEDTLS_MD_SHA1) <a href="#a2be90e1d59d29b2309670700a8c0420f">More...</a><br /></td></tr>
<tr class="separator:a2be90e1d59d29b2309670700a8c0420f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5ed085a0dee293f6c152ecd597473be"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#ac5ed085a0dee293f6c152ecd597473be">mbedtls_x509write_csr_set_key_usage</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx, unsigned char key_usage)</td></tr>
<tr class="memdesc:ac5ed085a0dee293f6c152ecd597473be"><td class="mdescLeft"> </td><td class="mdescRight">Set the Key Usage Extension flags (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN) <a href="#ac5ed085a0dee293f6c152ecd597473be">More...</a><br /></td></tr>
<tr class="separator:ac5ed085a0dee293f6c152ecd597473be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22571c0a8439dcacaa9762eca4d73a6e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a22571c0a8439dcacaa9762eca4d73a6e">mbedtls_x509write_csr_set_ns_cert_type</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx, unsigned char ns_cert_type)</td></tr>
<tr class="memdesc:a22571c0a8439dcacaa9762eca4d73a6e"><td class="mdescLeft"> </td><td class="mdescRight">Set the Netscape Cert Type flags (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL) <a href="#a22571c0a8439dcacaa9762eca4d73a6e">More...</a><br /></td></tr>
<tr class="separator:a22571c0a8439dcacaa9762eca4d73a6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04e3c44ffeca58318250b7b1e6c416d1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a04e3c44ffeca58318250b7b1e6c416d1">mbedtls_x509write_csr_set_extension</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx, const char *oid, size_t oid_len, const unsigned char *val, size_t val_len)</td></tr>
<tr class="memdesc:a04e3c44ffeca58318250b7b1e6c416d1"><td class="mdescLeft"> </td><td class="mdescRight">Generic function to add to or replace an extension in the CSR. <a href="#a04e3c44ffeca58318250b7b1e6c416d1">More...</a><br /></td></tr>
<tr class="separator:a04e3c44ffeca58318250b7b1e6c416d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a223d765f33318e804739f9cf81eddef6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a223d765f33318e804739f9cf81eddef6">mbedtls_x509write_csr_free</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx)</td></tr>
<tr class="memdesc:a223d765f33318e804739f9cf81eddef6"><td class="mdescLeft"> </td><td class="mdescRight">Free the contents of a CSR context. <a href="#a223d765f33318e804739f9cf81eddef6">More...</a><br /></td></tr>
<tr class="separator:a223d765f33318e804739f9cf81eddef6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade066bfe50987c491ff51ce4f347fcb4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#ade066bfe50987c491ff51ce4f347fcb4">mbedtls_x509write_csr_der</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx, unsigned char *buf, size_t size, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)</td></tr>
<tr class="memdesc:ade066bfe50987c491ff51ce4f347fcb4"><td class="mdescLeft"> </td><td class="mdescRight">Write a CSR (Certificate Signing Request) to a DER structure Note: data is written at the end of the buffer! Use the return value to determine where you should start using the buffer. <a href="#ade066bfe50987c491ff51ce4f347fcb4">More...</a><br /></td></tr>
<tr class="separator:ade066bfe50987c491ff51ce4f347fcb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5851f2aeb7d9a4676c16d2a837cad0cc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a5851f2aeb7d9a4676c16d2a837cad0cc">mbedtls_x509write_csr_pem</a> (<a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> *ctx, unsigned char *buf, size_t size, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)</td></tr>
<tr class="memdesc:a5851f2aeb7d9a4676c16d2a837cad0cc"><td class="mdescLeft"> </td><td class="mdescRight">Write a CSR (Certificate Signing Request) to a PEM string. <a href="#a5851f2aeb7d9a4676c16d2a837cad0cc">More...</a><br /></td></tr>
<tr class="separator:a5851f2aeb7d9a4676c16d2a837cad0cc"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Structures and functions for X.509 Certificate Signing Requests (CSR)</h2></td></tr>
<tr class="memitem:gae481b23df67001bdac96ef9c2ab3ef7c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmbedtls__x509__csr.html">mbedtls_x509_csr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#gae481b23df67001bdac96ef9c2ab3ef7c">mbedtls_x509_csr</a></td></tr>
<tr class="separator:gae481b23df67001bdac96ef9c2ab3ef7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b0b4f8c5cfd541ee20c53907edb636d"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#ga7b0b4f8c5cfd541ee20c53907edb636d">mbedtls_x509write_csr</a></td></tr>
<tr class="separator:ga7b0b4f8c5cfd541ee20c53907edb636d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c58fa3804ea9feb1acf745221f17208"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#ga4c58fa3804ea9feb1acf745221f17208">mbedtls_x509_csr_parse_der</a> (<a class="el" href="structmbedtls__x509__csr.html">mbedtls_x509_csr</a> *csr, const unsigned char *buf, size_t buflen)</td></tr>
<tr class="memdesc:ga4c58fa3804ea9feb1acf745221f17208"><td class="mdescLeft"> </td><td class="mdescRight">Load a Certificate Signing Request (CSR) in DER format. <a href="group__x509__module.html#ga4c58fa3804ea9feb1acf745221f17208">More...</a><br /></td></tr>
<tr class="separator:ga4c58fa3804ea9feb1acf745221f17208"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga53012fb8859f4835ccfb0a5e359b3176"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#ga53012fb8859f4835ccfb0a5e359b3176">mbedtls_x509_csr_parse</a> (<a class="el" href="structmbedtls__x509__csr.html">mbedtls_x509_csr</a> *csr, const unsigned char *buf, size_t buflen)</td></tr>
<tr class="memdesc:ga53012fb8859f4835ccfb0a5e359b3176"><td class="mdescLeft"> </td><td class="mdescRight">Load a Certificate Signing Request (CSR), DER or PEM format. <a href="group__x509__module.html#ga53012fb8859f4835ccfb0a5e359b3176">More...</a><br /></td></tr>
<tr class="separator:ga53012fb8859f4835ccfb0a5e359b3176"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf49db7323eee45d9649600de18d715f8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#gaf49db7323eee45d9649600de18d715f8">mbedtls_x509_csr_parse_file</a> (<a class="el" href="structmbedtls__x509__csr.html">mbedtls_x509_csr</a> *csr, const char *path)</td></tr>
<tr class="memdesc:gaf49db7323eee45d9649600de18d715f8"><td class="mdescLeft"> </td><td class="mdescRight">Load a Certificate Signing Request (CSR) <a href="group__x509__module.html#gaf49db7323eee45d9649600de18d715f8">More...</a><br /></td></tr>
<tr class="separator:gaf49db7323eee45d9649600de18d715f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeec330c8cb351adc2870f4f088f36fdc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#gaeec330c8cb351adc2870f4f088f36fdc">mbedtls_x509_csr_info</a> (char *buf, size_t size, const char *prefix, const <a class="el" href="structmbedtls__x509__csr.html">mbedtls_x509_csr</a> *csr)</td></tr>
<tr class="memdesc:gaeec330c8cb351adc2870f4f088f36fdc"><td class="mdescLeft"> </td><td class="mdescRight">Returns an informational string about the CSR. <a href="group__x509__module.html#gaeec330c8cb351adc2870f4f088f36fdc">More...</a><br /></td></tr>
<tr class="separator:gaeec330c8cb351adc2870f4f088f36fdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga984db025f6953ea61be7dfca2d928f37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#ga984db025f6953ea61be7dfca2d928f37">mbedtls_x509_csr_init</a> (<a class="el" href="structmbedtls__x509__csr.html">mbedtls_x509_csr</a> *csr)</td></tr>
<tr class="memdesc:ga984db025f6953ea61be7dfca2d928f37"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a CSR. <a href="group__x509__module.html#ga984db025f6953ea61be7dfca2d928f37">More...</a><br /></td></tr>
<tr class="separator:ga984db025f6953ea61be7dfca2d928f37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac2139becff64aa7294ecad4f40767a84"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#gac2139becff64aa7294ecad4f40767a84">mbedtls_x509_csr_free</a> (<a class="el" href="structmbedtls__x509__csr.html">mbedtls_x509_csr</a> *csr)</td></tr>
<tr class="memdesc:gac2139becff64aa7294ecad4f40767a84"><td class="mdescLeft"> </td><td class="mdescRight">Unallocate all CSR data. <a href="group__x509__module.html#gac2139becff64aa7294ecad4f40767a84">More...</a><br /></td></tr>
<tr class="separator:gac2139becff64aa7294ecad4f40767a84"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>X.509 certificate signing request parsing and writing. </p>
<p class="definition">Definition in file <a class="el" href="x509__csr_8h_source.html">x509_csr.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ade066bfe50987c491ff51ce4f347fcb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade066bfe50987c491ff51ce4f347fcb4">◆ </a></span>mbedtls_x509write_csr_der()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_x509write_csr_der </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *, unsigned char *, size_t) </td>
<td class="paramname"><em>f_rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_rng</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a CSR (Certificate Signing Request) to a DER structure Note: data is written at the end of the buffer! Use the return value to determine where you should start using the buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR to write away </td></tr>
<tr><td class="paramname">buf</td><td>buffer to write to </td></tr>
<tr><td class="paramname">size</td><td>size of the buffer </td></tr>
<tr><td class="paramname">f_rng</td><td>RNG function (for signature, see note) </td></tr>
<tr><td class="paramname">p_rng</td><td>RNG parameter</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>length of data written if successful, or a specific error code</dd></dl>
<dl class="section note"><dt>Note</dt><dd>f_rng may be NULL if RSA is used for signature and the signature is made offline (otherwise f_rng is desirable for countermeasures against timing attacks). ECDSA signatures always require a non-NULL f_rng. </dd></dl>
</div>
</div>
<a id="a223d765f33318e804739f9cf81eddef6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a223d765f33318e804739f9cf81eddef6">◆ </a></span>mbedtls_x509write_csr_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_x509write_csr_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the contents of a CSR context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR context to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7892bce1ba95bfe909929f9b9c1362e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7892bce1ba95bfe909929f9b9c1362e8">◆ </a></span>mbedtls_x509write_csr_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_x509write_csr_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a CSR context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR context to initialize </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5851f2aeb7d9a4676c16d2a837cad0cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5851f2aeb7d9a4676c16d2a837cad0cc">◆ </a></span>mbedtls_x509write_csr_pem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_x509write_csr_pem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *, unsigned char *, size_t) </td>
<td class="paramname"><em>f_rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>p_rng</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a CSR (Certificate Signing Request) to a PEM string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR to write away </td></tr>
<tr><td class="paramname">buf</td><td>buffer to write to </td></tr>
<tr><td class="paramname">size</td><td>size of the buffer </td></tr>
<tr><td class="paramname">f_rng</td><td>RNG function (for signature, see note) </td></tr>
<tr><td class="paramname">p_rng</td><td>RNG parameter</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or a specific error code</dd></dl>
<dl class="section note"><dt>Note</dt><dd>f_rng may be NULL if RSA is used for signature and the signature is made offline (otherwise f_rng is desirable for countermeasures against timing attacks). ECDSA signatures always require a non-NULL f_rng. </dd></dl>
</div>
</div>
<a id="a04e3c44ffeca58318250b7b1e6c416d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04e3c44ffeca58318250b7b1e6c416d1">◆ </a></span>mbedtls_x509write_csr_set_extension()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_x509write_csr_set_extension </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>oid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>oid_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>val_len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic function to add to or replace an extension in the CSR. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR context to use </td></tr>
<tr><td class="paramname">oid</td><td>OID of the extension </td></tr>
<tr><td class="paramname">oid_len</td><td>length of the OID </td></tr>
<tr><td class="paramname">val</td><td>value of the extension OCTET STRING </td></tr>
<tr><td class="paramname">val_len</td><td>length of the value data</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED </dd></dl>
</div>
</div>
<a id="ac4f0b724b1c7006d178e2d71c964f54c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4f0b724b1c7006d178e2d71c964f54c">◆ </a></span>mbedtls_x509write_csr_set_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_x509write_csr_set_key </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmbedtls__pk__context.html">mbedtls_pk_context</a> * </td>
<td class="paramname"><em>key</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the key for a CSR (public key will be included, private key used to sign the CSR when writing it) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR context to use </td></tr>
<tr><td class="paramname">key</td><td>Asymetric key to include </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac5ed085a0dee293f6c152ecd597473be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5ed085a0dee293f6c152ecd597473be">◆ </a></span>mbedtls_x509write_csr_set_key_usage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_x509write_csr_set_key_usage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>key_usage</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the Key Usage Extension flags (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR context to use </td></tr>
<tr><td class="paramname">key_usage</td><td>key usage flags to set</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED </dd></dl>
</div>
</div>
<a id="a2be90e1d59d29b2309670700a8c0420f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2be90e1d59d29b2309670700a8c0420f">◆ </a></span>mbedtls_x509write_csr_set_md_alg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_x509write_csr_set_md_alg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="md_8h.html#a219313cb40503ec3e34a857ab98b2296">mbedtls_md_type_t</a> </td>
<td class="paramname"><em>md_alg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the MD algorithm to use for the signature (e.g. MBEDTLS_MD_SHA1) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR context to use </td></tr>
<tr><td class="paramname">md_alg</td><td>MD algorithm to use </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a22571c0a8439dcacaa9762eca4d73a6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22571c0a8439dcacaa9762eca4d73a6e">◆ </a></span>mbedtls_x509write_csr_set_ns_cert_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_x509write_csr_set_ns_cert_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>ns_cert_type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the Netscape Cert Type flags (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR context to use </td></tr>
<tr><td class="paramname">ns_cert_type</td><td>Netscape Cert Type flags to set</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED </dd></dl>
</div>
</div>
<a id="a954eae166b125cea2115b7db8c896e90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a954eae166b125cea2115b7db8c896e90">◆ </a></span>mbedtls_x509write_csr_set_subject_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_x509write_csr_set_subject_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmbedtls__x509write__csr.html">mbedtls_x509write_csr</a> * </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>subject_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the subject name for a CSR Subject names should contain a comma-separated list of OID types and values: e.g. "C=UK,O=ARM,CN=mbed TLS Server 1". </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>CSR context to use </td></tr>
<tr><td class="paramname">subject_name</td><td>subject name to set</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if subject name was parsed successfully, or a specific error code </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 8 2018 21:08:42 for mbed TLS v2.7.3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
f835bee5b8b7ec08e20fae17cab51e63
>
files
>
655
