1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is last updated 19 January 2015 for version
3.4.9 of GnuTLS.
Copyright (C) 2001-2012, 2014 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GnuTLS-Guile 3.4.9: Guile Reference</title>
<meta name="description" content="GnuTLS-Guile 3.4.9: Guile Reference">
<meta name="keywords" content="GnuTLS-Guile 3.4.9: Guile Reference">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Procedure-Index.html#Procedure-Index" rel="index" title="Procedure Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
<link href="Copying-Information.html#Copying-Information" rel="next" title="Copying Information">
<link href="Importing-OpenPGP-Keys-Guile-Example.html#Importing-OpenPGP-Keys-Guile-Example" rel="prev" title="Importing OpenPGP Keys Guile Example">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
body {
margin: 2%;
padding: 0 5%;
background: #ffffff;
}
h1,h2,h3,h4,h5 {
font-weight: bold;
padding: 5px 5px 5px 5px;
background-color: #c2e0ff;
color: #336699;
}
h1 {
padding: 2em 2em 2em 5%;
color: white;
background: #336699;
text-align: center;
letter-spacing: 3px;
}
h2 { text-decoration: underline; }
pre {
margin: 0 5%;
padding: 0.5em;
}
pre.example,pre.verbatim {
padding-bottom: 1em;
border: solid #c2e0ff;
background: #f0faff;
border-width: 1px 1px 1px 5px;
margin: 1em auto;
width: 90%;
}
div.node {
margin: 0 -5% 0 -2%;
padding: 0.5em 0.5em;
margin-top: 0.5em;
margin-bottom: 0.5em;
font-weight: bold;
}
dd, li {
padding-top: 0.1em;
padding-bottom: 0.1em;
}
div.float {
margin-bottom: 0.5em;
text-align: center;
}
table {
text-align: left;
margin-left:auto;
margin-right:auto;
border-spacing: 7px;
width: 50%;
}
th {
padding: 0;
color: #336699;
background-color: #c2e0ff;
border: solid #000000;
border-width: 0px;
margin: 1em auto;
text-align: center;
margin-left:auto;
margin-right:auto;
}
td {
padding: 0;
border: solid #000000;
background-color: #f0faff;
border-width: 0px;
margin: 1em auto;
text-align: left;
margin-left:auto;
margin-right:auto;
padding-left: 1em;
}
dl {
text-align: left;
margin-left:auto;
margin-right:auto;
width: 50%;
padding-left: 1em;
border: solid #c2e0ff;
background: #f0faff;
border-width: 5px 1px 1px 1px;
margin: 1em auto;
}
-->
</style>
</head>
<body lang="en">
<a name="Guile-Reference"></a>
<div class="header">
<p>
Next: <a href="Copying-Information.html#Copying-Information" accesskey="n" rel="next">Copying Information</a>, Previous: <a href="Guile-Examples.html#Guile-Examples" accesskey="p" rel="prev">Guile Examples</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Procedure-Index.html#Procedure-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Guile-Reference-1"></a>
<h2 class="chapter">5 Guile Reference</h2>
<p>This chapter lists the GnuTLS Scheme procedures exported by the
<code>(gnutls)</code> module (see <a href="http://www.gnu.org/software/guile/manual/html_node/The-Guile-module-system.html#The-Guile-module-system">The Guile module system</a> in <cite>The
GNU Guile Reference Manual</cite>).
</p>
<dl>
<dt><a name="index-set_002dlog_002dlevel_0021"></a>Scheme Procedure: <strong>set-log-level!</strong> <em>level</em></dt>
<dd><p>Enable GnuTLS logging up to <var>level</var> (an integer).
</p></dd></dl>
<dl>
<dt><a name="index-set_002dlog_002dprocedure_0021"></a>Scheme Procedure: <strong>set-log-procedure!</strong> <em>proc</em></dt>
<dd><p>Use <var>proc</var> (a two-argument procedure) as the global GnuTLS log procedure.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dopenpgp_002dkeys_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-openpgp-keys!</strong> <em>cred pub sec</em></dt>
<dd><p>Use certificate <var>pub</var> and secret key <var>sec</var> in certificate credentials <var>cred</var>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dkeyring_002dcontains_002dkey_002did_003f"></a>Scheme Procedure: <strong>openpgp-keyring-contains-key-id?</strong> <em>keyring id</em></dt>
<dd><p>Return <code>#f</code> if key ID <var>id</var> is in <var>keyring</var>, <code>#f</code> otherwise.
</p></dd></dl>
<dl>
<dt><a name="index-import_002dopenpgp_002dkeyring"></a>Scheme Procedure: <strong>import-openpgp-keyring</strong> <em>data format</em></dt>
<dd><p>Import <var>data</var> (a u8vector) according to <var>format</var> and return the imported keyring.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002dusage"></a>Scheme Procedure: <strong>openpgp-certificate-usage</strong> <em>key</em></dt>
<dd><p>Return a list of values denoting the key usage of <var>key</var>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002dversion"></a>Scheme Procedure: <strong>openpgp-certificate-version</strong> <em>key</em></dt>
<dd><p>Return the version of the OpenPGP message format (RFC2440) honored by <var>key</var>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002dalgorithm"></a>Scheme Procedure: <strong>openpgp-certificate-algorithm</strong> <em>key</em></dt>
<dd><p>Return two values: the certificate algorithm used by <var>key</var> and the number of bits used.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002dnames"></a>Scheme Procedure: <strong>openpgp-certificate-names</strong> <em>key</em></dt>
<dd><p>Return the list of names for <var>key</var>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002dname"></a>Scheme Procedure: <strong>openpgp-certificate-name</strong> <em>key index</em></dt>
<dd><p>Return the <var>index</var>th name of <var>key</var>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002dfingerprint"></a>Scheme Procedure: <strong>openpgp-certificate-fingerprint</strong> <em>key</em></dt>
<dd><p>Return a new u8vector denoting the fingerprint of <var>key</var>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002dfingerprint_0021"></a>Scheme Procedure: <strong>openpgp-certificate-fingerprint!</strong> <em>key fpr</em></dt>
<dd><p>Store in <var>fpr</var> (a u8vector) the fingerprint of <var>key</var>. Return the number of bytes stored in <var>fpr</var>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002did_0021"></a>Scheme Procedure: <strong>openpgp-certificate-id!</strong> <em>key id</em></dt>
<dd><p>Store the ID (an 8 byte sequence) of certificate <var>key</var> in <var>id</var> (a u8vector).
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002did"></a>Scheme Procedure: <strong>openpgp-certificate-id</strong> <em>key</em></dt>
<dd><p>Return the ID (an 8-element u8vector) of certificate <var>key</var>.
</p></dd></dl>
<dl>
<dt><a name="index-import_002dopenpgp_002dprivate_002dkey"></a>Scheme Procedure: <strong>import-openpgp-private-key</strong> <em>data format [pass]</em></dt>
<dd><p>Return a new OpenPGP private key object resulting from the import of <var>data</var> (a uniform array) according to <var>format</var>. Optionally, a passphrase may be provided.
</p></dd></dl>
<dl>
<dt><a name="index-import_002dopenpgp_002dcertificate"></a>Scheme Procedure: <strong>import-openpgp-certificate</strong> <em>data format</em></dt>
<dd><p>Return a new OpenPGP certificate object resulting from the import of <var>data</var> (a uniform array) according to <var>format</var>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dsubject_002dalternative_002dname"></a>Scheme Procedure: <strong>x509-certificate-subject-alternative-name</strong> <em>cert index</em></dt>
<dd><p>Return two values: the alternative name type for <var>cert</var> (i.e., one of the <code>x509-subject-alternative-name/</code> values) and the actual subject alternative name (a string) at <var>index</var>. Both values are <code>#f</code> if no alternative name is available at <var>index</var>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dsubject_002dkey_002did"></a>Scheme Procedure: <strong>x509-certificate-subject-key-id</strong> <em>cert</em></dt>
<dd><p>Return the subject key ID (a u8vector) for <var>cert</var>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dauthority_002dkey_002did"></a>Scheme Procedure: <strong>x509-certificate-authority-key-id</strong> <em>cert</em></dt>
<dd><p>Return the key ID (a u8vector) of the X.509 certificate authority of <var>cert</var>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dkey_002did"></a>Scheme Procedure: <strong>x509-certificate-key-id</strong> <em>cert</em></dt>
<dd><p>Return a statistically unique ID (a u8vector) for <var>cert</var> that depends on its public key parameters. This is normally a 20-byte SHA-1 hash.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dversion"></a>Scheme Procedure: <strong>x509-certificate-version</strong> <em>cert</em></dt>
<dd><p>Return the version of <var>cert</var>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dkey_002dusage"></a>Scheme Procedure: <strong>x509-certificate-key-usage</strong> <em>cert</em></dt>
<dd><p>Return the key usage of <var>cert</var> (i.e., a list of <code>key-usage/</code> values), or the empty list if <var>cert</var> does not contain such information.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dpublic_002dkey_002dalgorithm"></a>Scheme Procedure: <strong>x509-certificate-public-key-algorithm</strong> <em>cert</em></dt>
<dd><p>Return two values: the public key algorithm (i.e., one of the <code>pk-algorithm/</code> values) of <var>cert</var> and the number of bits used.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dsignature_002dalgorithm"></a>Scheme Procedure: <strong>x509-certificate-signature-algorithm</strong> <em>cert</em></dt>
<dd><p>Return the signature algorithm used by <var>cert</var> (i.e., one of the <code>sign-algorithm/</code> values).
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dmatches_002dhostname_003f"></a>Scheme Procedure: <strong>x509-certificate-matches-hostname?</strong> <em>cert hostname</em></dt>
<dd><p>Return true if <var>cert</var> matches <var>hostname</var>, a string denoting a DNS host name. This is the basic implementation of <a href="http://tools.ietf.org/html/rfc2818">RFC 2818</a> (aka. HTTPS).
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dissuer_002ddn_002doid"></a>Scheme Procedure: <strong>x509-certificate-issuer-dn-oid</strong> <em>cert index</em></dt>
<dd><p>Return the OID (a string) at <var>index</var> from <var>cert</var>’s issuer DN. Return <code>#f</code> if no OID is available at <var>index</var>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002ddn_002doid"></a>Scheme Procedure: <strong>x509-certificate-dn-oid</strong> <em>cert index</em></dt>
<dd><p>Return OID (a string) at <var>index</var> from <var>cert</var>. Return <code>#f</code> if no OID is available at <var>index</var>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dissuer_002ddn"></a>Scheme Procedure: <strong>x509-certificate-issuer-dn</strong> <em>cert</em></dt>
<dd><p>Return the distinguished name (DN) of X.509 certificate <var>cert</var>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002ddn"></a>Scheme Procedure: <strong>x509-certificate-dn</strong> <em>cert</em></dt>
<dd><p>Return the distinguished name (DN) of X.509 certificate <var>cert</var>. The form of the DN is as described in <a href="http://tools.ietf.org/html/rfc2253">RFC 2253</a>.
</p></dd></dl>
<dl>
<dt><a name="index-pkcs8_002dimport_002dx509_002dprivate_002dkey"></a>Scheme Procedure: <strong>pkcs8-import-x509-private-key</strong> <em>data format [pass [encrypted]]</em></dt>
<dd><p>Return a new X.509 private key object resulting from the import of <var>data</var> (a uniform array) according to <var>format</var>. Optionally, if <var>pass</var> is not <code>#f</code>, it should be a string denoting a passphrase. <var>encrypted</var> tells whether the private key is encrypted (<code>#t</code> by default).
</p></dd></dl>
<dl>
<dt><a name="index-import_002dx509_002dprivate_002dkey"></a>Scheme Procedure: <strong>import-x509-private-key</strong> <em>data format</em></dt>
<dd><p>Return a new X.509 private key object resulting from the import of <var>data</var> (a uniform array) according to <var>format</var>.
</p></dd></dl>
<dl>
<dt><a name="index-import_002dx509_002dcertificate"></a>Scheme Procedure: <strong>import-x509-certificate</strong> <em>data format</em></dt>
<dd><p>Return a new X.509 certificate object resulting from the import of <var>data</var> (a uniform array) according to <var>format</var>.
</p></dd></dl>
<dl>
<dt><a name="index-server_002dsession_002dpsk_002dusername"></a>Scheme Procedure: <strong>server-session-psk-username</strong> <em>session</em></dt>
<dd><p>Return the username associated with PSK server session <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dpsk_002dclient_002dcredentials_0021"></a>Scheme Procedure: <strong>set-psk-client-credentials!</strong> <em>cred username key key-format</em></dt>
<dd><p>Set the client credentials for <var>cred</var>, a PSK client credentials object.
</p></dd></dl>
<dl>
<dt><a name="index-make_002dpsk_002dclient_002dcredentials"></a>Scheme Procedure: <strong>make-psk-client-credentials</strong></dt>
<dd><p>Return a new PSK client credentials object.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dpsk_002dserver_002dcredentials_002dfile_0021"></a>Scheme Procedure: <strong>set-psk-server-credentials-file!</strong> <em>cred file</em></dt>
<dd><p>Use <var>file</var> as the password file for PSK server credentials <var>cred</var>.
</p></dd></dl>
<dl>
<dt><a name="index-make_002dpsk_002dserver_002dcredentials"></a>Scheme Procedure: <strong>make-psk-server-credentials</strong></dt>
<dd><p>Return new PSK server credentials.
</p></dd></dl>
<dl>
<dt><a name="index-peer_002dcertificate_002dstatus"></a>Scheme Procedure: <strong>peer-certificate-status</strong> <em>session</em></dt>
<dd><p>Verify the peer certificate for <var>session</var> and return a list of <code>certificate-status</code> values (such as <code>certificate-status/revoked</code>), or the empty list if the certificate is valid.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dverify_002dflags_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-verify-flags!</strong> <em>cred [flags...]</em></dt>
<dd><p>Set the certificate verification flags to <var>flags</var>, a series of <code>certificate-verify</code> values.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dverify_002dlimits_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-verify-limits!</strong> <em>cred max-bits max-depth</em></dt>
<dd><p>Set the verification limits of <code>peer-certificate-status</code> for certificate credentials <var>cred</var> to <var>max_bits</var> bits for an acceptable certificate and <var>max_depth</var> as the maximum depth of a certificate chain.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dx509_002dkeys_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-x509-keys!</strong> <em>cred certs privkey</em></dt>
<dd><p>Have certificate credentials <var>cred</var> use the X.509 certificates listed in <var>certs</var> and X.509 private key <var>privkey</var>.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dx509_002dkey_002ddata_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-x509-key-data!</strong> <em>cred cert key format</em></dt>
<dd><p>Use X.509 certificate <var>cert</var> and private key <var>key</var>, both uniform arrays containing the X.509 certificate and key in format <var>format</var>, for certificate credentials <var>cred</var>.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dx509_002dcrl_002ddata_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-x509-crl-data!</strong> <em>cred data format</em></dt>
<dd><p>Use <var>data</var> (a uniform array) as the X.509 CRL (certificate revocation list) database for <var>cred</var>. On success, return the number of CRLs processed.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dx509_002dtrust_002ddata_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-x509-trust-data!</strong> <em>cred data format</em></dt>
<dd><p>Use <var>data</var> (a uniform array) as the X.509 trust database for <var>cred</var>. On success, return the number of certificates processed.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dx509_002dcrl_002dfile_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-x509-crl-file!</strong> <em>cred file format</em></dt>
<dd><p>Use <var>file</var> as the X.509 CRL (certificate revocation list) file for certificate credentials <var>cred</var>. On success, return the number of CRLs processed.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dx509_002dtrust_002dfile_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-x509-trust-file!</strong> <em>cred file format</em></dt>
<dd><p>Use <var>file</var> as the X.509 trust file for certificate credentials <var>cred</var>. On success, return the number of certificates processed.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002dx509_002dkey_002dfiles_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-x509-key-files!</strong> <em>cred cert-file key-file format</em></dt>
<dd><p>Use <var>file</var> as the password file for PSK server credentials <var>cred</var>.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dcertificate_002dcredentials_002ddh_002dparameters_0021"></a>Scheme Procedure: <strong>set-certificate-credentials-dh-parameters!</strong> <em>cred dh-params</em></dt>
<dd><p>Use Diffie-Hellman parameters <var>dh_params</var> for certificate credentials <var>cred</var>.
</p></dd></dl>
<dl>
<dt><a name="index-make_002dcertificate_002dcredentials"></a>Scheme Procedure: <strong>make-certificate-credentials</strong></dt>
<dd><p>Return new certificate credentials (i.e., for use with either X.509 or OpenPGP certificates.
</p></dd></dl>
<dl>
<dt><a name="index-set_002danonymous_002dserver_002ddh_002dparameters_0021"></a>Scheme Procedure: <strong>set-anonymous-server-dh-parameters!</strong> <em>cred dh-params</em></dt>
<dd><p>Set the Diffie-Hellman parameters of anonymous server credentials <var>cred</var>.
</p></dd></dl>
<dl>
<dt><a name="index-make_002danonymous_002dclient_002dcredentials"></a>Scheme Procedure: <strong>make-anonymous-client-credentials</strong></dt>
<dd><p>Return anonymous client credentials.
</p></dd></dl>
<dl>
<dt><a name="index-make_002danonymous_002dserver_002dcredentials"></a>Scheme Procedure: <strong>make-anonymous-server-credentials</strong></dt>
<dd><p>Return anonymous server credentials.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dsession_002ddh_002dprime_002dbits_0021"></a>Scheme Procedure: <strong>set-session-dh-prime-bits!</strong> <em>session bits</em></dt>
<dd><p>Use <var>bits</var> DH prime bits for <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-pkcs3_002dexport_002ddh_002dparameters-1"></a>Scheme Procedure: <strong>pkcs3-export-dh-parameters</strong> <em>dh-params format</em></dt>
<dd><p>Export Diffie-Hellman parameters <var>dh_params</var> in PKCS3 format according for <var>format</var> (an <code>x509-certificate-format</code> value). Return a <code>u8vector</code> containing the result.
</p></dd></dl>
<dl>
<dt><a name="index-pkcs3_002dimport_002ddh_002dparameters"></a>Scheme Procedure: <strong>pkcs3-import-dh-parameters</strong> <em>array format</em></dt>
<dd><p>Import Diffie-Hellman parameters in PKCS3 format (further specified by <var>format</var>, an <code>x509-certificate-format</code> value) from <var>array</var> (a homogeneous array) and return a new <code>dh-params</code> object.
</p></dd></dl>
<dl>
<dt><a name="index-make_002ddh_002dparameters-1"></a>Scheme Procedure: <strong>make-dh-parameters</strong> <em>bits</em></dt>
<dd><p>Return new Diffie-Hellman parameters.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dsession_002dtransport_002dport_0021-1"></a>Scheme Procedure: <strong>set-session-transport-port!</strong> <em>session port</em></dt>
<dd><p>Use <var>port</var> as the input/output port for <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dsession_002dtransport_002dfd_0021-1"></a>Scheme Procedure: <strong>set-session-transport-fd!</strong> <em>session fd</em></dt>
<dd><p>Use file descriptor <var>fd</var> as the underlying transport for <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-session_002drecord_002dport-1"></a>Scheme Procedure: <strong>session-record-port</strong> <em>session</em></dt>
<dd><p>Return a read-write port that may be used to communicate over <var>session</var>. All invocations of <code>session-port</code> on a given session return the same object (in the sense of <code>eq?</code>).
</p></dd></dl>
<dl>
<dt><a name="index-record_002dreceive_0021-1"></a>Scheme Procedure: <strong>record-receive!</strong> <em>session array</em></dt>
<dd><p>Receive data from <var>session</var> into <var>array</var>, a uniform homogeneous array. Return the number of bytes actually received.
</p></dd></dl>
<dl>
<dt><a name="index-record_002dsend-1"></a>Scheme Procedure: <strong>record-send</strong> <em>session array</em></dt>
<dd><p>Send the record constituted by <var>array</var> through <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dsession_002dserver_002dname_0021"></a>Scheme Procedure: <strong>set-session-server-name!</strong> <em>session type name</em></dt>
<dd><p>For a client, this procedure provides a way to inform the server that it is known under <var>name</var>, <i>via</i> the <code>SERVER NAME</code> TLS extension. <var>type</var> must be a <code>server-name-type</code> value, <var>server-name-type/dns</var> for DNS names.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dsession_002dcredentials_0021"></a>Scheme Procedure: <strong>set-session-credentials!</strong> <em>session cred</em></dt>
<dd><p>Use <var>cred</var> as <var>session</var>’s credentials.
</p></dd></dl>
<dl>
<dt><a name="index-cipher_002dsuite_002d_003estring"></a>Scheme Procedure: <strong>cipher-suite->string</strong> <em>kx cipher mac</em></dt>
<dd><p>Return the name of the given cipher suite.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dsession_002dpriorities_0021"></a>Scheme Procedure: <strong>set-session-priorities!</strong> <em>session priorities</em></dt>
<dd><p>Have <var>session</var> use the given <var>priorities</var> for the ciphers, key exchange methods, MACs and compression methods. <var>priorities</var> must be a string (see <a href="http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html#Priority-Strings">Priority Strings</a> in <cite>GnuTLS, Transport Layer Security Library for the GNU system</cite>). When <var>priorities</var> cannot be parsed, an <code>error/invalid-request</code> error is raised, with an extra argument indication the position of the error.
</p>
</dd></dl>
<dl>
<dt><a name="index-set_002dsession_002ddefault_002dpriority_0021"></a>Scheme Procedure: <strong>set-session-default-priority!</strong> <em>session</em></dt>
<dd><p>Have <var>session</var> use the default priorities.
</p></dd></dl>
<dl>
<dt><a name="index-set_002dserver_002dsession_002dcertificate_002drequest_0021"></a>Scheme Procedure: <strong>set-server-session-certificate-request!</strong> <em>session request</em></dt>
<dd><p>Tell how <var>session</var>, a server-side session, should deal with certificate requests. <var>request</var> should be either <code>certificate-request/request</code> or <code>certificate-request/require</code>.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dour_002dcertificate_002dchain"></a>Scheme Procedure: <strong>session-our-certificate-chain</strong> <em>session</em></dt>
<dd><p>Return our certificate chain for <var>session</var> (as sent to the peer) in raw format (a u8vector). In the case of OpenPGP there is exactly one certificate. Return the empty list if no certificate was used.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dpeer_002dcertificate_002dchain"></a>Scheme Procedure: <strong>session-peer-certificate-chain</strong> <em>session</em></dt>
<dd><p>Return the a list of certificates in raw format (u8vectors) where the first one is the peer’s certificate. In the case of OpenPGP, there is always exactly one certificate. In the case of X.509, subsequent certificates indicate form a certificate chain. Return the empty list if no certificate was sent.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dclient_002dauthentication_002dtype"></a>Scheme Procedure: <strong>session-client-authentication-type</strong> <em>session</em></dt>
<dd><p>Return the client authentication type (a <code>credential-type</code> value) used in <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dserver_002dauthentication_002dtype"></a>Scheme Procedure: <strong>session-server-authentication-type</strong> <em>session</em></dt>
<dd><p>Return the server authentication type (a <code>credential-type</code> value) used in <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dauthentication_002dtype"></a>Scheme Procedure: <strong>session-authentication-type</strong> <em>session</em></dt>
<dd><p>Return the authentication type (a <code>credential-type</code> value) used by <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dprotocol"></a>Scheme Procedure: <strong>session-protocol</strong> <em>session</em></dt>
<dd><p>Return the protocol used by <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dcertificate_002dtype"></a>Scheme Procedure: <strong>session-certificate-type</strong> <em>session</em></dt>
<dd><p>Return <var>session</var>’s certificate type.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dcompression_002dmethod"></a>Scheme Procedure: <strong>session-compression-method</strong> <em>session</em></dt>
<dd><p>Return <var>session</var>’s compression method.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dmac"></a>Scheme Procedure: <strong>session-mac</strong> <em>session</em></dt>
<dd><p>Return <var>session</var>’s MAC.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dkx"></a>Scheme Procedure: <strong>session-kx</strong> <em>session</em></dt>
<dd><p>Return <var>session</var>’s kx.
</p></dd></dl>
<dl>
<dt><a name="index-session_002dcipher-1"></a>Scheme Procedure: <strong>session-cipher</strong> <em>session</em></dt>
<dd><p>Return <var>session</var>’s cipher.
</p></dd></dl>
<dl>
<dt><a name="index-alert_002dsend"></a>Scheme Procedure: <strong>alert-send</strong> <em>session level alert</em></dt>
<dd><p>Send <var>alert</var> via <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-alert_002dget"></a>Scheme Procedure: <strong>alert-get</strong> <em>session</em></dt>
<dd><p>Get an aleter from <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-rehandshake"></a>Scheme Procedure: <strong>rehandshake</strong> <em>session</em></dt>
<dd><p>Perform a re-handshaking for <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-handshake"></a>Scheme Procedure: <strong>handshake</strong> <em>session</em></dt>
<dd><p>Perform a handshake for <var>session</var>.
</p></dd></dl>
<dl>
<dt><a name="index-bye"></a>Scheme Procedure: <strong>bye</strong> <em>session how</em></dt>
<dd><p>Close <var>session</var> according to <var>how</var>.
</p></dd></dl>
<dl>
<dt><a name="index-make_002dsession"></a>Scheme Procedure: <strong>make-session</strong> <em>end</em></dt>
<dd><p>Return a new session for connection end <var>end</var>, either <code>connection-end/server</code> or <code>connection-end/client</code>.
</p></dd></dl>
<dl>
<dt><a name="index-gnutls_002dversion"></a>Scheme Procedure: <strong>gnutls-version</strong></dt>
<dd><p>Return a string denoting the version number of the underlying GnuTLS library, e.g., <code>"1.7.2"</code>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dkeyring_003f"></a>Scheme Procedure: <strong>openpgp-keyring?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>openpgp-keyring</code>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dprivate_002dkey_003f"></a>Scheme Procedure: <strong>openpgp-private-key?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>openpgp-private-key</code>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_003f"></a>Scheme Procedure: <strong>openpgp-certificate?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>openpgp-certificate</code>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dprivate_002dkey_003f"></a>Scheme Procedure: <strong>x509-private-key?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>x509-private-key</code>.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_003f"></a>Scheme Procedure: <strong>x509-certificate?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>x509-certificate</code>.
</p></dd></dl>
<dl>
<dt><a name="index-psk_002dclient_002dcredentials_003f"></a>Scheme Procedure: <strong>psk-client-credentials?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>psk-client-credentials</code>.
</p></dd></dl>
<dl>
<dt><a name="index-psk_002dserver_002dcredentials_003f"></a>Scheme Procedure: <strong>psk-server-credentials?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>psk-server-credentials</code>.
</p></dd></dl>
<dl>
<dt><a name="index-srp_002dclient_002dcredentials_003f"></a>Scheme Procedure: <strong>srp-client-credentials?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>srp-client-credentials</code>.
</p></dd></dl>
<dl>
<dt><a name="index-srp_002dserver_002dcredentials_003f"></a>Scheme Procedure: <strong>srp-server-credentials?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>srp-server-credentials</code>.
</p></dd></dl>
<dl>
<dt><a name="index-certificate_002dcredentials_003f"></a>Scheme Procedure: <strong>certificate-credentials?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>certificate-credentials</code>.
</p></dd></dl>
<dl>
<dt><a name="index-dh_002dparameters_003f"></a>Scheme Procedure: <strong>dh-parameters?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>dh-parameters</code>.
</p></dd></dl>
<dl>
<dt><a name="index-anonymous_002dserver_002dcredentials_003f"></a>Scheme Procedure: <strong>anonymous-server-credentials?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>anonymous-server-credentials</code>.
</p></dd></dl>
<dl>
<dt><a name="index-anonymous_002dclient_002dcredentials_003f"></a>Scheme Procedure: <strong>anonymous-client-credentials?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>anonymous-client-credentials</code>.
</p></dd></dl>
<dl>
<dt><a name="index-session_003f"></a>Scheme Procedure: <strong>session?</strong> <em>obj</em></dt>
<dd><p>Return true if <var>obj</var> is of type <code>session</code>.
</p></dd></dl>
<dl>
<dt><a name="index-openpgp_002dcertificate_002dformat_002d_003estring"></a>Scheme Procedure: <strong>openpgp-certificate-format->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>openpgp-certificate-format</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-error_002d_003estring-1"></a>Scheme Procedure: <strong>error->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>error</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-certificate_002dverify_002d_003estring"></a>Scheme Procedure: <strong>certificate-verify->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>certificate-verify</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-key_002dusage_002d_003estring"></a>Scheme Procedure: <strong>key-usage->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>key-usage</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-psk_002dkey_002dformat_002d_003estring"></a>Scheme Procedure: <strong>psk-key-format->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>psk-key-format</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-server_002dname_002dtype_002d_003estring"></a>Scheme Procedure: <strong>server-name-type->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>server-name-type</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-sign_002dalgorithm_002d_003estring"></a>Scheme Procedure: <strong>sign-algorithm->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>sign-algorithm</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-pk_002dalgorithm_002d_003estring"></a>Scheme Procedure: <strong>pk-algorithm->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>pk-algorithm</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dsubject_002dalternative_002dname_002d_003estring"></a>Scheme Procedure: <strong>x509-subject-alternative-name->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>x509-subject-alternative-name</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-x509_002dcertificate_002dformat_002d_003estring"></a>Scheme Procedure: <strong>x509-certificate-format->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>x509-certificate-format</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-certificate_002dtype_002d_003estring"></a>Scheme Procedure: <strong>certificate-type->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>certificate-type</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-protocol_002d_003estring"></a>Scheme Procedure: <strong>protocol->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>protocol</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-close_002drequest_002d_003estring"></a>Scheme Procedure: <strong>close-request->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>close-request</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-certificate_002drequest_002d_003estring"></a>Scheme Procedure: <strong>certificate-request->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>certificate-request</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-certificate_002dstatus_002d_003estring"></a>Scheme Procedure: <strong>certificate-status->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>certificate-status</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-handshake_002ddescription_002d_003estring"></a>Scheme Procedure: <strong>handshake-description->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>handshake-description</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-alert_002ddescription_002d_003estring"></a>Scheme Procedure: <strong>alert-description->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>alert-description</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-alert_002dlevel_002d_003estring"></a>Scheme Procedure: <strong>alert-level->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>alert-level</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-connection_002dend_002d_003estring"></a>Scheme Procedure: <strong>connection-end->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>connection-end</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-compression_002dmethod_002d_003estring"></a>Scheme Procedure: <strong>compression-method->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>compression-method</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-digest_002d_003estring"></a>Scheme Procedure: <strong>digest->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>digest</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-mac_002d_003estring"></a>Scheme Procedure: <strong>mac->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>mac</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-credentials_002d_003estring"></a>Scheme Procedure: <strong>credentials->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>credentials</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-params_002d_003estring"></a>Scheme Procedure: <strong>params->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>params</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-kx_002d_003estring"></a>Scheme Procedure: <strong>kx->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>kx</code> value.
</p></dd></dl>
<dl>
<dt><a name="index-cipher_002d_003estring"></a>Scheme Procedure: <strong>cipher->string</strong> <em>enumval</em></dt>
<dd><p>Return a string describing <var>enumval</var>, a <code>cipher</code> value.
</p></dd></dl>
<hr>
<div class="header">
<p>
Next: <a href="Copying-Information.html#Copying-Information" accesskey="n" rel="next">Copying Information</a>, Previous: <a href="Guile-Examples.html#Guile-Examples" accesskey="p" rel="prev">Guile Examples</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Procedure-Index.html#Procedure-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
