~ubuntu-branches/ubuntu/precise/gnutls28/precise

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-init" title="gnutls_pubkey_init ()">gnutls_pubkey_init</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> *key</code>);

void <a class="link" href="gnutls-abstract.html#gnutls-pubkey-deinit" title="gnutls_pubkey_deinit ()">gnutls_pubkey_deinit</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-get-pk-algorithm" title="gnutls_pubkey_get_pk_algorithm ()">gnutls_pubkey_get_pk_algorithm</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>unsigned int *bits</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-import-x509" title="gnutls_pubkey_import_x509 ()">gnutls_pubkey_import_x509</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> crt</code>,

<code>unsigned int flags</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-import-pkcs11" title="gnutls_pubkey_import_pkcs11 ()">gnutls_pubkey_import_pkcs11</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code><a class="link" href="gnutls-pkcs11.html#gnutls-pkcs11-obj-t" title="gnutls_pkcs11_obj_t">gnutls_pkcs11_obj_t</a> obj</code>,

<code>unsigned int flags</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-import-openpgp" title="gnutls_pubkey_import_openpgp ()">gnutls_pubkey_import_openpgp</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code><a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> crt</code>,

<code>unsigned int flags</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-get-preferred-hash-algorithm" title="gnutls_pubkey_get_preferred_hash_algorithm ()">gnutls_pubkey_get_preferred_hash_algorithm</a>

(<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code><a class="link" href="gnutls-gnutls.html#gnutls-digest-algorithm-t" title="enum gnutls_digest_algorithm_t">gnutls_digest_algorithm_t</a> *hash</code>,

<code>unsigned int *mand</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-get-pk-rsa-raw" title="gnutls_pubkey_get_pk_rsa_raw ()">gnutls_pubkey_get_pk_rsa_raw</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>gnutls_datum_t *m</code>,

<code>gnutls_datum_t *e</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-get-pk-dsa-raw" title="gnutls_pubkey_get_pk_dsa_raw ()">gnutls_pubkey_get_pk_dsa_raw</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>gnutls_datum_t *p</code>,

<code>gnutls_datum_t *q</code>,

<code>gnutls_datum_t *g</code>,

<code>gnutls_datum_t *y</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-export" title="gnutls_pubkey_export ()">gnutls_pubkey_export</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-fmt-t" title="enum gnutls_x509_crt_fmt_t">gnutls_x509_crt_fmt_t</a> format</code>,

<code>void *output_data</code>,

<code>size_t *output_data_size</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-get-key-id" title="gnutls_pubkey_get_key_id ()">gnutls_pubkey_get_key_id</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>unsigned int flags</code>,

<code>unsigned char *output_data</code>,

<code>size_t *output_data_size</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-get-key-usage" title="gnutls_pubkey_get_key_usage ()">gnutls_pubkey_get_key_usage</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>unsigned int *usage</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-set-key-usage" title="gnutls_pubkey_set_key_usage ()">gnutls_pubkey_set_key_usage</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>unsigned int usage</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-import" title="gnutls_pubkey_import ()">gnutls_pubkey_import</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>const gnutls_datum_t *data</code>,

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-fmt-t" title="enum gnutls_x509_crt_fmt_t">gnutls_x509_crt_fmt_t</a> format</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-import-pkcs11-url" title="gnutls_pubkey_import_pkcs11_url ()">gnutls_pubkey_import_pkcs11_url</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>const char *url</code>,

<code>unsigned int flags</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-import-dsa-raw" title="gnutls_pubkey_import_dsa_raw ()">gnutls_pubkey_import_dsa_raw</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>const gnutls_datum_t *p</code>,

<code>const gnutls_datum_t *q</code>,

<code>const gnutls_datum_t *g</code>,

<code>const gnutls_datum_t *y</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-import-rsa-raw" title="gnutls_pubkey_import_rsa_raw ()">gnutls_pubkey_import_rsa_raw</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>const gnutls_datum_t *m</code>,

<code>const gnutls_datum_t *e</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-x509-crt-set-pubkey" title="gnutls_x509_crt_set_pubkey ()">gnutls_x509_crt_set_pubkey</a> (<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> crt</code>,

<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-x509-crq-set-pubkey" title="gnutls_x509_crq_set_pubkey ()">gnutls_x509_crq_set_pubkey</a> (<code><a class="link" href="gnutls-x509.html#gnutls-x509-crq-t" title="gnutls_x509_crq_t">gnutls_x509_crq_t</a> crq</code>,

<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>);

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-verify-hash" title="gnutls_pubkey_verify_hash ()">gnutls_pubkey_verify_hash</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

<code>unsigned int flags</code>,

<code>const gnutls_datum_t *hash</code>,

100

<code>const gnutls_datum_t *signature</code>);

101

int <a class="link" href="gnutls-abstract.html#gnutls-pubkey-get-verify-algorithm" title="gnutls_pubkey_get_verify_algorithm ()">gnutls_pubkey_get_verify_algorithm</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

102

<code>const gnutls_datum_t *signature</code>,

103

104

struct <a class="link" href="gnutls-abstract.html#gnutls-privkey-st" title="struct gnutls_privkey_st">gnutls_privkey_st</a>;

105

typedef <a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a>;

106

int <a class="link" href="gnutls-abstract.html#gnutls-privkey-init" title="gnutls_privkey_init ()">gnutls_privkey_init</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> *key</code>);

107

void <a class="link" href="gnutls-abstract.html#gnutls-privkey-deinit" title="gnutls_privkey_deinit ()">gnutls_privkey_deinit</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>);

108

int <a class="link" href="gnutls-abstract.html#gnutls-privkey-get-pk-algorithm" title="gnutls_privkey_get_pk_algorithm ()">gnutls_privkey_get_pk_algorithm</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>,

109

<code>unsigned int *bits</code>);

110

<a class="link" href="gnutls-gnutls.html#gnutls-privkey-type-t" title="enum gnutls_privkey_type_t">gnutls_privkey_type_t</a> <a class="link" href="gnutls-abstract.html#gnutls-privkey-get-type" title="gnutls_privkey_get_type ()">gnutls_privkey_get_type</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>);

111

#define <a class="link" href="gnutls-abstract.html#GNUTLS-PRIVKEY-IMPORT-AUTO-RELEASE:CAPS" title="GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE">GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE</a>

112

int <a class="link" href="gnutls-abstract.html#gnutls-privkey-import-pkcs11" title="gnutls_privkey_import_pkcs11 ()">gnutls_privkey_import_pkcs11</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> pkey</code>,

113

