Blame doc/core.c.texi

Packit Service 4684c1
@c Automatically generated, do not edit.
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3402
Packit Service 4684c1
@deffn {Scheme Procedure} set-log-level! level
Packit Service 4684c1
Enable GnuTLS logging up to @var{level} (an integer).
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3382
Packit Service 4684c1
@deffn {Scheme Procedure} set-log-procedure! proc
Packit Service 4684c1
Use @var{proc} (a two-argument procedure) as the global GnuTLS log procedure.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3342
Packit Service 4684c1
@deffn {Scheme Procedure} %set-certificate-credentials-openpgp-keys! cred pub sec
Packit Service 4684c1
Use certificate @var{pub} and secret key @var{sec} in certificate credentials @var{cred}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3304
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-keyring-contains-key-id? keyring id
Packit Service 4684c1
Return @code{#f} if key ID @var{id} is in @var{keyring}, @code{#f} otherwise.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3259
Packit Service 4684c1
@deffn {Scheme Procedure} import-openpgp-keyring data format
Packit Service 4684c1
Import @var{data} (a u8vector) according to @var{format} and return the imported keyring.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3234
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-certificate-usage key
Packit Service 4684c1
Return a list of values denoting the key usage of @var{key}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3215
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-certificate-version key
Packit Service 4684c1
Return the version of the OpenPGP message format (RFC2440) honored by @var{key}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3194
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-certificate-algorithm key
Packit Service 4684c1
Return two values: the certificate algorithm used by @var{key} and the number of bits used.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3162
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-certificate-names key
Packit Service 4684c1
Return the list of names for @var{key}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3137
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-certificate-name key index
Packit Service 4684c1
Return the @var{index}th name of @var{key}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3078
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-certificate-fingerprint key
Packit Service 4684c1
Return a new u8vector denoting the fingerprint of @var{key}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3047
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-certificate-fingerprint! key fpr
Packit Service 4684c1
Store in @var{fpr} (a u8vector) the fingerprint of @var{key}.  Return the number of bytes stored in @var{fpr}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:3013
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-certificate-id! key id
Packit Service 4684c1
Store the ID (an 8 byte sequence) of certificate @var{key} in @var{id} (a u8vector).
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2987
Packit Service 4684c1
@deffn {Scheme Procedure} %openpgp-certificate-id key
Packit Service 4684c1
Return the ID (an 8-element u8vector) of certificate @var{key}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2931
Packit Service 4684c1
@deffn {Scheme Procedure} %import-openpgp-private-key data format [pass]
Packit Service 4684c1
Return a new OpenPGP private key object resulting from the import of @var{data} (a uniform array) according to @var{format}.  Optionally, a passphrase may be provided.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2887
Packit Service 4684c1
@deffn {Scheme Procedure} %import-openpgp-certificate data format
Packit Service 4684c1
Return a new OpenPGP certificate object resulting from the import of @var{data} (a uniform array) according to @var{format}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2819
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-subject-alternative-name cert index
Packit Service 4684c1
Return two values: the alternative name type for @var{cert} (i.e., one of the @code{x509-subject-alternative-name/} values) and the actual subject alternative name (a string) at @var{index}. Both values are @code{#f} if no alternative name is available at @var{index}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2788
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-subject-key-id cert
Packit Service 4684c1
Return the subject key ID (a u8vector) for @var{cert}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2756
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-authority-key-id cert
Packit Service 4684c1
Return the key ID (a u8vector) of the X.509 certificate authority of @var{cert}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2724
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-key-id cert
Packit Service 4684c1
Return a statistically unique ID (a u8vector) for @var{cert} that depends on its public key parameters.  This is normally a 20-byte SHA-1 hash.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2706
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-version cert
Packit Service 4684c1
Return the version of @var{cert}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2674
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-key-usage cert
Packit Service 4684c1
Return the key usage of @var{cert} (i.e., a list of @code{key-usage/} values), or the empty list if @var{cert} does not contain such information.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2651
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-public-key-algorithm cert
Packit Service 4684c1
Return two values: the public key algorithm (i.e., one of the @code{pk-algorithm/} values) of @var{cert} and the number of bits used.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2629
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-signature-algorithm cert
Packit Service 4684c1
Return the signature algorithm used by @var{cert} (i.e., one of the @code{sign-algorithm/} values).
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2595
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-matches-hostname? cert hostname
Packit Service 4684c1
Return true if @var{cert} matches @var{hostname}, a string denoting a DNS host name.  This is the basic implementation of @uref{https://tools.ietf.org/html/rfc2818, RFC 2818} (aka. HTTPS).
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2578
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-issuer-dn-oid cert index
Packit Service 4684c1
Return the OID (a string) at @var{index} from @var{cert}'s issuer DN.  Return @code{#f} if no OID is available at @var{index}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2566
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-dn-oid cert index
Packit Service 4684c1
Return OID (a string) at @var{index} from @var{cert}.  Return @code{#f} if no OID is available at @var{index}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2503
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-issuer-dn cert
Packit Service 4684c1
Return the distinguished name (DN) of X.509 certificate @var{cert}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2490
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-dn cert
Packit Service 4684c1
Return the distinguished name (DN) of X.509 certificate @var{cert}.  The form of the DN is as described in @uref{https://tools.ietf.org/html/rfc2253, RFC 2253}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2396
Packit Service 4684c1
@deffn {Scheme Procedure} pkcs8-import-x509-private-key data format [pass [encrypted]]
Packit Service 4684c1
Return a new X.509 private key object resulting from the import of @var{data} (a uniform array) according to @var{format}.  Optionally, if @var{pass} is not @code{#f}, it should be a string denoting a passphrase.  @var{encrypted} tells whether the private key is encrypted (@code{#t} by default).
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2351
Packit Service 4684c1
@deffn {Scheme Procedure} import-x509-private-key data format
Packit Service 4684c1
Return a new X.509 private key object resulting from the import of @var{data} (a uniform array) according to @var{format}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2306
Packit Service 4684c1
@deffn {Scheme Procedure} import-x509-certificate data format
Packit Service 4684c1
Return a new X.509 certificate object resulting from the import of @var{data} (a uniform array) according to @var{format}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2278
Packit Service 4684c1
@deffn {Scheme Procedure} server-session-psk-username session
Packit Service 4684c1
Return the username associated with PSK server session @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2234
Packit Service 4684c1
@deffn {Scheme Procedure} set-psk-client-credentials! cred username key key-format
Packit Service 4684c1
Set the client credentials for @var{cred}, a PSK client credentials object.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2217
Packit Service 4684c1
@deffn {Scheme Procedure} make-psk-client-credentials 
Packit Service 4684c1
Return a new PSK client credentials object.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2186
Packit Service 4684c1
@deffn {Scheme Procedure} set-psk-server-credentials-file! cred file
Packit Service 4684c1
Use @var{file} as the password file for PSK server credentials @var{cred}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:2169
Packit Service 4684c1
@deffn {Scheme Procedure} make-psk-server-credentials 
Packit Service 4684c1
Return new PSK server credentials.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1865
Packit Service 4684c1
@deffn {Scheme Procedure} peer-certificate-status session
Packit Service 4684c1
Verify the peer certificate for @var{session} and return a list of @code{certificate-status} values (such as @code{certificate-status/revoked}), or the empty list if the certificate is valid.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1838
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-verify-flags! cred [flags...]
Packit Service 4684c1
Set the certificate verification flags to @var{flags}, a series of @code{certificate-verify} values.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1814
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-verify-limits! cred max-bits max-depth
Packit Service 4684c1
Set the verification limits of @code{peer-certificate-status} for certificate credentials @var{cred} to @var{max_bits} bits for an acceptable certificate and @var{max_depth} as the maximum depth of a certificate chain.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1773
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-x509-keys! cred certs privkey
Packit Service 4684c1
Have certificate credentials @var{cred} use the X.509 certificates listed in @var{certs} and X.509 private key @var{privkey}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1726
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-x509-key-data! cred cert key format
Packit Service 4684c1
Use X.509 certificate @var{cert} and private key @var{key}, both uniform arrays containing the X.509 certificate and key in format @var{format}, for certificate credentials @var{cred}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1707
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-x509-crl-data! cred data format
Packit Service 4684c1
Use @var{data} (a uniform array) as the X.509 CRL (certificate revocation list) database for @var{cred}.  On success, return the number of CRLs processed.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1688
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-x509-trust-data! cred data format
Packit Service 4684c1
Use @var{data} (a uniform array) as the X.509 trust database for @var{cred}.  On success, return the number of certificates processed.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1669
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-x509-crl-file! cred file format
Packit Service 4684c1
Use @var{file} as the X.509 CRL (certificate revocation list) file for certificate credentials @var{cred}.  On success, return the number of CRLs processed.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1650
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-x509-trust-file! cred file format
Packit Service 4684c1
Use @var{file} as the X.509 trust file for certificate credentials @var{cred}.  On success, return the number of certificates processed.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1609
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-x509-key-files! cred cert-file key-file format
Packit Service 4684c1
Use @var{file} as the password file for PSK server credentials @var{cred}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1587
Packit Service 4684c1
@deffn {Scheme Procedure} set-certificate-credentials-dh-parameters! cred dh-params
Packit Service 4684c1
Use Diffie-Hellman parameters @var{dh_params} for certificate credentials @var{cred}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1567
Packit Service 4684c1
@deffn {Scheme Procedure} make-certificate-credentials 
Packit Service 4684c1
Return new certificate credentials (i.e., for use with either X.509 or OpenPGP certificates.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1464
Packit Service 4684c1
@deffn {Scheme Procedure} set-anonymous-server-dh-parameters! cred dh-params
Packit Service 4684c1
Set the Diffie-Hellman parameters of anonymous server credentials @var{cred}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1446
Packit Service 4684c1
@deffn {Scheme Procedure} make-anonymous-client-credentials 
Packit Service 4684c1
Return anonymous client credentials.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1428
Packit Service 4684c1
@deffn {Scheme Procedure} make-anonymous-server-credentials 
Packit Service 4684c1
Return anonymous server credentials.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1406
Packit Service 4684c1
@deffn {Scheme Procedure} set-session-dh-prime-bits! session bits
Packit Service 4684c1
Use @var{bits} DH prime bits for @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1380
Packit Service 4684c1
@deffn {Scheme Procedure} pkcs3-export-dh-parameters dh-params format
Packit Service 4684c1
Export Diffie-Hellman parameters @var{dh_params} in PKCS3 format according for @var{format} (an @code{x509-certificate-format} value).  Return a @code{u8vector} containing the result.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1335
Packit Service 4684c1
@deffn {Scheme Procedure} pkcs3-import-dh-parameters array format
Packit Service 4684c1
Import Diffie-Hellman parameters in PKCS3 format (further specified by @var{format}, an @code{x509-certificate-format} value) from @var{array} (a homogeneous array) and return a new @code{dh-params} object.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1309
Packit Service 4684c1
@deffn {Scheme Procedure} make-dh-parameters bits
Packit Service 4684c1
Return new Diffie-Hellman parameters.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1225
Packit Service 4684c1
@deffn {Scheme Procedure} set-session-transport-port! session port
Packit Service 4684c1
Use @var{port} as the input/output port for @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1175
Packit Service 4684c1
@deffn {Scheme Procedure} set-session-transport-fd! session fd
Packit Service 4684c1
Use file descriptor @var{fd} as the underlying transport for @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:1119
Packit Service 4684c1
@deffn {Scheme Procedure} session-record-port session
Packit Service 4684c1
Return a read-write port that may be used to communicate over @var{session}.  All invocations of @code{session-port} on a given session return the same object (in the sense of @code{eq?}).
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:786
Packit Service 4684c1
@deffn {Scheme Procedure} record-receive! session array
Packit Service 4684c1
Receive data from @var{session} into @var{array}, a uniform homogeneous array.  Return the number of bytes actually received.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:754
Packit Service 4684c1
@deffn {Scheme Procedure} record-send session array
Packit Service 4684c1
Send the record constituted by @var{array} through @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:719
Packit Service 4684c1
@deffn {Scheme Procedure} set-session-server-name! session type name
Packit Service 4684c1
For a client, this procedure provides a way to inform the server that it is known under @var{name}, @i{via} the @code{SERVER NAME} TLS extension.  @var{type} must be a @code{server-name-type} value, @var{server-name-type/dns} for DNS names.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:638
Packit Service 4684c1
@deffn {Scheme Procedure} set-session-credentials! session cred
Packit Service 4684c1
Use @var{cred} as @var{session}'s credentials.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:616
Packit Service 4684c1
@deffn {Scheme Procedure} cipher-suite->string kx cipher mac
Packit Service 4684c1
Return the name of the given cipher suite.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:570
Packit Service 4684c1
@deffn {Scheme Procedure} set-session-priorities! session priorities
Packit Service 4684c1
Have @var{session} use the given @var{priorities} for the ciphers, key exchange methods, MACs and compression methods.  @var{priorities} must be a string (@pxref{Priority Strings,,, gnutls, GnuTLS@comma{} Transport Layer Security Library for the GNU system}).  When @var{priorities} cannot be parsed, an @code{error/invalid-request} error is raised, with an extra argument indication the position of the error.
Packit Service 4684c1
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:555
Packit Service 4684c1
@deffn {Scheme Procedure} set-session-default-priority! session
Packit Service 4684c1
Have @var{session} use the default priorities.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:529
Packit Service 4684c1
@deffn {Scheme Procedure} set-server-session-certificate-request! session request
Packit Service 4684c1
Tell how @var{session}, a server-side session, should deal with certificate requests.  @var{request} should be either @code{certificate-request/request} or @code{certificate-request/require}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:489
Packit Service 4684c1
@deffn {Scheme Procedure} session-our-certificate-chain session
Packit Service 4684c1
Return our certificate chain for @var{session} (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.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:440
Packit Service 4684c1
@deffn {Scheme Procedure} session-peer-certificate-chain session
Packit Service 4684c1
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.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:420
Packit Service 4684c1
@deffn {Scheme Procedure} session-client-authentication-type session
Packit Service 4684c1
Return the client authentication type (a @code{credential-type} value) used in @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:400
Packit Service 4684c1
@deffn {Scheme Procedure} session-server-authentication-type session
Packit Service 4684c1
Return the server authentication type (a @code{credential-type} value) used in @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:380
Packit Service 4684c1
@deffn {Scheme Procedure} session-authentication-type session
Packit Service 4684c1
Return the authentication type (a @code{credential-type} value) used by @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:364
Packit Service 4684c1
@deffn {Scheme Procedure} session-protocol session
Packit Service 4684c1
Return the protocol used by @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:347
Packit Service 4684c1
@deffn {Scheme Procedure} session-certificate-type session
Packit Service 4684c1
Return @var{session}'s certificate type.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:330
Packit Service 4684c1
@deffn {Scheme Procedure} session-compression-method session
Packit Service 4684c1
Return @var{session}'s compression method.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:314
Packit Service 4684c1
@deffn {Scheme Procedure} session-mac session
Packit Service 4684c1
Return @var{session}'s MAC.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:298
Packit Service 4684c1
@deffn {Scheme Procedure} session-kx session
Packit Service 4684c1
Return @var{session}'s kx.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:282
Packit Service 4684c1
@deffn {Scheme Procedure} session-cipher session
Packit Service 4684c1
Return @var{session}'s cipher.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:254
Packit Service 4684c1
@deffn {Scheme Procedure} alert-send session level alert
Packit Service 4684c1
Send @var{alert} via @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:238
Packit Service 4684c1
@deffn {Scheme Procedure} alert-get session
Packit Service 4684c1
Get an aleter from @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:220
Packit Service 4684c1
@deffn {Scheme Procedure} reauthenticate session
Packit Service 4684c1
Perform a re-authentication step for @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:203
Packit Service 4684c1
@deffn {Scheme Procedure} rehandshake session
Packit Service 4684c1
Perform a re-handshaking for @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:185
Packit Service 4684c1
@deffn {Scheme Procedure} handshake session
Packit Service 4684c1
Perform a handshake for @var{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:164
Packit Service 4684c1
@deffn {Scheme Procedure} bye session how
Packit Service 4684c1
Close @var{session} according to @var{how}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:132
Packit Service 4684c1
@deffn {Scheme Procedure} make-session end [flags...]
Packit Service 4684c1
Return a new session for connection end @var{end}, either @code{connection-end/server} or @code{connection-end/client}.  The optional @var{flags} arguments are @code{connection-flag} values such as @code{connection-flag/auto-reauth}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/core.c:121
Packit Service 4684c1
@deffn {Scheme Procedure} gnutls-version 
Packit Service 4684c1
Return a string denoting the version number of the underlying GnuTLS library, e.g., @code{"1.7.2"}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:217
Packit Service 4684c1
@deffn {Scheme Procedure} openpgp-keyring? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{openpgp-keyring}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:201
Packit Service 4684c1
@deffn {Scheme Procedure} openpgp-private-key? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{openpgp-private-key}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:185
Packit Service 4684c1
@deffn {Scheme Procedure} openpgp-certificate? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{openpgp-certificate}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:169
Packit Service 4684c1
@deffn {Scheme Procedure} x509-private-key? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{x509-private-key}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:153
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{x509-certificate}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:137
Packit Service 4684c1
@deffn {Scheme Procedure} psk-client-credentials? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{psk-client-credentials}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:121
Packit Service 4684c1
@deffn {Scheme Procedure} psk-server-credentials? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{psk-server-credentials}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:105
Packit Service 4684c1
@deffn {Scheme Procedure} srp-client-credentials? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{srp-client-credentials}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:89
Packit Service 4684c1
@deffn {Scheme Procedure} srp-server-credentials? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{srp-server-credentials}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:73
Packit Service 4684c1
@deffn {Scheme Procedure} certificate-credentials? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{certificate-credentials}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:57
Packit Service 4684c1
@deffn {Scheme Procedure} dh-parameters? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{dh-parameters}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:41
Packit Service 4684c1
@deffn {Scheme Procedure} anonymous-server-credentials? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{anonymous-server-credentials}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:25
Packit Service 4684c1
@deffn {Scheme Procedure} anonymous-client-credentials? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{anonymous-client-credentials}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/smob-types.i.c:9
Packit Service 4684c1
@deffn {Scheme Procedure} session? obj
Packit Service 4684c1
Return true if @var{obj} is of type @code{session}.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:1023
Packit Service 4684c1
@deffn {Scheme Procedure} openpgp-certificate-format->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{openpgp-certificate-format} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:982
Packit Service 4684c1
@deffn {Scheme Procedure} error->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{error} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:961
Packit Service 4684c1
@deffn {Scheme Procedure} certificate-verify->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{certificate-verify} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:916
Packit Service 4684c1
@deffn {Scheme Procedure} key-usage->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{key-usage} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:868
Packit Service 4684c1
@deffn {Scheme Procedure} psk-key-format->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{psk-key-format} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:827
Packit Service 4684c1
@deffn {Scheme Procedure} server-name-type->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{server-name-type} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:787
Packit Service 4684c1
@deffn {Scheme Procedure} sign-algorithm->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{sign-algorithm} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:766
Packit Service 4684c1
@deffn {Scheme Procedure} pk-algorithm->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{pk-algorithm} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:745
Packit Service 4684c1
@deffn {Scheme Procedure} x509-subject-alternative-name->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{x509-subject-alternative-name} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:702
Packit Service 4684c1
@deffn {Scheme Procedure} x509-certificate-format->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{x509-certificate-format} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:661
Packit Service 4684c1
@deffn {Scheme Procedure} certificate-type->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{certificate-type} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:640
Packit Service 4684c1
@deffn {Scheme Procedure} protocol->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{protocol} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:597
Packit Service 4684c1
@deffn {Scheme Procedure} close-request->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{close-request} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:556
Packit Service 4684c1
@deffn {Scheme Procedure} certificate-request->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{certificate-request} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:514
Packit Service 4684c1
@deffn {Scheme Procedure} certificate-status->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{certificate-status} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:458
Packit Service 4684c1
@deffn {Scheme Procedure} handshake-description->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{handshake-description} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:409
Packit Service 4684c1
@deffn {Scheme Procedure} alert-description->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{alert-description} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:342
Packit Service 4684c1
@deffn {Scheme Procedure} alert-level->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{alert-level} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:301
Packit Service 4684c1
@deffn {Scheme Procedure} connection-flag->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{connection-flag} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:243
Packit Service 4684c1
@deffn {Scheme Procedure} connection-end->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{connection-end} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:202
Packit Service 4684c1
@deffn {Scheme Procedure} compression-method->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{compression-method} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:181
Packit Service 4684c1
@deffn {Scheme Procedure} digest->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{digest} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:137
Packit Service 4684c1
@deffn {Scheme Procedure} mac->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{mac} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:116
Packit Service 4684c1
@deffn {Scheme Procedure} credentials->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{credentials} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:72
Packit Service 4684c1
@deffn {Scheme Procedure} params->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{params} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:31
Packit Service 4684c1
@deffn {Scheme Procedure} kx->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{kx} value.
Packit Service 4684c1
@end deffn
Packit Service 4684c1
Packit Service 4684c1
@c snarfed from ../guile/src/enum-map.i.c:10
Packit Service 4684c1
@deffn {Scheme Procedure} cipher->string enumval
Packit Service 4684c1
Return a string describing @var{enumval}, a @code{cipher} value.
Packit Service 4684c1
@end deffn