<!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.5"/>
<title>PolarSSL v1.3.8: 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 style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</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><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="x509__csr_8h__dep__incl.png" border="0" usemap="#x509__csr_8hdep" alt=""/></div>
<map name="x509__csr_8hdep" id="x509__csr_8hdep">
</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="struct__x509__csr.html">_x509_csr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Certificate Signing Request (CSR) structure. <a href="struct__x509__csr.html#details">More...</a><br/></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="struct__x509write__csr.html">_x509write_csr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Container for writing a CSR. <a href="struct__x509write__csr.html#details">More...</a><br/></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:ad23c16614fa5fbe3ae6b1af10c4ce2e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#ad23c16614fa5fbe3ae6b1af10c4ce2e0">x509write_csr_init</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">x509write_csr</a> *ctx)</td></tr>
<tr class="memdesc:ad23c16614fa5fbe3ae6b1af10c4ce2e0"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a CSR context. <a href="#ad23c16614fa5fbe3ae6b1af10c4ce2e0">More...</a><br/></td></tr>
<tr class="separator:ad23c16614fa5fbe3ae6b1af10c4ce2e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90236c3679109680926e015f13ac5329"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a90236c3679109680926e015f13ac5329">x509write_csr_set_subject_name</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">x509write_csr</a> *ctx, const char *subject_name)</td></tr>
<tr class="memdesc:a90236c3679109680926e015f13ac5329"><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. <a href="#a90236c3679109680926e015f13ac5329">More...</a><br/></td></tr>
<tr class="separator:a90236c3679109680926e015f13ac5329"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38a056d575a6f0fcc7825a02a60f8d45"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a38a056d575a6f0fcc7825a02a60f8d45">x509write_csr_set_key</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">x509write_csr</a> *ctx, <a class="el" href="structpk__context.html">pk_context</a> *key)</td></tr>
<tr class="memdesc:a38a056d575a6f0fcc7825a02a60f8d45"><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="#a38a056d575a6f0fcc7825a02a60f8d45">More...</a><br/></td></tr>
<tr class="separator:a38a056d575a6f0fcc7825a02a60f8d45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28d024b4e02815d6cc4edd1589a66987"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a28d024b4e02815d6cc4edd1589a66987">x509write_csr_set_md_alg</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">x509write_csr</a> *ctx, <a class="el" href="md_8h.html#af1fbbb67afa0daee4090cde8864e0b68">md_type_t</a> md_alg)</td></tr>
<tr class="memdesc:a28d024b4e02815d6cc4edd1589a66987"><td class="mdescLeft"> </td><td class="mdescRight">Set the MD algorithm to use for the signature (e.g. <a href="#a28d024b4e02815d6cc4edd1589a66987">More...</a><br/></td></tr>
<tr class="separator:a28d024b4e02815d6cc4edd1589a66987"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ecdb55af5fc4f1bf5ccb421bb99b696"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a8ecdb55af5fc4f1bf5ccb421bb99b696">x509write_csr_set_key_usage</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">x509write_csr</a> *ctx, unsigned char key_usage)</td></tr>
<tr class="memdesc:a8ecdb55af5fc4f1bf5ccb421bb99b696"><td class="mdescLeft"> </td><td class="mdescRight">Set the Key Usage Extension flags (e.g. <a href="#a8ecdb55af5fc4f1bf5ccb421bb99b696">More...</a><br/></td></tr>
<tr class="separator:a8ecdb55af5fc4f1bf5ccb421bb99b696"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f57c5e6a26cd74bc1306401745cd5a8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a4f57c5e6a26cd74bc1306401745cd5a8">x509write_csr_set_ns_cert_type</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">x509write_csr</a> *ctx, unsigned char ns_cert_type)</td></tr>
<tr class="memdesc:a4f57c5e6a26cd74bc1306401745cd5a8"><td class="mdescLeft"> </td><td class="mdescRight">Set the Netscape Cert Type flags (e.g. <a href="#a4f57c5e6a26cd74bc1306401745cd5a8">More...</a><br/></td></tr>
<tr class="separator:a4f57c5e6a26cd74bc1306401745cd5a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a048eb0735e36a642673b7e3c3ce03017"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a048eb0735e36a642673b7e3c3ce03017">x509write_csr_set_extension</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">x509write_csr</a> *ctx, const char *oid, size_t oid_len, const unsigned char *val, size_t val_len)</td></tr>
<tr class="memdesc:a048eb0735e36a642673b7e3c3ce03017"><td class="mdescLeft"> </td><td class="mdescRight">Generic function to add to or replace an extension in the CSR. <a href="#a048eb0735e36a642673b7e3c3ce03017">More...</a><br/></td></tr>
<tr class="separator:a048eb0735e36a642673b7e3c3ce03017"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ff79c3b3eed9175ffb691c81b2f46bc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a7ff79c3b3eed9175ffb691c81b2f46bc">x509write_csr_free</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">x509write_csr</a> *ctx)</td></tr>
<tr class="memdesc:a7ff79c3b3eed9175ffb691c81b2f46bc"><td class="mdescLeft"> </td><td class="mdescRight">Free the contents of a CSR context. <a href="#a7ff79c3b3eed9175ffb691c81b2f46bc">More...</a><br/></td></tr>
<tr class="separator:a7ff79c3b3eed9175ffb691c81b2f46bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd7a30a6b00b0b34ffa6792593eab737"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#abd7a30a6b00b0b34ffa6792593eab737">x509write_csr_der</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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:abd7a30a6b00b0b34ffa6792593eab737"><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="#abd7a30a6b00b0b34ffa6792593eab737">More...</a><br/></td></tr>
<tr class="separator:abd7a30a6b00b0b34ffa6792593eab737"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a396ecc4b6f1a7213f8907a5894ba034a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="x509__csr_8h.html#a396ecc4b6f1a7213f8907a5894ba034a">x509write_csr_pem</a> (<a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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:a396ecc4b6f1a7213f8907a5894ba034a"><td class="mdescLeft"> </td><td class="mdescRight">Write a CSR (Certificate Signing Request) to a PEM string. <a href="#a396ecc4b6f1a7213f8907a5894ba034a">More...</a><br/></td></tr>
<tr class="separator:a396ecc4b6f1a7213f8907a5894ba034a"><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:ga26cdab1edd0bf60704e0b0b0817a0291"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__x509__csr.html">_x509_csr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#ga26cdab1edd0bf60704e0b0b0817a0291">x509_csr</a></td></tr>
<tr class="memdesc:ga26cdab1edd0bf60704e0b0b0817a0291"><td class="mdescLeft"> </td><td class="mdescRight">Certificate Signing Request (CSR) structure. <a href="group__x509__module.html#ga26cdab1edd0bf60704e0b0b0817a0291">More...</a><br/></td></tr>
<tr class="separator:ga26cdab1edd0bf60704e0b0b0817a0291"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga48c2716d9aacdd1b0b9e7b17c1e33aa2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct__x509write__csr.html">_x509write_csr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">x509write_csr</a></td></tr>
<tr class="memdesc:ga48c2716d9aacdd1b0b9e7b17c1e33aa2"><td class="mdescLeft"> </td><td class="mdescRight">Container for writing a CSR. <a href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">More...</a><br/></td></tr>
<tr class="separator:ga48c2716d9aacdd1b0b9e7b17c1e33aa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac2678f50a8d832b3d71c071fb31c42b8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#gac2678f50a8d832b3d71c071fb31c42b8">x509_csr_parse_der</a> (<a class="el" href="group__x509__module.html#ga26cdab1edd0bf60704e0b0b0817a0291">x509_csr</a> *csr, const unsigned char *buf, size_t buflen)</td></tr>
<tr class="memdesc:gac2678f50a8d832b3d71c071fb31c42b8"><td class="mdescLeft"> </td><td class="mdescRight">Load a Certificate Signing Request (CSR) in DER format. <a href="group__x509__module.html#gac2678f50a8d832b3d71c071fb31c42b8">More...</a><br/></td></tr>
<tr class="separator:gac2678f50a8d832b3d71c071fb31c42b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf3f78c6f15ba595438f41ad06c7eb913"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#gaf3f78c6f15ba595438f41ad06c7eb913">x509_csr_parse</a> (<a class="el" href="group__x509__module.html#ga26cdab1edd0bf60704e0b0b0817a0291">x509_csr</a> *csr, const unsigned char *buf, size_t buflen)</td></tr>
<tr class="memdesc:gaf3f78c6f15ba595438f41ad06c7eb913"><td class="mdescLeft"> </td><td class="mdescRight">Load a Certificate Signing Request (CSR), DER or PEM format. <a href="group__x509__module.html#gaf3f78c6f15ba595438f41ad06c7eb913">More...</a><br/></td></tr>
<tr class="separator:gaf3f78c6f15ba595438f41ad06c7eb913"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9018bb8c7bf444c0b037d5f3ac120f37"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#ga9018bb8c7bf444c0b037d5f3ac120f37">x509_csr_parse_file</a> (<a class="el" href="group__x509__module.html#ga26cdab1edd0bf60704e0b0b0817a0291">x509_csr</a> *csr, const char *path)</td></tr>
<tr class="memdesc:ga9018bb8c7bf444c0b037d5f3ac120f37"><td class="mdescLeft"> </td><td class="mdescRight">Load a Certificate Signing Request (CSR) <a href="group__x509__module.html#ga9018bb8c7bf444c0b037d5f3ac120f37">More...</a><br/></td></tr>
<tr class="separator:ga9018bb8c7bf444c0b037d5f3ac120f37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1f152bf56415a2e28382e3b425844838"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#ga1f152bf56415a2e28382e3b425844838">x509_csr_info</a> (char *buf, size_t size, const char *prefix, const <a class="el" href="group__x509__module.html#ga26cdab1edd0bf60704e0b0b0817a0291">x509_csr</a> *csr)</td></tr>
<tr class="memdesc:ga1f152bf56415a2e28382e3b425844838"><td class="mdescLeft"> </td><td class="mdescRight">Returns an informational string about the CSR. <a href="group__x509__module.html#ga1f152bf56415a2e28382e3b425844838">More...</a><br/></td></tr>
<tr class="separator:ga1f152bf56415a2e28382e3b425844838"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaca04de43aa24a914d5c50112aec3dfe2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#gaca04de43aa24a914d5c50112aec3dfe2">x509_csr_init</a> (<a class="el" href="group__x509__module.html#ga26cdab1edd0bf60704e0b0b0817a0291">x509_csr</a> *csr)</td></tr>
<tr class="memdesc:gaca04de43aa24a914d5c50112aec3dfe2"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a CSR. <a href="group__x509__module.html#gaca04de43aa24a914d5c50112aec3dfe2">More...</a><br/></td></tr>
<tr class="separator:gaca04de43aa24a914d5c50112aec3dfe2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5ca4ec1c3051b481cb17c7fda14d6499"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x509__module.html#ga5ca4ec1c3051b481cb17c7fda14d6499">x509_csr_free</a> (<a class="el" href="group__x509__module.html#ga26cdab1edd0bf60704e0b0b0817a0291">x509_csr</a> *csr)</td></tr>
<tr class="memdesc:ga5ca4ec1c3051b481cb17c7fda14d6499"><td class="mdescLeft"> </td><td class="mdescRight">Unallocate all CSR data. <a href="group__x509__module.html#ga5ca4ec1c3051b481cb17c7fda14d6499">More...</a><br/></td></tr>
<tr class="separator:ga5ca4ec1c3051b481cb17c7fda14d6499"><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>Copyright (C) 2006-2014, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
<p>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 class="anchor" id="abd7a30a6b00b0b34ffa6792593eab737"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int x509write_csr_der </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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 class="anchor" id="a7ff79c3b3eed9175ffb691c81b2f46bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void x509write_csr_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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 class="anchor" id="ad23c16614fa5fbe3ae6b1af10c4ce2e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void x509write_csr_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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 class="anchor" id="a396ecc4b6f1a7213f8907a5894ba034a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int x509write_csr_pem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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 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 couermeasures against timing attacks). ECDSA signatures always require a non-NULL f_rng. </dd></dl>
</div>
</div>
<a class="anchor" id="a048eb0735e36a642673b7e3c3ce03017"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int x509write_csr_set_extension </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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 POLARSSL_ERR_X509WRITE_MALLOC_FAILED </dd></dl>
</div>
</div>
<a class="anchor" id="a38a056d575a6f0fcc7825a02a60f8d45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void x509write_csr_set_key </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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="structpk__context.html">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 class="anchor" id="a8ecdb55af5fc4f1bf5ccb421bb99b696"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int x509write_csr_set_key_usage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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. </p>
<p>KU_DIGITAL_SIGNATURE | 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 POLARSSL_ERR_X509WRITE_MALLOC_FAILED </dd></dl>
</div>
</div>
<a class="anchor" id="a28d024b4e02815d6cc4edd1589a66987"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void x509write_csr_set_md_alg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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#af1fbbb67afa0daee4090cde8864e0b68">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. </p>
<p>POLARSSL_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 class="anchor" id="a4f57c5e6a26cd74bc1306401745cd5a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int x509write_csr_set_ns_cert_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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. </p>
<p>NS_CERT_TYPE_SSL_CLIENT | 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 POLARSSL_ERR_X509WRITE_MALLOC_FAILED </dd></dl>
</div>
</div>
<a class="anchor" id="a90236c3679109680926e015f13ac5329"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int x509write_csr_set_subject_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__x509__module.html#ga48c2716d9aacdd1b0b9e7b17c1e33aa2">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. </p>
<p>"C=NL,O=Offspark,CN=PolarSSL 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 Thu Jul 31 2014 11:35:56 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