<code><a class="link" href="gnutls-gnutls.html#gnutls-pkcs11-privkey-t" title="gnutls_pkcs11_privkey_t">gnutls_pkcs11_privkey_t</a> key</code>,

114

<code>unsigned int flags</code>);

115

int <a class="link" href="gnutls-abstract.html#gnutls-privkey-import-x509" title="gnutls_privkey_import_x509 ()">gnutls_privkey_import_x509</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> pkey</code>,

116

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-privkey-t" title="gnutls_x509_privkey_t">gnutls_x509_privkey_t</a> key</code>,

117

<code>unsigned int flags</code>);

118

int <a class="link" href="gnutls-abstract.html#gnutls-privkey-import-openpgp" title="gnutls_privkey_import_openpgp ()">gnutls_privkey_import_openpgp</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> pkey</code>,

119

<code><a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key</code>,

120

<code>unsigned int flags</code>);

121

int <a class="link" href="gnutls-abstract.html#gnutls-privkey-sign-data" title="gnutls_privkey_sign_data ()">gnutls_privkey_sign_data</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> signer</code>,

122

123

<code>unsigned int flags</code>,

124

<code>const gnutls_datum_t *data</code>,

125

<code>gnutls_datum_t *signature</code>);

126

int <a class="link" href="gnutls-abstract.html#gnutls-privkey-sign-hash" title="gnutls_privkey_sign_hash ()">gnutls_privkey_sign_hash</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> signer</code>,

127

128

<code>unsigned int flags</code>,

129

<code>const gnutls_datum_t *hash_data</code>,

130

<code>gnutls_datum_t *signature</code>);

131

int <a class="link" href="gnutls-abstract.html#gnutls-privkey-decrypt-data" title="gnutls_privkey_decrypt_data ()">gnutls_privkey_decrypt_data</a> (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>,

132

<code>unsigned int flags</code>,

133

<code>const gnutls_datum_t *ciphertext</code>,

134

<code>gnutls_datum_t *plaintext</code>);

135

int <a class="link" href="gnutls-abstract.html#gnutls-x509-crt-privkey-sign" title="gnutls_x509_crt_privkey_sign ()">gnutls_x509_crt_privkey_sign</a> (<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> crt</code>,

136

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> issuer</code>,

137

<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> issuer_key</code>,

138

139

<code>unsigned int flags</code>);

140

int <a class="link" href="gnutls-abstract.html#gnutls-x509-crl-privkey-sign" title="gnutls_x509_crl_privkey_sign ()">gnutls_x509_crl_privkey_sign</a> (<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crl-t" title="gnutls_x509_crl_t">gnutls_x509_crl_t</a> crl</code>,

141

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> issuer</code>,

142

<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> issuer_key</code>,

143

144

<code>unsigned int flags</code>);

145

int <a class="link" href="gnutls-abstract.html#gnutls-x509-crq-privkey-sign" title="gnutls_x509_crq_privkey_sign ()">gnutls_x509_crq_privkey_sign</a> (<code><a class="link" href="gnutls-x509.html#gnutls-x509-crq-t" title="gnutls_x509_crq_t">gnutls_x509_crq_t</a> crq</code>,

146

<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>,

147

148

<code>unsigned int flags</code>);

149

</pre>

150

</div>

151

152

<a name="gnutls-abstract.description"></a><h2>Description</h2>

153

154

155

</div>

156

157

<a name="gnutls-abstract.details"></a><h2>Details</h2>

158

159

<a name="gnutls-pubkey-st"></a><h3>struct gnutls_pubkey_st</h3>

160

<pre class="programlisting">struct gnutls_pubkey_st;</pre>

161

162

163

</div>

164

<hr>

165

166

<a name="gnutls-pubkey-t"></a><h3>gnutls_pubkey_t</h3>

167

<pre class="programlisting">typedef struct gnutls_pubkey_st *gnutls_pubkey_t;

168

</pre>

169

170

171

</div>

172

<hr>

173

174

<a name="gnutls-pubkey-init"></a><h3>gnutls_pubkey_init ()</h3>

175

<pre class="programlisting">int gnutls_pubkey_init (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> *key</code>);</pre>

176

177

This function will initialize an public key structure.

178

179

180

181

<tbody>

182

<tr>

183

184

<td>The structure to be initialized</td>

185

</tr>

186

<tr>

187

<td>Returns :</td>

188

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

189

negative error value.</td>

190

</tr>

191

</tbody>

192

</table></div>

193

Since 2.12.0

194

</div>

195

<hr>

196

197

<a name="gnutls-pubkey-deinit"></a><h3>gnutls_pubkey_deinit ()</h3>

198

<pre class="programlisting">void gnutls_pubkey_deinit (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>);</pre>

199

200

This function will deinitialize a public key structure.

201

202

203

204

205

206

<td>The structure to be deinitialized</td>

207

</tr></tbody>

208

</table></div>

209

Since 2.12.0

210

</div>

211

<hr>

212

213

<a name="gnutls-pubkey-get-pk-algorithm"></a><h3>gnutls_pubkey_get_pk_algorithm ()</h3>

214

<pre class="programlisting">int gnutls_pubkey_get_pk_algorithm (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

215

<code>unsigned int *bits</code>);</pre>

216

217

This function will return the public key algorithm of a public

218

key and if possible will return a number of bits that indicates

219

the security parameter of the key.

220

221

222

223

<tbody>

224

<tr>

225

226

<td>should contain a <a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> structure</td>

227

</tr>

228

<tr>

229

230

<td>If set will return the number of bits of the parameters (may be NULL)</td>

231

</tr>

232

<tr>

233

<td>Returns :</td>

234

<td>a member of the <a class="link" href="gnutls-gnutls.html#gnutls-pk-algorithm-t" title="enum gnutls_pk_algorithm_t">gnutls_pk_algorithm_t</a> enumeration on

235

success, or a negative error code on error.</td>

236

</tr>

237

</tbody>

238

</table></div>

239

Since 2.12.0

240

</div>

241

<hr>

242

243

<a name="gnutls-pubkey-import-x509"></a><h3>gnutls_pubkey_import_x509 ()</h3>

244

<pre class="programlisting">int gnutls_pubkey_import_x509 (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

245

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> crt</code>,

246

<code>unsigned int flags</code>);</pre>

247

248

This function will import the given public key to the abstract

249

<a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> structure.

250

251

252

253

<tbody>

254

<tr>

255

256

<td>The public key</td>

257

</tr>

258

<tr>

259

260

<td>The certificate to be imported</td>

261

</tr>

262

<tr>

263

<td><code>flags</code> :</td>

264

<td>should be zero</td>

265

</tr>

266

<tr>

267

<td>Returns :</td>

268

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

269

negative error value.</td>

270

</tr>

271

</tbody>

272

</table></div>

273

Since 2.12.0

274

</div>

275

<hr>

276

277

<a name="gnutls-pubkey-import-pkcs11"></a><h3>gnutls_pubkey_import_pkcs11 ()</h3>

278

<pre class="programlisting">int gnutls_pubkey_import_pkcs11 (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

279

<code><a class="link" href="gnutls-pkcs11.html#gnutls-pkcs11-obj-t" title="gnutls_pkcs11_obj_t">gnutls_pkcs11_obj_t</a> obj</code>,

280

<code>unsigned int flags</code>);</pre>

281

282

Imports a public key from a pkcs11 key. This function will import

283

the given public key to the abstract <a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> structure.

284

285

286

287

<tbody>

288

<tr>

289

290

<td>The public key</td>

291

</tr>

292

<tr>

293

294

<td>The parameters to be imported</td>

295

</tr>

296

<tr>

297

<td><code>flags</code> :</td>

298

<td>should be zero</td>

299

</tr>

300

<tr>

301

<td>Returns :</td>

302

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

303

negative error value.</td>

304

</tr>

305

</tbody>

306

</table></div>

307

Since 2.12.0

308

</div>

309

<hr>

310

311

<a name="gnutls-pubkey-import-openpgp"></a><h3>gnutls_pubkey_import_openpgp ()</h3>

312

<pre class="programlisting">int gnutls_pubkey_import_openpgp (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

313

<code><a class="link" href="gnutls-gnutls.html#gnutls-openpgp-crt-t" title="gnutls_openpgp_crt_t">gnutls_openpgp_crt_t</a> crt</code>,

314

<code>unsigned int flags</code>);</pre>

315

316

Imports a public key from an openpgp key. This function will import

317

the given public key to the abstract <a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a>

318

structure. The subkey set as preferred will be imported or the

319

master key otherwise.

320

321

322

323

<tbody>

324

<tr>

325

326

<td>The public key</td>

327

</tr>

328

<tr>

329

330

<td>The certificate to be imported</td>

331

</tr>

332

<tr>

333

<td><code>flags</code> :</td>

334

<td>should be zero</td>

335

</tr>

336

<tr>

337

<td>Returns :</td>

338

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

339

negative error value.</td>

340

</tr>

341

</tbody>

342

</table></div>

343

Since 2.12.0

344

</div>

345

<hr>

346

347

<a name="gnutls-pubkey-get-preferred-hash-algorithm"></a><h3>gnutls_pubkey_get_preferred_hash_algorithm ()</h3>

348

<pre class="programlisting">int gnutls_pubkey_get_preferred_hash_algorithm

349

(<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

350

351

<code>unsigned int *mand</code>);</pre>

352

353

This function will read the certifcate and return the appropriate digest

354

algorithm to use for signing with this certificate. Some certificates (i.e.

355

DSA might not be able to sign without the preferred algorithm).

356

357

358

359

<tbody>

360

<tr>

361

362

<td>Holds the certificate</td>

363

</tr>

364

<tr>

365

366

<td>The result of the call with the hash algorithm used for signature</td>

367

</tr>

368

<tr>

369

370

<td>If non zero it means that the algorithm MUST use this hash. May be NULL.</td>

371

</tr>

372

<tr>

373

<td>Returns :</td>

374

<td>the 0 if the hash algorithm is found. A negative error code is

375

returned on error.</td>

376

</tr>

377

</tbody>

378

</table></div>

379

Since 2.12.0

380

</div>

381

<hr>

382

383

<a name="gnutls-pubkey-get-pk-rsa-raw"></a><h3>gnutls_pubkey_get_pk_rsa_raw ()</h3>

384

<pre class="programlisting">int gnutls_pubkey_get_pk_rsa_raw (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

385

<code>gnutls_datum_t *m</code>,

386

<code>gnutls_datum_t *e</code>);</pre>

387

388

This function will export the RSA public key's parameters found in

389

the given structure. The new parameters will be allocated using

390

<a class="link" href="gnutls-gnutls.html#gnutls-malloc" title="gnutls_malloc"><code class="function">gnutls_malloc()</code></a> and will be stored in the appropriate datum.

391

392

393

394

<tbody>

395

<tr>

396

397

<td>Holds the certificate</td>

398

</tr>

399

<tr>

400

401

<td>will hold the modulus</td>

402

</tr>

403

<tr>

404

405

<td>will hold the public exponent</td>

406

</tr>

407

<tr>

408

<td>Returns :</td>

409

<td>

410

<a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> on success, otherwise a negative error code.</td>

411

</tr>

412

</tbody>

413

</table></div>

414

Since 2.12.0

415

</div>

416

<hr>

417

418

<a name="gnutls-pubkey-get-pk-dsa-raw"></a><h3>gnutls_pubkey_get_pk_dsa_raw ()</h3>

419

<pre class="programlisting">int gnutls_pubkey_get_pk_dsa_raw (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

420

<code>gnutls_datum_t *p</code>,

421

<code>gnutls_datum_t *q</code>,

422

<code>gnutls_datum_t *g</code>,

423

<code>gnutls_datum_t *y</code>);</pre>

424

425

This function will export the DSA public key's parameters found in

426

the given certificate. The new parameters will be allocated using

427

<a class="link" href="gnutls-gnutls.html#gnutls-malloc" title="gnutls_malloc"><code class="function">gnutls_malloc()</code></a> and will be stored in the appropriate datum.

428

429

430

431

<tbody>

432

<tr>

433

434

<td>Holds the public key</td>

435

</tr>

436

<tr>

437

438

439

</tr>

440

<tr>

441

442

443

</tr>

444

<tr>

445

446

447

</tr>

448

<tr>

449

450

451

</tr>

452

<tr>

453

<td>Returns :</td>

454

<td>

455

<a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> on success, otherwise a negative error code.</td>

456

</tr>

457

</tbody>

458

</table></div>

459

Since 2.12.0

460

</div>

461

<hr>

462

463

<a name="gnutls-pubkey-export"></a><h3>gnutls_pubkey_export ()</h3>

464

<pre class="programlisting">int gnutls_pubkey_export (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

465

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-fmt-t" title="enum gnutls_x509_crt_fmt_t">gnutls_x509_crt_fmt_t</a> format</code>,

466

<code>void *output_data</code>,

467

<code>size_t *output_data_size</code>);</pre>

468

469

This function will export the certificate to DER or PEM format.

470

471

472

If the buffer provided is not long enough to hold the output, then

473

*output_data_size is updated and <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SHORT-MEMORY-BUFFER:CAPS" title="GNUTLS_E_SHORT_MEMORY_BUFFER"><code class="literal">GNUTLS_E_SHORT_MEMORY_BUFFER</code></a> will

474

be returned.

475

476

477

If the structure is PEM encoded, it will have a header

478

of "BEGIN CERTIFICATE".

479

480

481

482

<tbody>

483

<tr>

484

485

<td>Holds the certificate</td>

486

</tr>

487

<tr>

488

<td><code>format</code> :</td>

489

<td>the format of output params. One of PEM or DER.</td>

490

</tr>

491

<tr>

492

<td><code>output_data</code> :</td>

493

<td>will contain a certificate PEM or DER encoded</td>

494

</tr>

495

<tr>

496

<td><code>output_data_size</code> :</td>

497

<td>holds the size of output_data (and will be

498

replaced by the actual size of parameters)</td>

499

</tr>

500

<tr>

501

<td>Returns :</td>

502

<td>In case of failure a negative error code will be

503

returned, and 0 on success.</td>

504

</tr>

505

</tbody>

506

</table></div>

507

Since 2.12.0

508

</div>

509

<hr>

510

511

<a name="gnutls-pubkey-get-key-id"></a><h3>gnutls_pubkey_get_key_id ()</h3>

512

<pre class="programlisting">int gnutls_pubkey_get_key_id (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

513

<code>unsigned int flags</code>,

514

<code>unsigned char *output_data</code>,

515

<code>size_t *output_data_size</code>);</pre>

516

517

This function will return a unique ID the depends on the public

518

key parameters. This ID can be used in checking whether a

519

certificate corresponds to the given public key.

520

521

522

If the buffer provided is not long enough to hold the output, then

523

524

be returned. The output will normally be a SHA-1 hash output,

525

which is 20 bytes.

526

527

528

529

<tbody>

530

<tr>

531

532

<td>Holds the public key</td>

533

</tr>

534

<tr>

535

<td><code>flags</code> :</td>

536

<td>should be 0 for now</td>

537

</tr>

538

<tr>

539

<td><code>output_data</code> :</td>

540

<td>will contain the key ID</td>

541

</tr>

542

<tr>

543

<td><code>output_data_size</code> :</td>

544

<td>holds the size of output_data (and will be

545

replaced by the actual size of parameters)</td>

546

</tr>

547

<tr>

548

<td>Returns :</td>

549

<td>In case of failure a negative error code will be

550

returned, and 0 on success.</td>

551

</tr>

552

</tbody>

553

</table></div>

554

Since 2.12.0

555

</div>

556

<hr>

557

558

<a name="gnutls-pubkey-get-key-usage"></a><h3>gnutls_pubkey_get_key_usage ()</h3>

559

<pre class="programlisting">int gnutls_pubkey_get_key_usage (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

560

<code>unsigned int *usage</code>);</pre>

561

562

This function will return the key usage of the public key.

563

564

565

566

<tbody>

567

<tr>

568

569

<td>should contain a <a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> structure</td>

570

</tr>

571

<tr>

572

<td><code>usage</code> :</td>

573

<td>If set will return the number of bits of the parameters (may be NULL)</td>

574

</tr>

575

<tr>

576

<td>Returns :</td>

577

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

578

negative error value.</td>

579

</tr>

580

</tbody>

581

</table></div>

582

Since 2.12.0

583

</div>

584

<hr>

585

586

<a name="gnutls-pubkey-set-key-usage"></a><h3>gnutls_pubkey_set_key_usage ()</h3>

587

<pre class="programlisting">int gnutls_pubkey_set_key_usage (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

588

<code>unsigned int usage</code>);</pre>

589

590

This function will set the key usage flags of the public key. This

591

is only useful if the key is to be exported to a certificate or

592

certificate request.

593

594

595

596

<tbody>

597

<tr>

598

599

<td>a certificate of type <a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a>

600

</td>

601

</tr>

602

<tr>

603

<td><code>usage</code> :</td>

604

<td>an ORed sequence of the GNUTLS_KEY_* elements.</td>

605

</tr>

606

<tr>

607

<td>Returns :</td>

608

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

609

negative error value.</td>

610

</tr>

611

</tbody>

612

</table></div>

613

Since 2.12.0

614

</div>

615

<hr>

616

617

<a name="gnutls-pubkey-import"></a><h3>gnutls_pubkey_import ()</h3>

618

<pre class="programlisting">int gnutls_pubkey_import (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

619

<code>const gnutls_datum_t *data</code>,

620

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-fmt-t" title="enum gnutls_x509_crt_fmt_t">gnutls_x509_crt_fmt_t</a> format</code>);</pre>

621

622

This function will convert the given DER or PEM encoded Public key

623

to the native gnutls_pubkey_t format.The output will be stored

624

in <code>key</code>.

625

If the Certificate is PEM encoded it should have a header of "PUBLIC KEY".

626

627

628

629

<tbody>

630

<tr>

631

632

<td>The structure to store the parsed public key.</td>

633

</tr>

634

<tr>

635

636

<td>The DER or PEM encoded certificate.</td>

637

</tr>

638

<tr>

639

<td><code>format</code> :</td>

640

641

</tr>

642

<tr>

643

<td>Returns :</td>

644

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

645

negative error value.</td>

646

</tr>

647

</tbody>

648

</table></div>

649

Since 2.12.0

650

</div>

651

<hr>

652

653

<a name="gnutls-pubkey-import-pkcs11-url"></a><h3>gnutls_pubkey_import_pkcs11_url ()</h3>

654

<pre class="programlisting">int gnutls_pubkey_import_pkcs11_url (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

655

<code>const char *url</code>,

656

<code>unsigned int flags</code>);</pre>

657

658

This function will import a PKCS 11 certificate to a <a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a>

659

structure.

660

661

662

663

<tbody>

664

<tr>

665

666

<td>A key of type <a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a>

667

</td>

668

</tr>

669

<tr>

670

671

672

</tr>

673

<tr>

674

<td><code>flags</code> :</td>

675

<td>One of GNUTLS_PKCS11_OBJ_* flags</td>

676

</tr>

677

<tr>

678

<td>Returns :</td>

679

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

680

negative error value.</td>

681

</tr>

682

</tbody>

683

</table></div>

684

Since 2.12.0

685

</div>

686

<hr>

687

688

<a name="gnutls-pubkey-import-dsa-raw"></a><h3>gnutls_pubkey_import_dsa_raw ()</h3>

689

<pre class="programlisting">int gnutls_pubkey_import_dsa_raw (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

690

<code>const gnutls_datum_t *p</code>,

691

<code>const gnutls_datum_t *q</code>,

692

<code>const gnutls_datum_t *g</code>,

693

<code>const gnutls_datum_t *y</code>);</pre>

694

695

This function will convert the given DSA raw parameters to the

696

native <a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> format. The output will be stored

697

in <code>key</code>.

698

699

700

701

<tbody>

702

<tr>

703

704

<td>The structure to store the parsed key</td>

705

</tr>

706

<tr>

707

708

<td>holds the p</td>

709

</tr>

710

<tr>

711

712

<td>holds the q</td>

713

</tr>

714

<tr>

715

716

<td>holds the g</td>

717

</tr>

718

<tr>

719

720

<td>holds the y</td>

721

</tr>

722

<tr>

723

<td>Returns :</td>

724

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

725

negative error value.</td>

726

</tr>

727

</tbody>

728

</table></div>

729

Since 2.12.0

730

</div>

731

<hr>

732

733

<a name="gnutls-pubkey-import-rsa-raw"></a><h3>gnutls_pubkey_import_rsa_raw ()</h3>

734

<pre class="programlisting">int gnutls_pubkey_import_rsa_raw (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

735

<code>const gnutls_datum_t *m</code>,

736

<code>const gnutls_datum_t *e</code>);</pre>

737

738

This function will replace the parameters in the given structure.

739

The new parameters should be stored in the appropriate

740

gnutls_datum.

741

742

743

744

<tbody>

745

<tr>

746

747

<td>Is a structure will hold the parameters</td>

748

</tr>

749

<tr>

750

751

<td>holds the modulus</td>

752

</tr>

753

<tr>

754

755

<td>holds the public exponent</td>

756

</tr>

757

<tr>

758

<td>Returns :</td>

759

<td>

760

<a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> on success, or an negative error code.</td>

761

</tr>

762

</tbody>

763

</table></div>

764

Since 2.12.0

765

</div>

766

<hr>

767

768

<a name="gnutls-x509-crt-set-pubkey"></a><h3>gnutls_x509_crt_set_pubkey ()</h3>

769

<pre class="programlisting">int gnutls_x509_crt_set_pubkey (<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> crt</code>,

770

<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>);</pre>

771

772

This function will set the public parameters from the given public

773

key to the request.

774

775

776

777

<tbody>

778

<tr>

779

780

<td>should contain a <a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> structure</td>

781

</tr>

782

<tr>

783

784

<td>holds a public key</td>

785

</tr>

786

<tr>

787

<td>Returns :</td>

788

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

789

negative error value.</td>

790

</tr>

791

</tbody>

792

</table></div>

793

Since 2.12.0

794

</div>

795

<hr>

796

797

<a name="gnutls-x509-crq-set-pubkey"></a><h3>gnutls_x509_crq_set_pubkey ()</h3>

798

<pre class="programlisting">int gnutls_x509_crq_set_pubkey (<code><a class="link" href="gnutls-x509.html#gnutls-x509-crq-t" title="gnutls_x509_crq_t">gnutls_x509_crq_t</a> crq</code>,

799

<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>);</pre>

800

801

This function will set the public parameters from the given public

802

key to the request.

803

804

805

806

<tbody>

807

<tr>

808

809

<td>should contain a <a class="link" href="gnutls-x509.html#gnutls-x509-crq-t" title="gnutls_x509_crq_t">gnutls_x509_crq_t</a> structure</td>

810

</tr>

811

<tr>

812

813

<td>holds a public key</td>

814

</tr>

815

<tr>

816

<td>Returns :</td>

817

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

818

negative error value.</td>

819

</tr>

820

</tbody>

821

</table></div>

822

Since 2.12.0

823

</div>

824

<hr>

825

826

<a name="gnutls-pubkey-verify-hash"></a><h3>gnutls_pubkey_verify_hash ()</h3>

827

<pre class="programlisting">int gnutls_pubkey_verify_hash (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

828

<code>unsigned int flags</code>,

829

<code>const gnutls_datum_t *hash</code>,

830

<code>const gnutls_datum_t *signature</code>);</pre>

831

832

This function will verify the given signed digest, using the

833

parameters from the certificate.

834

835

836

837

<tbody>

838

<tr>

839

840

<td>Holds the certificate</td>

841

</tr>

842

<tr>

843

<td><code>flags</code> :</td>

844

<td>should be 0 for now</td>

845

</tr>

846

<tr>

847

848

<td>holds the hash digest to be verified</td>

849

</tr>

850

<tr>

851

<td><code>signature</code> :</td>

852

<td>contains the signature</td>

853

</tr>

854

<tr>

855

<td>Returns :</td>

856

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

857

negative error value (<a class="link" href="gnutls-gnutls.html#GNUTLS-E-PK-SIG-VERIFY-FAILED:CAPS" title="GNUTLS_E_PK_SIG_VERIFY_FAILED"><code class="literal">GNUTLS_E_PK_SIG_VERIFY_FAILED</code></a> in verification failure).</td>

858

</tr>

859

</tbody>

860

</table></div>

861

Since 2.12.0

862

</div>

863

<hr>

864

865

<a name="gnutls-pubkey-get-verify-algorithm"></a><h3>gnutls_pubkey_get_verify_algorithm ()</h3>

866

<pre class="programlisting">int gnutls_pubkey_get_verify_algorithm (<code><a class="link" href="gnutls-abstract.html#gnutls-pubkey-t" title="gnutls_pubkey_t">gnutls_pubkey_t</a> key</code>,

867

<code>const gnutls_datum_t *signature</code>,

868

869

870

This function will read the certifcate and the signed data to

871

determine the hash algorithm used to generate the signature.

872

873

874

875

<tbody>

876

<tr>

877

878

<td>Holds the certificate</td>

879

</tr>

880

<tr>

881

<td><code>signature</code> :</td>

882

<td>contains the signature</td>

883

</tr>

884

<tr>

885

886

<td>The result of the call with the hash algorithm used for signature</td>

887

</tr>

888

<tr>

889

<td>Returns :</td>

890

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

891

negative error value.</td>

892

</tr>

893

</tbody>

894

</table></div>

895

Since 2.12.0

896

</div>

897

<hr>

898

899

<a name="gnutls-privkey-st"></a><h3>struct gnutls_privkey_st</h3>

900

<pre class="programlisting">struct gnutls_privkey_st;</pre>

901

902

903

</div>

904

<hr>

905

906

<a name="gnutls-privkey-t"></a><h3>gnutls_privkey_t</h3>

907

<pre class="programlisting">typedef struct gnutls_privkey_st *gnutls_privkey_t;

908

</pre>

909

910

911

</div>

912

<hr>

913

914

<a name="gnutls-privkey-init"></a><h3>gnutls_privkey_init ()</h3>

915

<pre class="programlisting">int gnutls_privkey_init (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> *key</code>);</pre>

916

917

This function will initialize an private key structure.

918

919

920

921

<tbody>

922

<tr>

923

924

<td>The structure to be initialized</td>

925

</tr>

926

<tr>

927

<td>Returns :</td>

928

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

929

negative error value.</td>

930

</tr>

931

</tbody>

932

</table></div>

933

Since 2.12.0

934

</div>

935

<hr>

936

937

<a name="gnutls-privkey-deinit"></a><h3>gnutls_privkey_deinit ()</h3>

938

<pre class="programlisting">void gnutls_privkey_deinit (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>);</pre>

939

940

This function will deinitialize a private key structure.

941

942

943

944

945

946

<td>The structure to be deinitialized</td>

947

</tr></tbody>

948

</table></div>

949

Since 2.12.0

950

</div>

951

<hr>

952

953

<a name="gnutls-privkey-get-pk-algorithm"></a><h3>gnutls_privkey_get_pk_algorithm ()</h3>

954

<pre class="programlisting">int gnutls_privkey_get_pk_algorithm (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>,

955

<code>unsigned int *bits</code>);</pre>

956

957

This function will return the public key algorithm of a private

958

key and if possible will return a number of bits that indicates

959

the security parameter of the key.

960

961

962

963

<tbody>

964

<tr>

965

966

<td>should contain a <a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> structure</td>

967

</tr>

968

<tr>

969

970

<td>If set will return the number of bits of the parameters (may be NULL)</td>

971

</tr>

972

<tr>

973

<td>Returns :</td>

974

<td>a member of the <a class="link" href="gnutls-gnutls.html#gnutls-pk-algorithm-t" title="enum gnutls_pk_algorithm_t">gnutls_pk_algorithm_t</a> enumeration on

975

success, or a negative error code on error.</td>

976

</tr>

977

</tbody>

978

</table></div>

979

Since 2.12.0

980

</div>

981

<hr>

982

983

<a name="gnutls-privkey-get-type"></a><h3>gnutls_privkey_get_type ()</h3>

984

<pre class="programlisting"><a class="link" href="gnutls-gnutls.html#gnutls-privkey-type-t" title="enum gnutls_privkey_type_t">gnutls_privkey_type_t</a> gnutls_privkey_get_type (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>);</pre>

985

986

This function will return the type of the private key. This is

987

actually the type of the subsystem used to set this private key.

988

989

990

991

<tbody>

992

<tr>

993

994

<td>should contain a <a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> structure</td>

995

</tr>

996

<tr>

997

<td>Returns :</td>

998

<td>a member of the <a class="link" href="gnutls-gnutls.html#gnutls-privkey-type-t" title="enum gnutls_privkey_type_t">gnutls_privkey_type_t</a> enumeration on

999

success, or a negative error code on error.</td>

1000

</tr>

1001

</tbody>

1002

</table></div>

1003

Since 2.12.0

1004

</div>

1005

<hr>

1006

1007

<a name="GNUTLS-PRIVKEY-IMPORT-AUTO-RELEASE:CAPS"></a><h3>GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE</h3>

1008

<pre class="programlisting">#define GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE (1<<0)

1009

</pre>

1010

1011

1012

</div>

1013

<hr>

1014

1015

<a name="gnutls-privkey-import-pkcs11"></a><h3>gnutls_privkey_import_pkcs11 ()</h3>

1016

<pre class="programlisting">int gnutls_privkey_import_pkcs11 (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> pkey</code>,

1017

<code><a class="link" href="gnutls-gnutls.html#gnutls-pkcs11-privkey-t" title="gnutls_pkcs11_privkey_t">gnutls_pkcs11_privkey_t</a> key</code>,

1018

<code>unsigned int flags</code>);</pre>

1019

1020

This function will import the given private key to the abstract

1021

<a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> structure.

1022

1023

1024

The <a class="link" href="gnutls-gnutls.html#gnutls-pkcs11-privkey-t" title="gnutls_pkcs11_privkey_t">gnutls_pkcs11_privkey_t</a> object must not be deallocated

1025

during the lifetime of this structure.

1026

1027

1028

<code>flags</code> might be zero or one of <a class="link" href="gnutls-abstract.html#GNUTLS-PRIVKEY-IMPORT-AUTO-RELEASE:CAPS" title="GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE"><code class="literal">GNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE</code></a>

1029

and <code class="literal">GNUTLS_PRIVKEY_IMPORT_COPY</code>.

1030

1031

1032

1033

<tbody>

1034

<tr>

1035

1036

<td>The private key</td>

1037

</tr>

1038

<tr>

1039

1040

<td>The private key to be imported</td>

1041

</tr>

1042

<tr>

1043

<td><code>flags</code> :</td>

1044

<td>Flags for the import</td>

1045

</tr>

1046

<tr>

1047

<td>Returns :</td>

1048

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

1049

negative error value.</td>

1050

</tr>

1051

</tbody>

1052

</table></div>

1053

Since 2.12.0

1054

</div>

1055

<hr>

1056

1057

<a name="gnutls-privkey-import-x509"></a><h3>gnutls_privkey_import_x509 ()</h3>

1058

<pre class="programlisting">int gnutls_privkey_import_x509 (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> pkey</code>,

1059

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-privkey-t" title="gnutls_x509_privkey_t">gnutls_x509_privkey_t</a> key</code>,

1060

<code>unsigned int flags</code>);</pre>

1061

1062

This function will import the given private key to the abstract

1063

<a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> structure.

1064

1065

1066

The <a class="link" href="gnutls-gnutls.html#gnutls-x509-privkey-t" title="gnutls_x509_privkey_t">gnutls_x509_privkey_t</a> object must not be deallocated

1067

during the lifetime of this structure.

1068

1069

1070

1071

and <code class="literal">GNUTLS_PRIVKEY_IMPORT_COPY</code>.

1072

1073

1074

1075

<tbody>

1076

<tr>

1077

1078

<td>The private key</td>

1079

</tr>

1080

<tr>

1081

1082

<td>The private key to be imported</td>

1083

</tr>

1084

<tr>

1085

<td><code>flags</code> :</td>

1086

<td>Flags for the import</td>

1087

</tr>

1088

<tr>

1089

<td>Returns :</td>

1090

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

1091

negative error value.</td>

1092

</tr>

1093

</tbody>

1094

</table></div>

1095

Since 2.12.0

1096

</div>

1097

<hr>

1098

1099

<a name="gnutls-privkey-import-openpgp"></a><h3>gnutls_privkey_import_openpgp ()</h3>

1100

<pre class="programlisting">int gnutls_privkey_import_openpgp (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> pkey</code>,

1101

<code><a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> key</code>,

1102

<code>unsigned int flags</code>);</pre>

1103

1104

This function will import the given private key to the abstract

1105

<a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> structure.

1106

1107

1108

The <a class="link" href="gnutls-gnutls.html#gnutls-openpgp-privkey-t" title="gnutls_openpgp_privkey_t">gnutls_openpgp_privkey_t</a> object must not be deallocated

1109

during the lifetime of this structure. The subkey set as

1110

preferred will be used, or the master key otherwise.

1111

1112

1113

1114

and <code class="literal">GNUTLS_PRIVKEY_IMPORT_COPY</code>.

1115

1116

1117

1118

<tbody>

1119

<tr>

1120

1121

<td>The private key</td>

1122

</tr>

1123

<tr>

1124

1125

<td>The private key to be imported</td>

1126

</tr>

1127

<tr>

1128

<td><code>flags</code> :</td>

1129

<td>Flags for the import</td>

1130

</tr>

1131

<tr>

1132

<td>Returns :</td>

1133

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

1134

negative error value.</td>

1135

</tr>

1136

</tbody>

1137

</table></div>

1138

Since 2.12.0

1139

</div>

1140

<hr>

1141

1142

<a name="gnutls-privkey-sign-data"></a><h3>gnutls_privkey_sign_data ()</h3>

1143

<pre class="programlisting">int gnutls_privkey_sign_data (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> signer</code>,

1144

1145

<code>unsigned int flags</code>,

1146

<code>const gnutls_datum_t *data</code>,

1147

<code>gnutls_datum_t *signature</code>);</pre>

1148

1149

This function will sign the given data using a signature algorithm

1150

supported by the private key. Signature algorithms are always used

1151

together with a hash functions. Different hash functions may be

1152

used for the RSA algorithm, but only the SHA family for the DSA keys.

1153

1154

1155

Use <a class="link" href="gnutls-abstract.html#gnutls-pubkey-get-preferred-hash-algorithm" title="gnutls_pubkey_get_preferred_hash_algorithm ()"><code class="function">gnutls_pubkey_get_preferred_hash_algorithm()</code></a> to determine

1156

the hash algorithm.

1157

1158

1159

1160

<tbody>

1161

<tr>

1162

<td><code>signer</code> :</td>

1163

<td>Holds the key</td>

1164

</tr>

1165

<tr>

1166

1167

<td>should be a digest algorithm</td>

1168

</tr>

1169

<tr>

1170

<td><code>flags</code> :</td>

1171

<td>should be 0 for now</td>

1172

</tr>

1173

<tr>

1174

1175

<td>holds the data to be signed</td>

1176

</tr>

1177

<tr>

1178

<td><code>signature</code> :</td>

1179

<td>will contain the signature allocate with <a class="link" href="gnutls-gnutls.html#gnutls-malloc" title="gnutls_malloc"><code class="function">gnutls_malloc()</code></a>

1180

</td>

1181

</tr>

1182

<tr>

1183

<td>Returns :</td>

1184

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

1185

negative error value.</td>

1186

</tr>

1187

</tbody>

1188

</table></div>

1189

Since 2.12.0

1190

</div>

1191

<hr>

1192

1193

<a name="gnutls-privkey-sign-hash"></a><h3>gnutls_privkey_sign_hash ()</h3>

1194

<pre class="programlisting">int gnutls_privkey_sign_hash (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> signer</code>,

1195

1196

<code>unsigned int flags</code>,

1197

<code>const gnutls_datum_t *hash_data</code>,

1198

<code>gnutls_datum_t *signature</code>);</pre>

1199

1200

This function will sign the given hashed data using a signature algorithm

1201

supported by the private key. Signature algorithms are always used

1202

together with a hash functions. Different hash functions may be

1203

used for the RSA algorithm, but only SHA-XXX for the DSA keys.

1204

1205

1206

1207

the hash algorithm.

1208

1209

1210

1211

<tbody>

1212

<tr>

1213

<td><code>signer</code> :</td>

1214

<td>Holds the signer's key</td>

1215

</tr>

1216

<tr>

1217

1218

<td>The hash algorithm used</td>

1219

</tr>

1220

<tr>

1221

<td><code>flags</code> :</td>

1222

1223

</tr>

1224

<tr>

1225

1226

<td>holds the data to be signed</td>

1227

</tr>

1228

<tr>

1229

<td><code>signature</code> :</td>

1230

<td>will contain newly allocated signature</td>

1231

</tr>

1232

<tr>

1233

<td>Returns :</td>

1234

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

1235

negative error value.</td>

1236

</tr>

1237

</tbody>

1238

</table></div>

1239

Since 2.12.0

1240

</div>

1241

<hr>

1242

1243

<a name="gnutls-privkey-decrypt-data"></a><h3>gnutls_privkey_decrypt_data ()</h3>

1244

<pre class="programlisting">int gnutls_privkey_decrypt_data (<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>,

1245

<code>unsigned int flags</code>,

1246

<code>const gnutls_datum_t *ciphertext</code>,

1247

<code>gnutls_datum_t *plaintext</code>);</pre>

1248

1249

This function will decrypt the given data using the algorithm

1250

supported by the private key.

1251

1252

1253

1254

<tbody>

1255

<tr>

1256

1257

<td>Holds the key</td>

1258

</tr>

1259

<tr>

1260

<td><code>flags</code> :</td>

1261

1262

</tr>

1263

<tr>

1264

<td><code>ciphertext</code> :</td>

1265

<td>holds the data to be decrypted</td>

1266

</tr>

1267

<tr>

1268

<td><code>plaintext</code> :</td>

1269

<td>will contain the decrypted data, allocated with <a class="link" href="gnutls-gnutls.html#gnutls-malloc" title="gnutls_malloc"><code class="function">gnutls_malloc()</code></a>

1270

</td>

1271

</tr>

1272

<tr>

1273

<td>Returns :</td>

1274

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

1275

negative error value.</td>

1276

</tr>

1277

</tbody>

1278

</table></div>

1279

Since 2.12.0

1280

</div>

1281

<hr>

1282

1283

<a name="gnutls-x509-crt-privkey-sign"></a><h3>gnutls_x509_crt_privkey_sign ()</h3>

1284

<pre class="programlisting">int gnutls_x509_crt_privkey_sign (<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> crt</code>,

1285

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> issuer</code>,

1286

<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> issuer_key</code>,

1287

1288

<code>unsigned int flags</code>);</pre>

1289

1290

This function will sign the certificate with the issuer's private key, and

1291

will copy the issuer's information into the certificate.

1292

1293

1294

This must be the last step in a certificate generation since all

1295

the previously set parameters are now signed.

1296

1297

1298

1299

<tbody>

1300

<tr>

1301

1302

<td>a certificate of type <a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a>

1303

</td>

1304

</tr>

1305

<tr>

1306

<td><code>issuer</code> :</td>

1307

<td>is the certificate of the certificate issuer</td>

1308

</tr>

1309

<tr>

1310

<td><code>issuer_key</code> :</td>

1311

<td>holds the issuer's private key</td>

1312

</tr>

1313

<tr>

1314

1315

<td>The message digest to use, <a class="link" href="gnutls-gnutls.html#GNUTLS-DIG-SHA1:CAPS"><code class="literal">GNUTLS_DIG_SHA1</code></a> is a safe choice</td>

1316

</tr>

1317

<tr>

1318

<td><code>flags</code> :</td>

1319

1320

</tr>

1321

<tr>

1322

<td>Returns :</td>

1323

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

1324

negative error value.</td>

1325

</tr>

1326

</tbody>

1327

</table></div>

1328

</div>

1329

<hr>

1330

1331

<a name="gnutls-x509-crl-privkey-sign"></a><h3>gnutls_x509_crl_privkey_sign ()</h3>

1332

<pre class="programlisting">int gnutls_x509_crl_privkey_sign (<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crl-t" title="gnutls_x509_crl_t">gnutls_x509_crl_t</a> crl</code>,

1333

<code><a class="link" href="gnutls-gnutls.html#gnutls-x509-crt-t" title="gnutls_x509_crt_t">gnutls_x509_crt_t</a> issuer</code>,

1334

<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> issuer_key</code>,

1335

1336

<code>unsigned int flags</code>);</pre>

1337

1338

This function will sign the CRL with the issuer's private key, and

1339

will copy the issuer's information into the CRL.

1340

1341

1342

This must be the last step in a certificate CRL since all

1343

the previously set parameters are now signed.

1344

1345

1346

1347

<tbody>

1348

<tr>

1349

1350

<td>should contain a gnutls_x509_crl_t structure</td>

1351

</tr>

1352

<tr>

1353

<td><code>issuer</code> :</td>

1354

<td>is the certificate of the certificate issuer</td>

1355

</tr>

1356

<tr>

1357

<td><code>issuer_key</code> :</td>

1358

<td>holds the issuer's private key</td>

1359

</tr>

1360

<tr>

1361

1362

<td>The message digest to use. GNUTLS_DIG_SHA1 is the safe choice unless you know what you're doing.</td>

1363

</tr>

1364

<tr>

1365

<td><code>flags</code> :</td>

1366

1367

</tr>

1368

<tr>

1369

<td>Returns :</td>

1370

<td>On success, <a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> (0) is returned, otherwise a

1371

negative error value.

1372

Since 2.12.0</td>

1373

</tr>

1374

</tbody>

1375

</table></div>

1376

</div>

1377

<hr>

1378

1379

<a name="gnutls-x509-crq-privkey-sign"></a><h3>gnutls_x509_crq_privkey_sign ()</h3>

1380

<pre class="programlisting">int gnutls_x509_crq_privkey_sign (<code><a class="link" href="gnutls-x509.html#gnutls-x509-crq-t" title="gnutls_x509_crq_t">gnutls_x509_crq_t</a> crq</code>,

1381

<code><a class="link" href="gnutls-abstract.html#gnutls-privkey-t" title="gnutls_privkey_t">gnutls_privkey_t</a> key</code>,

1382

1383

<code>unsigned int flags</code>);</pre>

1384

1385

This function will sign the certificate request with a private key.

1386

This must be the same key as the one used in

1387

<a class="link" href="gnutls-x509.html#gnutls-x509-crt-set-key" title="gnutls_x509_crt_set_key ()"><code class="function">gnutls_x509_crt_set_key()</code></a> since a certificate request is self

1388

signed.

1389

1390

1391

This must be the last step in a certificate request generation

1392

since all the previously set parameters are now signed.

1393

1394

1395

1396

<tbody>

1397

<tr>

1398

1399

<td>should contain a <a class="link" href="gnutls-x509.html#gnutls-x509-crq-t" title="gnutls_x509_crq_t">gnutls_x509_crq_t</a> structure</td>

1400

</tr>

1401

<tr>

1402

1403

<td>holds a private key</td>

1404

</tr>

1405

<tr>

1406

1407

<td>The message digest to use, i.e., <a class="link" href="gnutls-gnutls.html#GNUTLS-DIG-SHA1:CAPS"><code class="literal">GNUTLS_DIG_SHA1</code></a>

1408

</td>

1409

</tr>

1410

<tr>

1411

<td><code>flags</code> :</td>

1412

1413

</tr>

1414

<tr>

1415

<td>Returns :</td>

1416

<td>

1417

<a class="link" href="gnutls-gnutls.html#GNUTLS-E-SUCCESS:CAPS" title="GNUTLS_E_SUCCESS"><code class="literal">GNUTLS_E_SUCCESS</code></a> on success, otherwise a negative error code.

1418

<a class="link" href="gnutls-gnutls.html#GNUTLS-E-ASN1-VALUE-NOT-FOUND:CAPS" title="GNUTLS_E_ASN1_VALUE_NOT_FOUND"><code class="literal">GNUTLS_E_ASN1_VALUE_NOT_FOUND</code></a> is returned if you didn't set all

1419

information in the certificate request (e.g., the version using

1420

<a class="link" href="gnutls-x509.html#gnutls-x509-crq-set-version" title="gnutls_x509_crq_set_version ()"><code class="function">gnutls_x509_crq_set_version()</code></a>).</td>

1421

</tr>

1422

</tbody>

1423

</table></div>

1424

Since 2.12.0

1425

</div>

1426

</div>

1427

</div>

1428

1429

<hr>

1430

Generated by GTK-Doc V1.17</div>

1431

</body>

1432

</html>

b'\\ No newline at end of file'

Older »