diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
| commit | 36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch) | |
| tree | 6c68e0c0097987aff85a01dabddd34b862309a7c /doc/manpages | |
| parent | Initial commit. (diff) | |
| download | gnutls28-upstream.tar.xz gnutls28-upstream.zip | |
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/manpages')
1197 files changed, 62471 insertions, 0 deletions
diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am new file mode 100644 index 0000000..c28abf5 --- /dev/null +++ b/doc/manpages/Makefile.am @@ -0,0 +1,1377 @@ +## Process this file with automake to produce Makefile.in +# Copyright (C) 2003-2012 Free Software Foundation, Inc. +# +# Author: Nikos Mavroyanopoulos, Simon Josefsson +# +# This file is part of GnuTLS. +# +# This file is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This file is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this file; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + +man_MANS = +EXTRA_DIST = stamp_mans +MAINTAINERCLEANFILES = stamp_mans + +-include $(top_srcdir)/doc/doc.mk + +TOOLS_MANS = gnutls-cli.1 gnutls-cli-debug.1 gnutls-serv.1 \ + certtool.1 psktool.1 p11tool.1 ocsptool.1 tpmtool.1 +SRP_MANS = srptool.1 +DANE_MANS = danetool.1 + +if ENABLE_TOOLS +man_MANS += $(TOOLS_MANS) +if ENABLE_SRP +man_MANS += $(SRP_MANS) +endif +if ENABLE_DANE +man_MANS += $(DANE_MANS) +endif +endif + +EXTRA_DIST += $(TOOLS_MANS) $(SRP_MANS) $(DANE_MANS) +MAINTAINERCLEANFILES += $(TOOLS_MANS) $(SRP_MANS) $(DANE_MANS) + +$(man_MANS): $(top_srcdir)/cligen/cli-docgen.py + +CLIGEN_ARGS = \ + --license=gpl3+ \ + --package '$(PACKAGE)' \ + --version='$(VERSION)' \ + --authors='Nikos Mavrogiannopoulos, Simon Josefsson and others; see /usr/share/doc/gnutls/AUTHORS for a complete list.' \ + --copyright-year=2020-2021 \ + --copyright-holder='Free Software Foundation, and others all rights reserved.' \ + --bug-email=bugs@gnutls.org + +certtool.1: $(top_srcdir)/doc/certtool-see-also.texi $(top_srcdir)/doc/certtool-examples.texi $(top_srcdir)/doc/certtool-files.texi +certtool.1: $(top_srcdir)/src/certtool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/certtool-see-also.texi \ + --include examples=$(top_srcdir)/doc/certtool-examples.texi \ + --include files=$(top_srcdir)/doc/certtool-files.texi \ + $< $@ + +ocsptool.1: $(top_srcdir)/doc/ocsptool-see-also.texi $(top_srcdir)/doc/ocsptool-examples.texi $(top_srcdir)/doc/ocsptool-description.texi +ocsptool.1: $(top_srcdir)/src/ocsptool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/ocsptool-see-also.texi \ + --include examples=$(top_srcdir)/doc/ocsptool-examples.texi \ + --include description=$(top_srcdir)/doc/ocsptool-description.texi \ + $< $@ + +danetool.1: $(top_srcdir)/doc/danetool-see-also.texi $(top_srcdir)/doc/danetool-examples.texi +danetool.1: $(top_srcdir)/src/danetool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/danetool-see-also.texi \ + --include examples=$(top_srcdir)/doc/danetool-examples.texi \ + $< $@ + +gnutls-cli.1: $(top_srcdir)/doc/gnutls-cli-see-also.texi $(top_srcdir)/doc/gnutls-cli-examples.texi +gnutls-cli.1: $(top_srcdir)/src/gnutls-cli-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/gnutls-cli-see-also.texi \ + --include examples=$(top_srcdir)/doc/gnutls-cli-examples.texi \ + $< $@ + +gnutls-serv.1: $(top_srcdir)/doc/gnutls-serv-see-also.texi $(top_srcdir)/doc/gnutls-serv-examples.texi +gnutls-serv.1: $(top_srcdir)/src/gnutls-serv-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/gnutls-serv-see-also.texi \ + --include examples=$(top_srcdir)/doc/gnutls-serv-examples.texi \ + $< $@ + +gnutls-cli-debug.1: $(top_srcdir)/doc/gnutls-cli-debug-see-also.texi $(top_srcdir)/doc/gnutls-cli-debug-examples.texi +gnutls-cli-debug.1: $(top_srcdir)/src/gnutls-cli-debug-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/gnutls-cli-debug-see-also.texi \ + --include examples=$(top_srcdir)/doc/gnutls-cli-debug-examples.texi \ + $< $@ + +srptool.1: $(top_srcdir)/doc/srptool-see-also.texi $(top_srcdir)/doc/srptool-examples.texi +srptool.1: $(top_srcdir)/src/srptool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/srptool-see-also.texi \ + --include examples=$(top_srcdir)/doc/srptool-examples.texi \ + $< $@ + +p11tool.1: $(top_srcdir)/doc/p11tool-see-also.texi $(top_srcdir)/doc/p11tool-examples.texi +p11tool.1: $(top_srcdir)/src/p11tool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/p11tool-see-also.texi \ + --include examples=$(top_srcdir)/doc/p11tool-examples.texi \ + $< $@ + +tpmtool.1: $(top_srcdir)/doc/tpmtool-see-also.texi $(top_srcdir)/doc/tpmtool-examples.texi +tpmtool.1: $(top_srcdir)/src/tpmtool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/tpmtool-see-also.texi \ + --include examples=$(top_srcdir)/doc/tpmtool-examples.texi \ + $< $@ + +psktool.1: $(top_srcdir)/doc/psktool-see-also.texi $(top_srcdir)/doc/psktool-examples.texi +psktool.1: $(top_srcdir)/src/psktool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/psktool-see-also.texi \ + --include examples=$(top_srcdir)/doc/psktool-examples.texi \ + $< $@ + +APIMANS = +APIMANS += dane_cert_type_name.3 +APIMANS += dane_cert_usage_name.3 +APIMANS += dane_match_type_name.3 +APIMANS += dane_query_data.3 +APIMANS += dane_query_deinit.3 +APIMANS += dane_query_entries.3 +APIMANS += dane_query_status.3 +APIMANS += dane_query_tlsa.3 +APIMANS += dane_query_to_raw_tlsa.3 +APIMANS += dane_raw_tlsa.3 +APIMANS += dane_state_deinit.3 +APIMANS += dane_state_init.3 +APIMANS += dane_state_set_dlv_file.3 +APIMANS += dane_strerror.3 +APIMANS += dane_verification_status_print.3 +APIMANS += dane_verify_crt.3 +APIMANS += dane_verify_crt_raw.3 +APIMANS += dane_verify_session_crt.3 +APIMANS += gnutls_aead_cipher_decrypt.3 +APIMANS += gnutls_aead_cipher_decryptv2.3 +APIMANS += gnutls_aead_cipher_deinit.3 +APIMANS += gnutls_aead_cipher_encrypt.3 +APIMANS += gnutls_aead_cipher_encryptv.3 +APIMANS += gnutls_aead_cipher_encryptv2.3 +APIMANS += gnutls_aead_cipher_init.3 +APIMANS += gnutls_aead_cipher_set_key.3 +APIMANS += gnutls_alert_get.3 +APIMANS += gnutls_alert_get_name.3 +APIMANS += gnutls_alert_get_strname.3 +APIMANS += gnutls_alert_send.3 +APIMANS += gnutls_alert_send_appropriate.3 +APIMANS += gnutls_alert_set_read_function.3 +APIMANS += gnutls_alpn_get_selected_protocol.3 +APIMANS += gnutls_alpn_set_protocols.3 +APIMANS += gnutls_anon_allocate_client_credentials.3 +APIMANS += gnutls_anon_allocate_server_credentials.3 +APIMANS += gnutls_anon_free_client_credentials.3 +APIMANS += gnutls_anon_free_server_credentials.3 +APIMANS += gnutls_anon_set_params_function.3 +APIMANS += gnutls_anon_set_server_dh_params.3 +APIMANS += gnutls_anon_set_server_known_dh_params.3 +APIMANS += gnutls_anon_set_server_params_function.3 +APIMANS += gnutls_anti_replay_deinit.3 +APIMANS += gnutls_anti_replay_enable.3 +APIMANS += gnutls_anti_replay_init.3 +APIMANS += gnutls_anti_replay_set_add_function.3 +APIMANS += gnutls_anti_replay_set_ptr.3 +APIMANS += gnutls_anti_replay_set_window.3 +APIMANS += gnutls_auth_client_get_type.3 +APIMANS += gnutls_auth_get_type.3 +APIMANS += gnutls_auth_server_get_type.3 +APIMANS += gnutls_base64_decode2.3 +APIMANS += gnutls_base64_encode2.3 +APIMANS += gnutls_buffer_append_data.3 +APIMANS += gnutls_bye.3 +APIMANS += gnutls_certificate_activation_time_peers.3 +APIMANS += gnutls_certificate_allocate_credentials.3 +APIMANS += gnutls_certificate_client_get_request_status.3 +APIMANS += gnutls_certificate_expiration_time_peers.3 +APIMANS += gnutls_certificate_free_ca_names.3 +APIMANS += gnutls_certificate_free_cas.3 +APIMANS += gnutls_certificate_free_credentials.3 +APIMANS += gnutls_certificate_free_crls.3 +APIMANS += gnutls_certificate_free_keys.3 +APIMANS += gnutls_certificate_get_crt_raw.3 +APIMANS += gnutls_certificate_get_issuer.3 +APIMANS += gnutls_certificate_get_ocsp_expiration.3 +APIMANS += gnutls_certificate_get_ours.3 +APIMANS += gnutls_certificate_get_peers.3 +APIMANS += gnutls_certificate_get_peers_subkey_id.3 +APIMANS += gnutls_certificate_get_trust_list.3 +APIMANS += gnutls_certificate_get_verify_flags.3 +APIMANS += gnutls_certificate_get_x509_crt.3 +APIMANS += gnutls_certificate_get_x509_key.3 +APIMANS += gnutls_certificate_send_x509_rdn_sequence.3 +APIMANS += gnutls_certificate_server_set_request.3 +APIMANS += gnutls_certificate_set_dh_params.3 +APIMANS += gnutls_certificate_set_flags.3 +APIMANS += gnutls_certificate_set_key.3 +APIMANS += gnutls_certificate_set_known_dh_params.3 +APIMANS += gnutls_certificate_set_ocsp_status_request_file.3 +APIMANS += gnutls_certificate_set_ocsp_status_request_file2.3 +APIMANS += gnutls_certificate_set_ocsp_status_request_function.3 +APIMANS += gnutls_certificate_set_ocsp_status_request_function2.3 +APIMANS += gnutls_certificate_set_ocsp_status_request_mem.3 +APIMANS += gnutls_certificate_set_params_function.3 +APIMANS += gnutls_certificate_set_pin_function.3 +APIMANS += gnutls_certificate_set_rawpk_key_file.3 +APIMANS += gnutls_certificate_set_rawpk_key_mem.3 +APIMANS += gnutls_certificate_set_retrieve_function.3 +APIMANS += gnutls_certificate_set_retrieve_function2.3 +APIMANS += gnutls_certificate_set_retrieve_function3.3 +APIMANS += gnutls_certificate_set_trust_list.3 +APIMANS += gnutls_certificate_set_verify_flags.3 +APIMANS += gnutls_certificate_set_verify_function.3 +APIMANS += gnutls_certificate_set_verify_limits.3 +APIMANS += gnutls_certificate_set_x509_crl.3 +APIMANS += gnutls_certificate_set_x509_crl_file.3 +APIMANS += gnutls_certificate_set_x509_crl_mem.3 +APIMANS += gnutls_certificate_set_x509_key.3 +APIMANS += gnutls_certificate_set_x509_key_file.3 +APIMANS += gnutls_certificate_set_x509_key_file2.3 +APIMANS += gnutls_certificate_set_x509_key_mem.3 +APIMANS += gnutls_certificate_set_x509_key_mem2.3 +APIMANS += gnutls_certificate_set_x509_simple_pkcs12_file.3 +APIMANS += gnutls_certificate_set_x509_simple_pkcs12_mem.3 +APIMANS += gnutls_certificate_set_x509_system_trust.3 +APIMANS += gnutls_certificate_set_x509_trust.3 +APIMANS += gnutls_certificate_set_x509_trust_dir.3 +APIMANS += gnutls_certificate_set_x509_trust_file.3 +APIMANS += gnutls_certificate_set_x509_trust_mem.3 +APIMANS += gnutls_certificate_type_get.3 +APIMANS += gnutls_certificate_type_get2.3 +APIMANS += gnutls_certificate_type_get_id.3 +APIMANS += gnutls_certificate_type_get_name.3 +APIMANS += gnutls_certificate_type_list.3 +APIMANS += gnutls_certificate_verification_profile_get_id.3 +APIMANS += gnutls_certificate_verification_profile_get_name.3 +APIMANS += gnutls_certificate_verification_status_print.3 +APIMANS += gnutls_certificate_verify_peers.3 +APIMANS += gnutls_certificate_verify_peers2.3 +APIMANS += gnutls_certificate_verify_peers3.3 +APIMANS += gnutls_check_version.3 +APIMANS += gnutls_cipher_add_auth.3 +APIMANS += gnutls_cipher_decrypt.3 +APIMANS += gnutls_cipher_decrypt2.3 +APIMANS += gnutls_cipher_decrypt3.3 +APIMANS += gnutls_cipher_deinit.3 +APIMANS += gnutls_cipher_encrypt.3 +APIMANS += gnutls_cipher_encrypt2.3 +APIMANS += gnutls_cipher_encrypt3.3 +APIMANS += gnutls_cipher_get.3 +APIMANS += gnutls_cipher_get_block_size.3 +APIMANS += gnutls_cipher_get_id.3 +APIMANS += gnutls_cipher_get_iv_size.3 +APIMANS += gnutls_cipher_get_key_size.3 +APIMANS += gnutls_cipher_get_name.3 +APIMANS += gnutls_cipher_get_tag_size.3 +APIMANS += gnutls_cipher_init.3 +APIMANS += gnutls_cipher_list.3 +APIMANS += gnutls_cipher_set_iv.3 +APIMANS += gnutls_ciphersuite_get.3 +APIMANS += gnutls_cipher_suite_get_name.3 +APIMANS += gnutls_cipher_suite_info.3 +APIMANS += gnutls_cipher_tag.3 +APIMANS += gnutls_compress_certificate_get_selected_method.3 +APIMANS += gnutls_compress_certificate_set_methods.3 +APIMANS += gnutls_compression_get.3 +APIMANS += gnutls_compression_get_id.3 +APIMANS += gnutls_compression_get_name.3 +APIMANS += gnutls_compression_list.3 +APIMANS += gnutls_credentials_clear.3 +APIMANS += gnutls_credentials_get.3 +APIMANS += gnutls_credentials_set.3 +APIMANS += gnutls_crypto_register_aead_cipher.3 +APIMANS += gnutls_crypto_register_cipher.3 +APIMANS += gnutls_crypto_register_digest.3 +APIMANS += gnutls_crypto_register_mac.3 +APIMANS += gnutls_db_check_entry.3 +APIMANS += gnutls_db_check_entry_expire_time.3 +APIMANS += gnutls_db_check_entry_time.3 +APIMANS += gnutls_db_get_default_cache_expiration.3 +APIMANS += gnutls_db_get_ptr.3 +APIMANS += gnutls_db_remove_session.3 +APIMANS += gnutls_db_set_cache_expiration.3 +APIMANS += gnutls_db_set_ptr.3 +APIMANS += gnutls_db_set_remove_function.3 +APIMANS += gnutls_db_set_retrieve_function.3 +APIMANS += gnutls_db_set_store_function.3 +APIMANS += gnutls_decode_ber_digest_info.3 +APIMANS += gnutls_decode_gost_rs_value.3 +APIMANS += gnutls_decode_rs_value.3 +APIMANS += gnutls_deinit.3 +APIMANS += gnutls_dh_get_group.3 +APIMANS += gnutls_dh_get_peers_public_bits.3 +APIMANS += gnutls_dh_get_prime_bits.3 +APIMANS += gnutls_dh_get_pubkey.3 +APIMANS += gnutls_dh_get_secret_bits.3 +APIMANS += gnutls_dh_params_cpy.3 +APIMANS += gnutls_dh_params_deinit.3 +APIMANS += gnutls_dh_params_export2_pkcs3.3 +APIMANS += gnutls_dh_params_export_pkcs3.3 +APIMANS += gnutls_dh_params_export_raw.3 +APIMANS += gnutls_dh_params_generate2.3 +APIMANS += gnutls_dh_params_import_dsa.3 +APIMANS += gnutls_dh_params_import_pkcs3.3 +APIMANS += gnutls_dh_params_import_raw.3 +APIMANS += gnutls_dh_params_import_raw2.3 +APIMANS += gnutls_dh_params_import_raw3.3 +APIMANS += gnutls_dh_params_init.3 +APIMANS += gnutls_dh_set_prime_bits.3 +APIMANS += gnutls_digest_get_id.3 +APIMANS += gnutls_digest_get_name.3 +APIMANS += gnutls_digest_get_oid.3 +APIMANS += gnutls_digest_list.3 +APIMANS += gnutls_digest_set_secure.3 +APIMANS += gnutls_dtls_cookie_send.3 +APIMANS += gnutls_dtls_cookie_verify.3 +APIMANS += gnutls_dtls_get_data_mtu.3 +APIMANS += gnutls_dtls_get_mtu.3 +APIMANS += gnutls_dtls_get_timeout.3 +APIMANS += gnutls_dtls_prestate_set.3 +APIMANS += gnutls_dtls_set_data_mtu.3 +APIMANS += gnutls_dtls_set_mtu.3 +APIMANS += gnutls_dtls_set_timeouts.3 +APIMANS += gnutls_early_cipher_get.3 +APIMANS += gnutls_early_prf_hash_get.3 +APIMANS += gnutls_ecc_curve_get.3 +APIMANS += gnutls_ecc_curve_get_id.3 +APIMANS += gnutls_ecc_curve_get_name.3 +APIMANS += gnutls_ecc_curve_get_oid.3 +APIMANS += gnutls_ecc_curve_get_pk.3 +APIMANS += gnutls_ecc_curve_get_size.3 +APIMANS += gnutls_ecc_curve_list.3 +APIMANS += gnutls_ecc_curve_set_enabled.3 +APIMANS += gnutls_encode_ber_digest_info.3 +APIMANS += gnutls_encode_gost_rs_value.3 +APIMANS += gnutls_encode_rs_value.3 +APIMANS += gnutls_error_is_fatal.3 +APIMANS += gnutls_error_to_alert.3 +APIMANS += gnutls_est_record_overhead_size.3 +APIMANS += gnutls_ext_get_current_msg.3 +APIMANS += gnutls_ext_get_data.3 +APIMANS += gnutls_ext_get_name.3 +APIMANS += gnutls_ext_get_name2.3 +APIMANS += gnutls_ext_raw_parse.3 +APIMANS += gnutls_ext_register.3 +APIMANS += gnutls_ext_set_data.3 +APIMANS += gnutls_fingerprint.3 +APIMANS += gnutls_fips140_context_deinit.3 +APIMANS += gnutls_fips140_context_init.3 +APIMANS += gnutls_fips140_get_operation_state.3 +APIMANS += gnutls_fips140_mode_enabled.3 +APIMANS += gnutls_fips140_pop_context.3 +APIMANS += gnutls_fips140_push_context.3 +APIMANS += gnutls_fips140_run_self_tests.3 +APIMANS += gnutls_fips140_set_mode.3 +APIMANS += gnutls_get_library_config.3 +APIMANS += gnutls_get_system_config_file.3 +APIMANS += gnutls_global_deinit.3 +APIMANS += gnutls_global_init.3 +APIMANS += gnutls_global_set_audit_log_function.3 +APIMANS += gnutls_global_set_log_function.3 +APIMANS += gnutls_global_set_log_level.3 +APIMANS += gnutls_global_set_mem_functions.3 +APIMANS += gnutls_global_set_mutex.3 +APIMANS += gnutls_global_set_time_function.3 +APIMANS += gnutls_gost_paramset_get_name.3 +APIMANS += gnutls_gost_paramset_get_oid.3 +APIMANS += gnutls_group_get.3 +APIMANS += gnutls_group_get_id.3 +APIMANS += gnutls_group_get_name.3 +APIMANS += gnutls_group_list.3 +APIMANS += gnutls_handshake.3 +APIMANS += gnutls_handshake_description_get_name.3 +APIMANS += gnutls_handshake_get_last_in.3 +APIMANS += gnutls_handshake_get_last_out.3 +APIMANS += gnutls_handshake_set_hook_function.3 +APIMANS += gnutls_handshake_set_max_packet_length.3 +APIMANS += gnutls_handshake_set_post_client_hello_function.3 +APIMANS += gnutls_handshake_set_private_extensions.3 +APIMANS += gnutls_handshake_set_random.3 +APIMANS += gnutls_handshake_set_read_function.3 +APIMANS += gnutls_handshake_set_secret_function.3 +APIMANS += gnutls_handshake_set_timeout.3 +APIMANS += gnutls_handshake_write.3 +APIMANS += gnutls_hash.3 +APIMANS += gnutls_hash_copy.3 +APIMANS += gnutls_hash_deinit.3 +APIMANS += gnutls_hash_fast.3 +APIMANS += gnutls_hash_get_len.3 +APIMANS += gnutls_hash_init.3 +APIMANS += gnutls_hash_output.3 +APIMANS += gnutls_heartbeat_allowed.3 +APIMANS += gnutls_heartbeat_enable.3 +APIMANS += gnutls_heartbeat_get_timeout.3 +APIMANS += gnutls_heartbeat_ping.3 +APIMANS += gnutls_heartbeat_pong.3 +APIMANS += gnutls_heartbeat_set_timeouts.3 +APIMANS += gnutls_hex2bin.3 +APIMANS += gnutls_hex_decode.3 +APIMANS += gnutls_hex_decode2.3 +APIMANS += gnutls_hex_encode.3 +APIMANS += gnutls_hex_encode2.3 +APIMANS += gnutls_hkdf_expand.3 +APIMANS += gnutls_hkdf_extract.3 +APIMANS += gnutls_hmac.3 +APIMANS += gnutls_hmac_copy.3 +APIMANS += gnutls_hmac_deinit.3 +APIMANS += gnutls_hmac_fast.3 +APIMANS += gnutls_hmac_get_key_size.3 +APIMANS += gnutls_hmac_get_len.3 +APIMANS += gnutls_hmac_init.3 +APIMANS += gnutls_hmac_output.3 +APIMANS += gnutls_hmac_set_nonce.3 +APIMANS += gnutls_idna_map.3 +APIMANS += gnutls_idna_reverse_map.3 +APIMANS += gnutls_init.3 +APIMANS += gnutls_key_generate.3 +APIMANS += gnutls_kx_get.3 +APIMANS += gnutls_kx_get_id.3 +APIMANS += gnutls_kx_get_name.3 +APIMANS += gnutls_kx_list.3 +APIMANS += gnutls_load_file.3 +APIMANS += gnutls_mac_get.3 +APIMANS += gnutls_mac_get_id.3 +APIMANS += gnutls_mac_get_key_size.3 +APIMANS += gnutls_mac_get_name.3 +APIMANS += gnutls_mac_get_nonce_size.3 +APIMANS += gnutls_mac_list.3 +APIMANS += gnutls_memcmp.3 +APIMANS += gnutls_memset.3 +APIMANS += gnutls_ocsp_req_add_cert.3 +APIMANS += gnutls_ocsp_req_add_cert_id.3 +APIMANS += gnutls_ocsp_req_deinit.3 +APIMANS += gnutls_ocsp_req_export.3 +APIMANS += gnutls_ocsp_req_get_cert_id.3 +APIMANS += gnutls_ocsp_req_get_extension.3 +APIMANS += gnutls_ocsp_req_get_nonce.3 +APIMANS += gnutls_ocsp_req_get_version.3 +APIMANS += gnutls_ocsp_req_import.3 +APIMANS += gnutls_ocsp_req_init.3 +APIMANS += gnutls_ocsp_req_print.3 +APIMANS += gnutls_ocsp_req_randomize_nonce.3 +APIMANS += gnutls_ocsp_req_set_extension.3 +APIMANS += gnutls_ocsp_req_set_nonce.3 +APIMANS += gnutls_ocsp_resp_check_crt.3 +APIMANS += gnutls_ocsp_resp_deinit.3 +APIMANS += gnutls_ocsp_resp_export.3 +APIMANS += gnutls_ocsp_resp_export2.3 +APIMANS += gnutls_ocsp_resp_get_certs.3 +APIMANS += gnutls_ocsp_resp_get_extension.3 +APIMANS += gnutls_ocsp_resp_get_nonce.3 +APIMANS += gnutls_ocsp_resp_get_produced.3 +APIMANS += gnutls_ocsp_resp_get_responder.3 +APIMANS += gnutls_ocsp_resp_get_responder2.3 +APIMANS += gnutls_ocsp_resp_get_responder_raw_id.3 +APIMANS += gnutls_ocsp_resp_get_response.3 +APIMANS += gnutls_ocsp_resp_get_signature.3 +APIMANS += gnutls_ocsp_resp_get_signature_algorithm.3 +APIMANS += gnutls_ocsp_resp_get_single.3 +APIMANS += gnutls_ocsp_resp_get_status.3 +APIMANS += gnutls_ocsp_resp_get_version.3 +APIMANS += gnutls_ocsp_resp_import.3 +APIMANS += gnutls_ocsp_resp_import2.3 +APIMANS += gnutls_ocsp_resp_init.3 +APIMANS += gnutls_ocsp_resp_list_import2.3 +APIMANS += gnutls_ocsp_resp_print.3 +APIMANS += gnutls_ocsp_resp_verify.3 +APIMANS += gnutls_ocsp_resp_verify_direct.3 +APIMANS += gnutls_ocsp_status_request_enable_client.3 +APIMANS += gnutls_ocsp_status_request_get.3 +APIMANS += gnutls_ocsp_status_request_get2.3 +APIMANS += gnutls_ocsp_status_request_is_checked.3 +APIMANS += gnutls_oid_to_digest.3 +APIMANS += gnutls_oid_to_ecc_curve.3 +APIMANS += gnutls_oid_to_gost_paramset.3 +APIMANS += gnutls_oid_to_mac.3 +APIMANS += gnutls_oid_to_pk.3 +APIMANS += gnutls_oid_to_sign.3 +APIMANS += gnutls_openpgp_privkey_sign_hash.3 +APIMANS += gnutls_openpgp_send_cert.3 +APIMANS += gnutls_packet_deinit.3 +APIMANS += gnutls_packet_get.3 +APIMANS += gnutls_pbkdf2.3 +APIMANS += gnutls_pcert_deinit.3 +APIMANS += gnutls_pcert_export_openpgp.3 +APIMANS += gnutls_pcert_export_x509.3 +APIMANS += gnutls_pcert_import_openpgp.3 +APIMANS += gnutls_pcert_import_openpgp_raw.3 +APIMANS += gnutls_pcert_import_rawpk.3 +APIMANS += gnutls_pcert_import_rawpk_raw.3 +APIMANS += gnutls_pcert_import_x509.3 +APIMANS += gnutls_pcert_import_x509_list.3 +APIMANS += gnutls_pcert_import_x509_raw.3 +APIMANS += gnutls_pcert_list_import_x509_file.3 +APIMANS += gnutls_pcert_list_import_x509_raw.3 +APIMANS += gnutls_pem_base64_decode.3 +APIMANS += gnutls_pem_base64_decode2.3 +APIMANS += gnutls_pem_base64_encode.3 +APIMANS += gnutls_pem_base64_encode2.3 +APIMANS += gnutls_perror.3 +APIMANS += gnutls_pk_algorithm_get_name.3 +APIMANS += gnutls_pk_bits_to_sec_param.3 +APIMANS += gnutls_pkcs11_add_provider.3 +APIMANS += gnutls_pkcs11_copy_attached_extension.3 +APIMANS += gnutls_pkcs11_copy_pubkey.3 +APIMANS += gnutls_pkcs11_copy_secret_key.3 +APIMANS += gnutls_pkcs11_copy_x509_crt.3 +APIMANS += gnutls_pkcs11_copy_x509_crt2.3 +APIMANS += gnutls_pkcs11_copy_x509_privkey.3 +APIMANS += gnutls_pkcs11_copy_x509_privkey2.3 +APIMANS += gnutls_pkcs11_crt_is_known.3 +APIMANS += gnutls_pkcs11_deinit.3 +APIMANS += gnutls_pkcs11_delete_url.3 +APIMANS += gnutls_pkcs11_get_pin_function.3 +APIMANS += gnutls_pkcs11_get_raw_issuer.3 +APIMANS += gnutls_pkcs11_get_raw_issuer_by_dn.3 +APIMANS += gnutls_pkcs11_get_raw_issuer_by_subject_key_id.3 +APIMANS += gnutls_pkcs11_init.3 +APIMANS += gnutls_pkcs11_obj_deinit.3 +APIMANS += gnutls_pkcs11_obj_export.3 +APIMANS += gnutls_pkcs11_obj_export2.3 +APIMANS += gnutls_pkcs11_obj_export3.3 +APIMANS += gnutls_pkcs11_obj_export_url.3 +APIMANS += gnutls_pkcs11_obj_flags_get_str.3 +APIMANS += gnutls_pkcs11_obj_get_exts.3 +APIMANS += gnutls_pkcs11_obj_get_flags.3 +APIMANS += gnutls_pkcs11_obj_get_info.3 +APIMANS += gnutls_pkcs11_obj_get_ptr.3 +APIMANS += gnutls_pkcs11_obj_get_type.3 +APIMANS += gnutls_pkcs11_obj_import_url.3 +APIMANS += gnutls_pkcs11_obj_init.3 +APIMANS += gnutls_pkcs11_obj_list_import_url3.3 +APIMANS += gnutls_pkcs11_obj_list_import_url4.3 +APIMANS += gnutls_pkcs11_obj_set_info.3 +APIMANS += gnutls_pkcs11_obj_set_pin_function.3 +APIMANS += gnutls_pkcs11_privkey_cpy.3 +APIMANS += gnutls_pkcs11_privkey_deinit.3 +APIMANS += gnutls_pkcs11_privkey_export_pubkey.3 +APIMANS += gnutls_pkcs11_privkey_export_url.3 +APIMANS += gnutls_pkcs11_privkey_generate.3 +APIMANS += gnutls_pkcs11_privkey_generate2.3 +APIMANS += gnutls_pkcs11_privkey_generate3.3 +APIMANS += gnutls_pkcs11_privkey_get_info.3 +APIMANS += gnutls_pkcs11_privkey_get_pk_algorithm.3 +APIMANS += gnutls_pkcs11_privkey_import_url.3 +APIMANS += gnutls_pkcs11_privkey_init.3 +APIMANS += gnutls_pkcs11_privkey_set_pin_function.3 +APIMANS += gnutls_pkcs11_privkey_status.3 +APIMANS += gnutls_pkcs11_reinit.3 +APIMANS += gnutls_pkcs11_set_pin_function.3 +APIMANS += gnutls_pkcs11_set_token_function.3 +APIMANS += gnutls_pkcs11_token_check_mechanism.3 +APIMANS += gnutls_pkcs11_token_get_flags.3 +APIMANS += gnutls_pkcs11_token_get_info.3 +APIMANS += gnutls_pkcs11_token_get_mechanism.3 +APIMANS += gnutls_pkcs11_token_get_ptr.3 +APIMANS += gnutls_pkcs11_token_get_random.3 +APIMANS += gnutls_pkcs11_token_get_url.3 +APIMANS += gnutls_pkcs11_token_init.3 +APIMANS += gnutls_pkcs11_token_set_pin.3 +APIMANS += gnutls_pkcs11_type_get_name.3 +APIMANS += gnutls_pkcs12_bag_decrypt.3 +APIMANS += gnutls_pkcs12_bag_deinit.3 +APIMANS += gnutls_pkcs12_bag_enc_info.3 +APIMANS += gnutls_pkcs12_bag_encrypt.3 +APIMANS += gnutls_pkcs12_bag_get_count.3 +APIMANS += gnutls_pkcs12_bag_get_data.3 +APIMANS += gnutls_pkcs12_bag_get_friendly_name.3 +APIMANS += gnutls_pkcs12_bag_get_key_id.3 +APIMANS += gnutls_pkcs12_bag_get_type.3 +APIMANS += gnutls_pkcs12_bag_init.3 +APIMANS += gnutls_pkcs12_bag_set_crl.3 +APIMANS += gnutls_pkcs12_bag_set_crt.3 +APIMANS += gnutls_pkcs12_bag_set_data.3 +APIMANS += gnutls_pkcs12_bag_set_friendly_name.3 +APIMANS += gnutls_pkcs12_bag_set_key_id.3 +APIMANS += gnutls_pkcs12_bag_set_privkey.3 +APIMANS += gnutls_pkcs12_deinit.3 +APIMANS += gnutls_pkcs12_export.3 +APIMANS += gnutls_pkcs12_export2.3 +APIMANS += gnutls_pkcs12_generate_mac.3 +APIMANS += gnutls_pkcs12_generate_mac2.3 +APIMANS += gnutls_pkcs12_get_bag.3 +APIMANS += gnutls_pkcs12_import.3 +APIMANS += gnutls_pkcs12_init.3 +APIMANS += gnutls_pkcs12_mac_info.3 +APIMANS += gnutls_pkcs12_set_bag.3 +APIMANS += gnutls_pkcs12_simple_parse.3 +APIMANS += gnutls_pkcs12_verify_mac.3 +APIMANS += gnutls_pkcs7_add_attr.3 +APIMANS += gnutls_pkcs7_attrs_deinit.3 +APIMANS += gnutls_pkcs7_deinit.3 +APIMANS += gnutls_pkcs7_delete_crl.3 +APIMANS += gnutls_pkcs7_delete_crt.3 +APIMANS += gnutls_pkcs7_export.3 +APIMANS += gnutls_pkcs7_export2.3 +APIMANS += gnutls_pkcs7_get_attr.3 +APIMANS += gnutls_pkcs7_get_crl_count.3 +APIMANS += gnutls_pkcs7_get_crl_raw.3 +APIMANS += gnutls_pkcs7_get_crl_raw2.3 +APIMANS += gnutls_pkcs7_get_crt_count.3 +APIMANS += gnutls_pkcs7_get_crt_raw.3 +APIMANS += gnutls_pkcs7_get_crt_raw2.3 +APIMANS += gnutls_pkcs7_get_embedded_data.3 +APIMANS += gnutls_pkcs7_get_embedded_data_oid.3 +APIMANS += gnutls_pkcs7_get_signature_count.3 +APIMANS += gnutls_pkcs7_get_signature_info.3 +APIMANS += gnutls_pkcs7_import.3 +APIMANS += gnutls_pkcs7_init.3 +APIMANS += gnutls_pkcs7_print.3 +APIMANS += gnutls_pkcs7_print_signature_info.3 +APIMANS += gnutls_pkcs7_set_crl.3 +APIMANS += gnutls_pkcs7_set_crl_raw.3 +APIMANS += gnutls_pkcs7_set_crt.3 +APIMANS += gnutls_pkcs7_set_crt_raw.3 +APIMANS += gnutls_pkcs7_sign.3 +APIMANS += gnutls_pkcs7_signature_info_deinit.3 +APIMANS += gnutls_pkcs7_verify.3 +APIMANS += gnutls_pkcs7_verify_direct.3 +APIMANS += gnutls_pkcs8_info.3 +APIMANS += gnutls_pkcs_schema_get_name.3 +APIMANS += gnutls_pkcs_schema_get_oid.3 +APIMANS += gnutls_pk_get_id.3 +APIMANS += gnutls_pk_get_name.3 +APIMANS += gnutls_pk_get_oid.3 +APIMANS += gnutls_pk_list.3 +APIMANS += gnutls_pk_to_sign.3 +APIMANS += gnutls_prf.3 +APIMANS += gnutls_prf_early.3 +APIMANS += gnutls_prf_hash_get.3 +APIMANS += gnutls_prf_raw.3 +APIMANS += gnutls_prf_rfc5705.3 +APIMANS += gnutls_priority_certificate_type_list.3 +APIMANS += gnutls_priority_certificate_type_list2.3 +APIMANS += gnutls_priority_cipher_list.3 +APIMANS += gnutls_priority_compression_list.3 +APIMANS += gnutls_priority_deinit.3 +APIMANS += gnutls_priority_ecc_curve_list.3 +APIMANS += gnutls_priority_get_cipher_suite_index.3 +APIMANS += gnutls_priority_group_list.3 +APIMANS += gnutls_priority_init.3 +APIMANS += gnutls_priority_init2.3 +APIMANS += gnutls_priority_kx_list.3 +APIMANS += gnutls_priority_mac_list.3 +APIMANS += gnutls_priority_protocol_list.3 +APIMANS += gnutls_priority_set.3 +APIMANS += gnutls_priority_set_direct.3 +APIMANS += gnutls_priority_sign_list.3 +APIMANS += gnutls_priority_string_list.3 +APIMANS += gnutls_privkey_decrypt_data.3 +APIMANS += gnutls_privkey_decrypt_data2.3 +APIMANS += gnutls_privkey_deinit.3 +APIMANS += gnutls_privkey_export_dsa_raw.3 +APIMANS += gnutls_privkey_export_dsa_raw2.3 +APIMANS += gnutls_privkey_export_ecc_raw.3 +APIMANS += gnutls_privkey_export_ecc_raw2.3 +APIMANS += gnutls_privkey_export_gost_raw2.3 +APIMANS += gnutls_privkey_export_openpgp.3 +APIMANS += gnutls_privkey_export_pkcs11.3 +APIMANS += gnutls_privkey_export_rsa_raw.3 +APIMANS += gnutls_privkey_export_rsa_raw2.3 +APIMANS += gnutls_privkey_export_x509.3 +APIMANS += gnutls_privkey_generate.3 +APIMANS += gnutls_privkey_generate2.3 +APIMANS += gnutls_privkey_get_pk_algorithm.3 +APIMANS += gnutls_privkey_get_seed.3 +APIMANS += gnutls_privkey_get_spki.3 +APIMANS += gnutls_privkey_get_type.3 +APIMANS += gnutls_privkey_import_dsa_raw.3 +APIMANS += gnutls_privkey_import_ecc_raw.3 +APIMANS += gnutls_privkey_import_ext.3 +APIMANS += gnutls_privkey_import_ext2.3 +APIMANS += gnutls_privkey_import_ext3.3 +APIMANS += gnutls_privkey_import_ext4.3 +APIMANS += gnutls_privkey_import_gost_raw.3 +APIMANS += gnutls_privkey_import_openpgp.3 +APIMANS += gnutls_privkey_import_openpgp_raw.3 +APIMANS += gnutls_privkey_import_pkcs11.3 +APIMANS += gnutls_privkey_import_pkcs11_url.3 +APIMANS += gnutls_privkey_import_rsa_raw.3 +APIMANS += gnutls_privkey_import_tpm_raw.3 +APIMANS += gnutls_privkey_import_tpm_url.3 +APIMANS += gnutls_privkey_import_url.3 +APIMANS += gnutls_privkey_import_x509.3 +APIMANS += gnutls_privkey_import_x509_raw.3 +APIMANS += gnutls_privkey_init.3 +APIMANS += gnutls_privkey_set_flags.3 +APIMANS += gnutls_privkey_set_pin_function.3 +APIMANS += gnutls_privkey_set_spki.3 +APIMANS += gnutls_privkey_sign_data.3 +APIMANS += gnutls_privkey_sign_data2.3 +APIMANS += gnutls_privkey_sign_hash.3 +APIMANS += gnutls_privkey_sign_hash2.3 +APIMANS += gnutls_privkey_status.3 +APIMANS += gnutls_privkey_verify_params.3 +APIMANS += gnutls_privkey_verify_seed.3 +APIMANS += gnutls_protocol_get_id.3 +APIMANS += gnutls_protocol_get_name.3 +APIMANS += gnutls_protocol_get_version.3 +APIMANS += gnutls_protocol_list.3 +APIMANS += gnutls_protocol_set_enabled.3 +APIMANS += gnutls_psk_allocate_client_credentials.3 +APIMANS += gnutls_psk_allocate_server_credentials.3 +APIMANS += gnutls_psk_client_get_hint.3 +APIMANS += gnutls_psk_free_client_credentials.3 +APIMANS += gnutls_psk_free_server_credentials.3 +APIMANS += gnutls_psk_server_get_username.3 +APIMANS += gnutls_psk_server_get_username2.3 +APIMANS += gnutls_psk_set_client_credentials.3 +APIMANS += gnutls_psk_set_client_credentials2.3 +APIMANS += gnutls_psk_set_client_credentials_function.3 +APIMANS += gnutls_psk_set_client_credentials_function2.3 +APIMANS += gnutls_psk_set_params_function.3 +APIMANS += gnutls_psk_set_server_credentials_file.3 +APIMANS += gnutls_psk_set_server_credentials_function.3 +APIMANS += gnutls_psk_set_server_credentials_function2.3 +APIMANS += gnutls_psk_set_server_credentials_hint.3 +APIMANS += gnutls_psk_set_server_dh_params.3 +APIMANS += gnutls_psk_set_server_known_dh_params.3 +APIMANS += gnutls_psk_set_server_params_function.3 +APIMANS += gnutls_pubkey_deinit.3 +APIMANS += gnutls_pubkey_encrypt_data.3 +APIMANS += gnutls_pubkey_export.3 +APIMANS += gnutls_pubkey_export2.3 +APIMANS += gnutls_pubkey_export_dsa_raw.3 +APIMANS += gnutls_pubkey_export_dsa_raw2.3 +APIMANS += gnutls_pubkey_export_ecc_raw.3 +APIMANS += gnutls_pubkey_export_ecc_raw2.3 +APIMANS += gnutls_pubkey_export_ecc_x962.3 +APIMANS += gnutls_pubkey_export_gost_raw2.3 +APIMANS += gnutls_pubkey_export_rsa_raw.3 +APIMANS += gnutls_pubkey_export_rsa_raw2.3 +APIMANS += gnutls_pubkey_get_key_id.3 +APIMANS += gnutls_pubkey_get_key_usage.3 +APIMANS += gnutls_pubkey_get_openpgp_key_id.3 +APIMANS += gnutls_pubkey_get_pk_algorithm.3 +APIMANS += gnutls_pubkey_get_preferred_hash_algorithm.3 +APIMANS += gnutls_pubkey_get_spki.3 +APIMANS += gnutls_pubkey_import.3 +APIMANS += gnutls_pubkey_import_dsa_raw.3 +APIMANS += gnutls_pubkey_import_ecc_raw.3 +APIMANS += gnutls_pubkey_import_ecc_x962.3 +APIMANS += gnutls_pubkey_import_gost_raw.3 +APIMANS += gnutls_pubkey_import_openpgp.3 +APIMANS += gnutls_pubkey_import_openpgp_raw.3 +APIMANS += gnutls_pubkey_import_pkcs11.3 +APIMANS += gnutls_pubkey_import_privkey.3 +APIMANS += gnutls_pubkey_import_rsa_raw.3 +APIMANS += gnutls_pubkey_import_tpm_raw.3 +APIMANS += gnutls_pubkey_import_tpm_url.3 +APIMANS += gnutls_pubkey_import_url.3 +APIMANS += gnutls_pubkey_import_x509.3 +APIMANS += gnutls_pubkey_import_x509_crq.3 +APIMANS += gnutls_pubkey_import_x509_raw.3 +APIMANS += gnutls_pubkey_init.3 +APIMANS += gnutls_pubkey_print.3 +APIMANS += gnutls_pubkey_set_key_usage.3 +APIMANS += gnutls_pubkey_set_pin_function.3 +APIMANS += gnutls_pubkey_set_spki.3 +APIMANS += gnutls_pubkey_verify_data2.3 +APIMANS += gnutls_pubkey_verify_hash2.3 +APIMANS += gnutls_pubkey_verify_params.3 +APIMANS += gnutls_random_art.3 +APIMANS += gnutls_range_split.3 +APIMANS += gnutls_reauth.3 +APIMANS += gnutls_record_can_use_length_hiding.3 +APIMANS += gnutls_record_check_corked.3 +APIMANS += gnutls_record_check_pending.3 +APIMANS += gnutls_record_cork.3 +APIMANS += gnutls_record_disable_padding.3 +APIMANS += gnutls_record_discard_queued.3 +APIMANS += gnutls_record_get_direction.3 +APIMANS += gnutls_record_get_discarded.3 +APIMANS += gnutls_record_get_max_early_data_size.3 +APIMANS += gnutls_record_get_max_size.3 +APIMANS += gnutls_record_get_state.3 +APIMANS += gnutls_record_overhead_size.3 +APIMANS += gnutls_record_recv.3 +APIMANS += gnutls_record_recv_early_data.3 +APIMANS += gnutls_record_recv_packet.3 +APIMANS += gnutls_record_recv_seq.3 +APIMANS += gnutls_record_send.3 +APIMANS += gnutls_record_send2.3 +APIMANS += gnutls_record_send_early_data.3 +APIMANS += gnutls_record_send_file.3 +APIMANS += gnutls_record_send_range.3 +APIMANS += gnutls_record_set_max_early_data_size.3 +APIMANS += gnutls_record_set_max_recv_size.3 +APIMANS += gnutls_record_set_max_size.3 +APIMANS += gnutls_record_set_state.3 +APIMANS += gnutls_record_set_timeout.3 +APIMANS += gnutls_record_uncork.3 +APIMANS += gnutls_register_custom_url.3 +APIMANS += gnutls_rehandshake.3 +APIMANS += gnutls_rnd.3 +APIMANS += gnutls_rnd_refresh.3 +APIMANS += gnutls_safe_renegotiation_status.3 +APIMANS += gnutls_sec_param_get_name.3 +APIMANS += gnutls_sec_param_to_pk_bits.3 +APIMANS += gnutls_sec_param_to_symmetric_bits.3 +APIMANS += gnutls_server_name_get.3 +APIMANS += gnutls_server_name_set.3 +APIMANS += gnutls_session_channel_binding.3 +APIMANS += gnutls_session_enable_compatibility_mode.3 +APIMANS += gnutls_session_etm_status.3 +APIMANS += gnutls_session_ext_master_secret_status.3 +APIMANS += gnutls_session_ext_register.3 +APIMANS += gnutls_session_force_valid.3 +APIMANS += gnutls_session_get_data.3 +APIMANS += gnutls_session_get_data2.3 +APIMANS += gnutls_session_get_desc.3 +APIMANS += gnutls_session_get_flags.3 +APIMANS += gnutls_session_get_id.3 +APIMANS += gnutls_session_get_id2.3 +APIMANS += gnutls_session_get_keylog_function.3 +APIMANS += gnutls_session_get_master_secret.3 +APIMANS += gnutls_session_get_ptr.3 +APIMANS += gnutls_session_get_random.3 +APIMANS += gnutls_session_get_verify_cert_status.3 +APIMANS += gnutls_session_is_resumed.3 +APIMANS += gnutls_session_key_update.3 +APIMANS += gnutls_session_resumption_requested.3 +APIMANS += gnutls_session_set_data.3 +APIMANS += gnutls_session_set_id.3 +APIMANS += gnutls_session_set_keylog_function.3 +APIMANS += gnutls_session_set_premaster.3 +APIMANS += gnutls_session_set_ptr.3 +APIMANS += gnutls_session_set_verify_cert.3 +APIMANS += gnutls_session_set_verify_cert2.3 +APIMANS += gnutls_session_set_verify_function.3 +APIMANS += gnutls_session_set_verify_output_function.3 +APIMANS += gnutls_session_supplemental_register.3 +APIMANS += gnutls_session_ticket_enable_client.3 +APIMANS += gnutls_session_ticket_enable_server.3 +APIMANS += gnutls_session_ticket_key_generate.3 +APIMANS += gnutls_session_ticket_send.3 +APIMANS += gnutls_set_default_priority.3 +APIMANS += gnutls_set_default_priority_append.3 +APIMANS += gnutls_sign_algorithm_get.3 +APIMANS += gnutls_sign_algorithm_get_client.3 +APIMANS += gnutls_sign_algorithm_get_requested.3 +APIMANS += gnutls_sign_get_hash_algorithm.3 +APIMANS += gnutls_sign_get_id.3 +APIMANS += gnutls_sign_get_name.3 +APIMANS += gnutls_sign_get_oid.3 +APIMANS += gnutls_sign_get_pk_algorithm.3 +APIMANS += gnutls_sign_is_secure.3 +APIMANS += gnutls_sign_is_secure2.3 +APIMANS += gnutls_sign_list.3 +APIMANS += gnutls_sign_set_secure.3 +APIMANS += gnutls_sign_set_secure_for_certs.3 +APIMANS += gnutls_sign_supports_pk_algorithm.3 +APIMANS += gnutls_srp_allocate_client_credentials.3 +APIMANS += gnutls_srp_allocate_server_credentials.3 +APIMANS += gnutls_srp_base64_decode.3 +APIMANS += gnutls_srp_base64_decode2.3 +APIMANS += gnutls_srp_base64_encode.3 +APIMANS += gnutls_srp_base64_encode2.3 +APIMANS += gnutls_srp_free_client_credentials.3 +APIMANS += gnutls_srp_free_server_credentials.3 +APIMANS += gnutls_srp_server_get_username.3 +APIMANS += gnutls_srp_set_client_credentials.3 +APIMANS += gnutls_srp_set_client_credentials_function.3 +APIMANS += gnutls_srp_set_prime_bits.3 +APIMANS += gnutls_srp_set_server_credentials_file.3 +APIMANS += gnutls_srp_set_server_credentials_function.3 +APIMANS += gnutls_srp_set_server_fake_salt_seed.3 +APIMANS += gnutls_srp_verifier.3 +APIMANS += gnutls_srtp_get_keys.3 +APIMANS += gnutls_srtp_get_mki.3 +APIMANS += gnutls_srtp_get_profile_id.3 +APIMANS += gnutls_srtp_get_profile_name.3 +APIMANS += gnutls_srtp_get_selected_profile.3 +APIMANS += gnutls_srtp_set_mki.3 +APIMANS += gnutls_srtp_set_profile.3 +APIMANS += gnutls_srtp_set_profile_direct.3 +APIMANS += gnutls_store_commitment.3 +APIMANS += gnutls_store_pubkey.3 +APIMANS += gnutls_strerror.3 +APIMANS += gnutls_strerror_name.3 +APIMANS += gnutls_subject_alt_names_deinit.3 +APIMANS += gnutls_subject_alt_names_get.3 +APIMANS += gnutls_subject_alt_names_init.3 +APIMANS += gnutls_subject_alt_names_set.3 +APIMANS += gnutls_supplemental_get_name.3 +APIMANS += gnutls_supplemental_recv.3 +APIMANS += gnutls_supplemental_register.3 +APIMANS += gnutls_supplemental_send.3 +APIMANS += gnutls_system_key_add_x509.3 +APIMANS += gnutls_system_key_delete.3 +APIMANS += gnutls_system_key_iter_deinit.3 +APIMANS += gnutls_system_key_iter_get_info.3 +APIMANS += gnutls_system_recv_timeout.3 +APIMANS += gnutls_tdb_deinit.3 +APIMANS += gnutls_tdb_init.3 +APIMANS += gnutls_tdb_set_store_commitment_func.3 +APIMANS += gnutls_tdb_set_store_func.3 +APIMANS += gnutls_tdb_set_verify_func.3 +APIMANS += gnutls_tpm_get_registered.3 +APIMANS += gnutls_tpm_key_list_deinit.3 +APIMANS += gnutls_tpm_key_list_get_url.3 +APIMANS += gnutls_tpm_privkey_delete.3 +APIMANS += gnutls_tpm_privkey_generate.3 +APIMANS += gnutls_transport_get_int.3 +APIMANS += gnutls_transport_get_int2.3 +APIMANS += gnutls_transport_get_ptr.3 +APIMANS += gnutls_transport_get_ptr2.3 +APIMANS += gnutls_transport_is_ktls_enabled.3 +APIMANS += gnutls_transport_set_errno.3 +APIMANS += gnutls_transport_set_errno_function.3 +APIMANS += gnutls_transport_set_fastopen.3 +APIMANS += gnutls_transport_set_int.3 +APIMANS += gnutls_transport_set_int2.3 +APIMANS += gnutls_transport_set_ptr.3 +APIMANS += gnutls_transport_set_ptr2.3 +APIMANS += gnutls_transport_set_pull_function.3 +APIMANS += gnutls_transport_set_pull_timeout_function.3 +APIMANS += gnutls_transport_set_push_function.3 +APIMANS += gnutls_transport_set_vec_push_function.3 +APIMANS += gnutls_url_is_supported.3 +APIMANS += gnutls_utf8_password_normalize.3 +APIMANS += gnutls_verify_stored_pubkey.3 +APIMANS += gnutls_x509_aia_deinit.3 +APIMANS += gnutls_x509_aia_get.3 +APIMANS += gnutls_x509_aia_init.3 +APIMANS += gnutls_x509_aia_set.3 +APIMANS += gnutls_x509_aki_deinit.3 +APIMANS += gnutls_x509_aki_get_cert_issuer.3 +APIMANS += gnutls_x509_aki_get_id.3 +APIMANS += gnutls_x509_aki_init.3 +APIMANS += gnutls_x509_aki_set_cert_issuer.3 +APIMANS += gnutls_x509_aki_set_id.3 +APIMANS += gnutls_x509_cidr_to_rfc5280.3 +APIMANS += gnutls_x509_crl_check_issuer.3 +APIMANS += gnutls_x509_crl_deinit.3 +APIMANS += gnutls_x509_crl_dist_points_deinit.3 +APIMANS += gnutls_x509_crl_dist_points_get.3 +APIMANS += gnutls_x509_crl_dist_points_init.3 +APIMANS += gnutls_x509_crl_dist_points_set.3 +APIMANS += gnutls_x509_crl_export.3 +APIMANS += gnutls_x509_crl_export2.3 +APIMANS += gnutls_x509_crl_get_authority_key_gn_serial.3 +APIMANS += gnutls_x509_crl_get_authority_key_id.3 +APIMANS += gnutls_x509_crl_get_crt_count.3 +APIMANS += gnutls_x509_crl_get_crt_serial.3 +APIMANS += gnutls_x509_crl_get_dn_oid.3 +APIMANS += gnutls_x509_crl_get_extension_data.3 +APIMANS += gnutls_x509_crl_get_extension_data2.3 +APIMANS += gnutls_x509_crl_get_extension_info.3 +APIMANS += gnutls_x509_crl_get_extension_oid.3 +APIMANS += gnutls_x509_crl_get_issuer_dn.3 +APIMANS += gnutls_x509_crl_get_issuer_dn2.3 +APIMANS += gnutls_x509_crl_get_issuer_dn3.3 +APIMANS += gnutls_x509_crl_get_issuer_dn_by_oid.3 +APIMANS += gnutls_x509_crl_get_next_update.3 +APIMANS += gnutls_x509_crl_get_number.3 +APIMANS += gnutls_x509_crl_get_raw_issuer_dn.3 +APIMANS += gnutls_x509_crl_get_signature.3 +APIMANS += gnutls_x509_crl_get_signature_algorithm.3 +APIMANS += gnutls_x509_crl_get_signature_oid.3 +APIMANS += gnutls_x509_crl_get_this_update.3 +APIMANS += gnutls_x509_crl_get_version.3 +APIMANS += gnutls_x509_crl_import.3 +APIMANS += gnutls_x509_crl_init.3 +APIMANS += gnutls_x509_crl_iter_crt_serial.3 +APIMANS += gnutls_x509_crl_iter_deinit.3 +APIMANS += gnutls_x509_crl_list_import.3 +APIMANS += gnutls_x509_crl_list_import2.3 +APIMANS += gnutls_x509_crl_print.3 +APIMANS += gnutls_x509_crl_privkey_sign.3 +APIMANS += gnutls_x509_crl_set_authority_key_id.3 +APIMANS += gnutls_x509_crl_set_crt.3 +APIMANS += gnutls_x509_crl_set_crt_serial.3 +APIMANS += gnutls_x509_crl_set_next_update.3 +APIMANS += gnutls_x509_crl_set_number.3 +APIMANS += gnutls_x509_crl_set_this_update.3 +APIMANS += gnutls_x509_crl_set_version.3 +APIMANS += gnutls_x509_crl_sign.3 +APIMANS += gnutls_x509_crl_sign2.3 +APIMANS += gnutls_x509_crl_verify.3 +APIMANS += gnutls_x509_crq_deinit.3 +APIMANS += gnutls_x509_crq_export.3 +APIMANS += gnutls_x509_crq_export2.3 +APIMANS += gnutls_x509_crq_get_attribute_by_oid.3 +APIMANS += gnutls_x509_crq_get_attribute_data.3 +APIMANS += gnutls_x509_crq_get_attribute_info.3 +APIMANS += gnutls_x509_crq_get_basic_constraints.3 +APIMANS += gnutls_x509_crq_get_challenge_password.3 +APIMANS += gnutls_x509_crq_get_dn.3 +APIMANS += gnutls_x509_crq_get_dn2.3 +APIMANS += gnutls_x509_crq_get_dn3.3 +APIMANS += gnutls_x509_crq_get_dn_by_oid.3 +APIMANS += gnutls_x509_crq_get_dn_oid.3 +APIMANS += gnutls_x509_crq_get_extension_by_oid.3 +APIMANS += gnutls_x509_crq_get_extension_by_oid2.3 +APIMANS += gnutls_x509_crq_get_extension_data.3 +APIMANS += gnutls_x509_crq_get_extension_data2.3 +APIMANS += gnutls_x509_crq_get_extension_info.3 +APIMANS += gnutls_x509_crq_get_key_id.3 +APIMANS += gnutls_x509_crq_get_key_purpose_oid.3 +APIMANS += gnutls_x509_crq_get_key_rsa_raw.3 +APIMANS += gnutls_x509_crq_get_key_usage.3 +APIMANS += gnutls_x509_crq_get_pk_algorithm.3 +APIMANS += gnutls_x509_crq_get_pk_oid.3 +APIMANS += gnutls_x509_crq_get_private_key_usage_period.3 +APIMANS += gnutls_x509_crq_get_signature_algorithm.3 +APIMANS += gnutls_x509_crq_get_signature_oid.3 +APIMANS += gnutls_x509_crq_get_spki.3 +APIMANS += gnutls_x509_crq_get_subject_alt_name.3 +APIMANS += gnutls_x509_crq_get_subject_alt_othername_oid.3 +APIMANS += gnutls_x509_crq_get_tlsfeatures.3 +APIMANS += gnutls_x509_crq_get_version.3 +APIMANS += gnutls_x509_crq_import.3 +APIMANS += gnutls_x509_crq_init.3 +APIMANS += gnutls_x509_crq_print.3 +APIMANS += gnutls_x509_crq_privkey_sign.3 +APIMANS += gnutls_x509_crq_set_attribute_by_oid.3 +APIMANS += gnutls_x509_crq_set_basic_constraints.3 +APIMANS += gnutls_x509_crq_set_challenge_password.3 +APIMANS += gnutls_x509_crq_set_dn.3 +APIMANS += gnutls_x509_crq_set_dn_by_oid.3 +APIMANS += gnutls_x509_crq_set_extension_by_oid.3 +APIMANS += gnutls_x509_crq_set_key.3 +APIMANS += gnutls_x509_crq_set_key_purpose_oid.3 +APIMANS += gnutls_x509_crq_set_key_rsa_raw.3 +APIMANS += gnutls_x509_crq_set_key_usage.3 +APIMANS += gnutls_x509_crq_set_private_key_usage_period.3 +APIMANS += gnutls_x509_crq_set_pubkey.3 +APIMANS += gnutls_x509_crq_set_spki.3 +APIMANS += gnutls_x509_crq_set_subject_alt_name.3 +APIMANS += gnutls_x509_crq_set_subject_alt_othername.3 +APIMANS += gnutls_x509_crq_set_tlsfeatures.3 +APIMANS += gnutls_x509_crq_set_version.3 +APIMANS += gnutls_x509_crq_sign.3 +APIMANS += gnutls_x509_crq_sign2.3 +APIMANS += gnutls_x509_crq_verify.3 +APIMANS += gnutls_x509_crt_check_email.3 +APIMANS += gnutls_x509_crt_check_hostname.3 +APIMANS += gnutls_x509_crt_check_hostname2.3 +APIMANS += gnutls_x509_crt_check_ip.3 +APIMANS += gnutls_x509_crt_check_issuer.3 +APIMANS += gnutls_x509_crt_check_key_purpose.3 +APIMANS += gnutls_x509_crt_check_revocation.3 +APIMANS += gnutls_x509_crt_cpy_crl_dist_points.3 +APIMANS += gnutls_x509_crt_deinit.3 +APIMANS += gnutls_x509_crt_equals.3 +APIMANS += gnutls_x509_crt_equals2.3 +APIMANS += gnutls_x509_crt_export.3 +APIMANS += gnutls_x509_crt_export2.3 +APIMANS += gnutls_x509_crt_get_activation_time.3 +APIMANS += gnutls_x509_crt_get_authority_info_access.3 +APIMANS += gnutls_x509_crt_get_authority_key_gn_serial.3 +APIMANS += gnutls_x509_crt_get_authority_key_id.3 +APIMANS += gnutls_x509_crt_get_basic_constraints.3 +APIMANS += gnutls_x509_crt_get_ca_status.3 +APIMANS += gnutls_x509_crt_get_crl_dist_points.3 +APIMANS += gnutls_x509_crt_get_dn.3 +APIMANS += gnutls_x509_crt_get_dn2.3 +APIMANS += gnutls_x509_crt_get_dn3.3 +APIMANS += gnutls_x509_crt_get_dn_by_oid.3 +APIMANS += gnutls_x509_crt_get_dn_oid.3 +APIMANS += gnutls_x509_crt_get_expiration_time.3 +APIMANS += gnutls_x509_crt_get_extension_by_oid.3 +APIMANS += gnutls_x509_crt_get_extension_by_oid2.3 +APIMANS += gnutls_x509_crt_get_extension_data.3 +APIMANS += gnutls_x509_crt_get_extension_data2.3 +APIMANS += gnutls_x509_crt_get_extension_info.3 +APIMANS += gnutls_x509_crt_get_extension_oid.3 +APIMANS += gnutls_x509_crt_get_fingerprint.3 +APIMANS += gnutls_x509_crt_get_inhibit_anypolicy.3 +APIMANS += gnutls_x509_crt_get_issuer.3 +APIMANS += gnutls_x509_crt_get_issuer_alt_name.3 +APIMANS += gnutls_x509_crt_get_issuer_alt_name2.3 +APIMANS += gnutls_x509_crt_get_issuer_alt_othername_oid.3 +APIMANS += gnutls_x509_crt_get_issuer_dn.3 +APIMANS += gnutls_x509_crt_get_issuer_dn2.3 +APIMANS += gnutls_x509_crt_get_issuer_dn3.3 +APIMANS += gnutls_x509_crt_get_issuer_dn_by_oid.3 +APIMANS += gnutls_x509_crt_get_issuer_dn_oid.3 +APIMANS += gnutls_x509_crt_get_issuer_unique_id.3 +APIMANS += gnutls_x509_crt_get_key_id.3 +APIMANS += gnutls_x509_crt_get_key_purpose_oid.3 +APIMANS += gnutls_x509_crt_get_key_usage.3 +APIMANS += gnutls_x509_crt_get_name_constraints.3 +APIMANS += gnutls_x509_crt_get_pk_algorithm.3 +APIMANS += gnutls_x509_crt_get_pk_dsa_raw.3 +APIMANS += gnutls_x509_crt_get_pk_ecc_raw.3 +APIMANS += gnutls_x509_crt_get_pk_gost_raw.3 +APIMANS += gnutls_x509_crt_get_pk_oid.3 +APIMANS += gnutls_x509_crt_get_pk_rsa_raw.3 +APIMANS += gnutls_x509_crt_get_policy.3 +APIMANS += gnutls_x509_crt_get_preferred_hash_algorithm.3 +APIMANS += gnutls_x509_crt_get_private_key_usage_period.3 +APIMANS += gnutls_x509_crt_get_proxy.3 +APIMANS += gnutls_x509_crt_get_raw_dn.3 +APIMANS += gnutls_x509_crt_get_raw_issuer_dn.3 +APIMANS += gnutls_x509_crt_get_serial.3 +APIMANS += gnutls_x509_crt_get_signature.3 +APIMANS += gnutls_x509_crt_get_signature_algorithm.3 +APIMANS += gnutls_x509_crt_get_signature_oid.3 +APIMANS += gnutls_x509_crt_get_spki.3 +APIMANS += gnutls_x509_crt_get_subject.3 +APIMANS += gnutls_x509_crt_get_subject_alt_name.3 +APIMANS += gnutls_x509_crt_get_subject_alt_name2.3 +APIMANS += gnutls_x509_crt_get_subject_alt_othername_oid.3 +APIMANS += gnutls_x509_crt_get_subject_key_id.3 +APIMANS += gnutls_x509_crt_get_subject_unique_id.3 +APIMANS += gnutls_x509_crt_get_tlsfeatures.3 +APIMANS += gnutls_x509_crt_get_version.3 +APIMANS += gnutls_x509_crt_import.3 +APIMANS += gnutls_x509_crt_import_pkcs11.3 +APIMANS += gnutls_x509_crt_import_url.3 +APIMANS += gnutls_x509_crt_init.3 +APIMANS += gnutls_x509_crt_list_import.3 +APIMANS += gnutls_x509_crt_list_import2.3 +APIMANS += gnutls_x509_crt_list_import_pkcs11.3 +APIMANS += gnutls_x509_crt_list_import_url.3 +APIMANS += gnutls_x509_crt_list_verify.3 +APIMANS += gnutls_x509_crt_print.3 +APIMANS += gnutls_x509_crt_privkey_sign.3 +APIMANS += gnutls_x509_crt_set_activation_time.3 +APIMANS += gnutls_x509_crt_set_authority_info_access.3 +APIMANS += gnutls_x509_crt_set_authority_key_id.3 +APIMANS += gnutls_x509_crt_set_basic_constraints.3 +APIMANS += gnutls_x509_crt_set_ca_status.3 +APIMANS += gnutls_x509_crt_set_crl_dist_points.3 +APIMANS += gnutls_x509_crt_set_crl_dist_points2.3 +APIMANS += gnutls_x509_crt_set_crq.3 +APIMANS += gnutls_x509_crt_set_crq_extension_by_oid.3 +APIMANS += gnutls_x509_crt_set_crq_extensions.3 +APIMANS += gnutls_x509_crt_set_dn.3 +APIMANS += gnutls_x509_crt_set_dn_by_oid.3 +APIMANS += gnutls_x509_crt_set_expiration_time.3 +APIMANS += gnutls_x509_crt_set_extension_by_oid.3 +APIMANS += gnutls_x509_crt_set_flags.3 +APIMANS += gnutls_x509_crt_set_inhibit_anypolicy.3 +APIMANS += gnutls_x509_crt_set_issuer_alt_name.3 +APIMANS += gnutls_x509_crt_set_issuer_alt_othername.3 +APIMANS += gnutls_x509_crt_set_issuer_dn.3 +APIMANS += gnutls_x509_crt_set_issuer_dn_by_oid.3 +APIMANS += gnutls_x509_crt_set_issuer_unique_id.3 +APIMANS += gnutls_x509_crt_set_key.3 +APIMANS += gnutls_x509_crt_set_key_purpose_oid.3 +APIMANS += gnutls_x509_crt_set_key_usage.3 +APIMANS += gnutls_x509_crt_set_name_constraints.3 +APIMANS += gnutls_x509_crt_set_pin_function.3 +APIMANS += gnutls_x509_crt_set_policy.3 +APIMANS += gnutls_x509_crt_set_private_key_usage_period.3 +APIMANS += gnutls_x509_crt_set_proxy.3 +APIMANS += gnutls_x509_crt_set_proxy_dn.3 +APIMANS += gnutls_x509_crt_set_pubkey.3 +APIMANS += gnutls_x509_crt_set_serial.3 +APIMANS += gnutls_x509_crt_set_spki.3 +APIMANS += gnutls_x509_crt_set_subject_alternative_name.3 +APIMANS += gnutls_x509_crt_set_subject_alt_name.3 +APIMANS += gnutls_x509_crt_set_subject_alt_othername.3 +APIMANS += gnutls_x509_crt_set_subject_key_id.3 +APIMANS += gnutls_x509_crt_set_subject_unique_id.3 +APIMANS += gnutls_x509_crt_set_tlsfeatures.3 +APIMANS += gnutls_x509_crt_set_version.3 +APIMANS += gnutls_x509_crt_sign.3 +APIMANS += gnutls_x509_crt_sign2.3 +APIMANS += gnutls_x509_crt_verify.3 +APIMANS += gnutls_x509_crt_verify_data2.3 +APIMANS += gnutls_x509_ct_sct_get.3 +APIMANS += gnutls_x509_ct_sct_get_version.3 +APIMANS += gnutls_x509_dn_deinit.3 +APIMANS += gnutls_x509_dn_export.3 +APIMANS += gnutls_x509_dn_export2.3 +APIMANS += gnutls_x509_dn_get_rdn_ava.3 +APIMANS += gnutls_x509_dn_get_str.3 +APIMANS += gnutls_x509_dn_get_str2.3 +APIMANS += gnutls_x509_dn_import.3 +APIMANS += gnutls_x509_dn_init.3 +APIMANS += gnutls_x509_dn_oid_known.3 +APIMANS += gnutls_x509_dn_oid_name.3 +APIMANS += gnutls_x509_dn_set_str.3 +APIMANS += gnutls_x509_ext_ct_export_scts.3 +APIMANS += gnutls_x509_ext_ct_import_scts.3 +APIMANS += gnutls_x509_ext_ct_scts_deinit.3 +APIMANS += gnutls_x509_ext_ct_scts_init.3 +APIMANS += gnutls_x509_ext_deinit.3 +APIMANS += gnutls_x509_ext_export_aia.3 +APIMANS += gnutls_x509_ext_export_authority_key_id.3 +APIMANS += gnutls_x509_ext_export_basic_constraints.3 +APIMANS += gnutls_x509_ext_export_crl_dist_points.3 +APIMANS += gnutls_x509_ext_export_inhibit_anypolicy.3 +APIMANS += gnutls_x509_ext_export_key_purposes.3 +APIMANS += gnutls_x509_ext_export_key_usage.3 +APIMANS += gnutls_x509_ext_export_name_constraints.3 +APIMANS += gnutls_x509_ext_export_policies.3 +APIMANS += gnutls_x509_ext_export_private_key_usage_period.3 +APIMANS += gnutls_x509_ext_export_proxy.3 +APIMANS += gnutls_x509_ext_export_subject_alt_names.3 +APIMANS += gnutls_x509_ext_export_subject_key_id.3 +APIMANS += gnutls_x509_ext_export_tlsfeatures.3 +APIMANS += gnutls_x509_ext_import_aia.3 +APIMANS += gnutls_x509_ext_import_authority_key_id.3 +APIMANS += gnutls_x509_ext_import_basic_constraints.3 +APIMANS += gnutls_x509_ext_import_crl_dist_points.3 +APIMANS += gnutls_x509_ext_import_inhibit_anypolicy.3 +APIMANS += gnutls_x509_ext_import_key_purposes.3 +APIMANS += gnutls_x509_ext_import_key_usage.3 +APIMANS += gnutls_x509_ext_import_name_constraints.3 +APIMANS += gnutls_x509_ext_import_policies.3 +APIMANS += gnutls_x509_ext_import_private_key_usage_period.3 +APIMANS += gnutls_x509_ext_import_proxy.3 +APIMANS += gnutls_x509_ext_import_subject_alt_names.3 +APIMANS += gnutls_x509_ext_import_subject_key_id.3 +APIMANS += gnutls_x509_ext_import_tlsfeatures.3 +APIMANS += gnutls_x509_ext_print.3 +APIMANS += gnutls_x509_key_purpose_deinit.3 +APIMANS += gnutls_x509_key_purpose_get.3 +APIMANS += gnutls_x509_key_purpose_init.3 +APIMANS += gnutls_x509_key_purpose_set.3 +APIMANS += gnutls_x509_name_constraints_add_excluded.3 +APIMANS += gnutls_x509_name_constraints_add_permitted.3 +APIMANS += gnutls_x509_name_constraints_check.3 +APIMANS += gnutls_x509_name_constraints_check_crt.3 +APIMANS += gnutls_x509_name_constraints_deinit.3 +APIMANS += gnutls_x509_name_constraints_get_excluded.3 +APIMANS += gnutls_x509_name_constraints_get_permitted.3 +APIMANS += gnutls_x509_name_constraints_init.3 +APIMANS += gnutls_x509_othername_to_virtual.3 +APIMANS += gnutls_x509_policies_deinit.3 +APIMANS += gnutls_x509_policies_get.3 +APIMANS += gnutls_x509_policies_init.3 +APIMANS += gnutls_x509_policies_set.3 +APIMANS += gnutls_x509_policy_release.3 +APIMANS += gnutls_x509_privkey_cpy.3 +APIMANS += gnutls_x509_privkey_deinit.3 +APIMANS += gnutls_x509_privkey_export.3 +APIMANS += gnutls_x509_privkey_export2.3 +APIMANS += gnutls_x509_privkey_export2_pkcs8.3 +APIMANS += gnutls_x509_privkey_export_dsa_raw.3 +APIMANS += gnutls_x509_privkey_export_ecc_raw.3 +APIMANS += gnutls_x509_privkey_export_gost_raw.3 +APIMANS += gnutls_x509_privkey_export_pkcs8.3 +APIMANS += gnutls_x509_privkey_export_rsa_raw.3 +APIMANS += gnutls_x509_privkey_export_rsa_raw2.3 +APIMANS += gnutls_x509_privkey_fix.3 +APIMANS += gnutls_x509_privkey_generate.3 +APIMANS += gnutls_x509_privkey_generate2.3 +APIMANS += gnutls_x509_privkey_get_key_id.3 +APIMANS += gnutls_x509_privkey_get_pk_algorithm.3 +APIMANS += gnutls_x509_privkey_get_pk_algorithm2.3 +APIMANS += gnutls_x509_privkey_get_seed.3 +APIMANS += gnutls_x509_privkey_get_spki.3 +APIMANS += gnutls_x509_privkey_import.3 +APIMANS += gnutls_x509_privkey_import2.3 +APIMANS += gnutls_x509_privkey_import_dsa_raw.3 +APIMANS += gnutls_x509_privkey_import_ecc_raw.3 +APIMANS += gnutls_x509_privkey_import_gost_raw.3 +APIMANS += gnutls_x509_privkey_import_openssl.3 +APIMANS += gnutls_x509_privkey_import_pkcs8.3 +APIMANS += gnutls_x509_privkey_import_rsa_raw.3 +APIMANS += gnutls_x509_privkey_import_rsa_raw2.3 +APIMANS += gnutls_x509_privkey_init.3 +APIMANS += gnutls_x509_privkey_sec_param.3 +APIMANS += gnutls_x509_privkey_set_flags.3 +APIMANS += gnutls_x509_privkey_set_pin_function.3 +APIMANS += gnutls_x509_privkey_set_spki.3 +APIMANS += gnutls_x509_privkey_sign_data.3 +APIMANS += gnutls_x509_privkey_sign_hash.3 +APIMANS += gnutls_x509_privkey_verify_params.3 +APIMANS += gnutls_x509_privkey_verify_seed.3 +APIMANS += gnutls_x509_rdn_get.3 +APIMANS += gnutls_x509_rdn_get2.3 +APIMANS += gnutls_x509_rdn_get_by_oid.3 +APIMANS += gnutls_x509_rdn_get_oid.3 +APIMANS += gnutls_x509_spki_deinit.3 +APIMANS += gnutls_x509_spki_get_rsa_pss_params.3 +APIMANS += gnutls_x509_spki_init.3 +APIMANS += gnutls_x509_spki_set_rsa_pss_params.3 +APIMANS += gnutls_x509_tlsfeatures_add.3 +APIMANS += gnutls_x509_tlsfeatures_check_crt.3 +APIMANS += gnutls_x509_tlsfeatures_deinit.3 +APIMANS += gnutls_x509_tlsfeatures_get.3 +APIMANS += gnutls_x509_tlsfeatures_init.3 +APIMANS += gnutls_x509_trust_list_add_cas.3 +APIMANS += gnutls_x509_trust_list_add_crls.3 +APIMANS += gnutls_x509_trust_list_add_named_crt.3 +APIMANS += gnutls_x509_trust_list_add_system_trust.3 +APIMANS += gnutls_x509_trust_list_add_trust_dir.3 +APIMANS += gnutls_x509_trust_list_add_trust_file.3 +APIMANS += gnutls_x509_trust_list_add_trust_mem.3 +APIMANS += gnutls_x509_trust_list_deinit.3 +APIMANS += gnutls_x509_trust_list_get_issuer.3 +APIMANS += gnutls_x509_trust_list_get_issuer_by_dn.3 +APIMANS += gnutls_x509_trust_list_get_issuer_by_subject_key_id.3 +APIMANS += gnutls_x509_trust_list_get_ptr.3 +APIMANS += gnutls_x509_trust_list_init.3 +APIMANS += gnutls_x509_trust_list_iter_deinit.3 +APIMANS += gnutls_x509_trust_list_iter_get_ca.3 +APIMANS += gnutls_x509_trust_list_remove_cas.3 +APIMANS += gnutls_x509_trust_list_remove_trust_file.3 +APIMANS += gnutls_x509_trust_list_remove_trust_mem.3 +APIMANS += gnutls_x509_trust_list_set_getissuer_function.3 +APIMANS += gnutls_x509_trust_list_set_ptr.3 +APIMANS += gnutls_x509_trust_list_verify_crt.3 +APIMANS += gnutls_x509_trust_list_verify_crt2.3 +APIMANS += gnutls_x509_trust_list_verify_named_crt.3 + +if ENABLE_DOC +man_MANS += $(APIMANS) +endif + +EXTRA_DIST += $(APIMANS) +MAINTAINERCLEANFILES += $(APIMANS) + +$(APIMANS): stamp_mans + +compare-makefile: + @echo "******************************************************************************" + @echo "If the following step fails use 'make files-update'" + @echo "******************************************************************************" + FUNCS=`cat $(HEADER_FILES)| $(top_srcdir)/doc/scripts/getfuncs.pl|sort -d|uniq`; \ + MANS=""; \ + for i in $$FUNCS; do \ + MANS="$$MANS\nAPIMANS += $$i.3"; \ + done; \ + grep -v -e '^APIMANS += ' $(srcdir)/Makefile.am | \ + perl -p -e "s/^APIMANS =/APIMANS =$$MANS/" > tmp-$@; \ + diff -u $(srcdir)/Makefile.am tmp-$@ + rm -f tmp-$@ + +stamp_mans: $(HEADER_FILES) + @for header in $(HEADER_FILES); do \ + echo $(ECHO_N) "Creating man pages for `basename $$header .in`..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $$header`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-site "https://www.gnutls.org" \ + -include "gnutls/`basename $$header .in`" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ + -function $$i \ + $(C_SOURCE_FILES) > $$i.3 && \ + echo $(ECHO_N) "."; \ + done ; \ + echo "" ; \ + done + echo $@ > $@ + +.PHONY: update-makefile diff --git a/doc/manpages/Makefile.in b/doc/manpages/Makefile.in new file mode 100644 index 0000000..4dbf860 --- /dev/null +++ b/doc/manpages/Makefile.in @@ -0,0 +1,3303 @@ +# Makefile.in generated by automake 1.16.5 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994-2021 Free Software Foundation, Inc. + +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# Copyright (C) 2003-2012 Free Software Foundation, Inc. +# +# Author: Nikos Mavroyanopoulos, Simon Josefsson +# +# This file is part of GnuTLS. +# +# This file is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This file is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this file; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +VPATH = @srcdir@ +am__is_gnu_make = { \ + if test -z '$(MAKELEVEL)'; then \ + false; \ + elif test -n '$(MAKE_HOST)'; then \ + true; \ + elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \ + true; \ + else \ + false; \ + fi; \ +} +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +@ENABLE_TOOLS_TRUE@am__append_1 = $(TOOLS_MANS) +@ENABLE_SRP_TRUE@@ENABLE_TOOLS_TRUE@am__append_2 = $(SRP_MANS) +@ENABLE_DANE_TRUE@@ENABLE_TOOLS_TRUE@am__append_3 = $(DANE_MANS) +@ENABLE_DOC_TRUE@am__append_4 = $(APIMANS) +subdir = doc/manpages +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/lib/unistring/m4/gnulib-comp.m4 \ + $(top_srcdir)/lib/unistring/m4/inline.m4 \ + $(top_srcdir)/lib/unistring/m4/libunistring-base.m4 \ + $(top_srcdir)/src/gl/m4/atoll.m4 \ + $(top_srcdir)/src/gl/m4/bison.m4 \ + $(top_srcdir)/src/gl/m4/calloc.m4 \ + $(top_srcdir)/src/gl/m4/clock_time.m4 \ + $(top_srcdir)/src/gl/m4/codeset.m4 \ + $(top_srcdir)/src/gl/m4/ctype_h.m4 \ + $(top_srcdir)/src/gl/m4/environ.m4 \ + $(top_srcdir)/src/gl/m4/error.m4 \ + $(top_srcdir)/src/gl/m4/fdopen.m4 \ + $(top_srcdir)/src/gl/m4/flexmember.m4 \ + $(top_srcdir)/src/gl/m4/fpending.m4 \ + $(top_srcdir)/src/gl/m4/fpieee.m4 \ + $(top_srcdir)/src/gl/m4/fseek.m4 \ + $(top_srcdir)/src/gl/m4/ftruncate.m4 \ + $(top_srcdir)/src/gl/m4/getaddrinfo.m4 \ + $(top_srcdir)/src/gl/m4/getcwd.m4 \ + $(top_srcdir)/src/gl/m4/getpagesize.m4 \ + $(top_srcdir)/src/gl/m4/getpass.m4 \ + $(top_srcdir)/src/gl/m4/getprogname.m4 \ + $(top_srcdir)/src/gl/m4/gettime.m4 \ + $(top_srcdir)/src/gl/m4/gnulib-comp.m4 \ + $(top_srcdir)/src/gl/m4/hostent.m4 \ + $(top_srcdir)/src/gl/m4/intl-thread-locale.m4 \ + $(top_srcdir)/src/gl/m4/inttostr.m4 \ + $(top_srcdir)/src/gl/m4/ioctl.m4 \ + $(top_srcdir)/src/gl/m4/isblank.m4 \ + $(top_srcdir)/src/gl/m4/langinfo_h.m4 \ + $(top_srcdir)/src/gl/m4/lcmessage.m4 \ + $(top_srcdir)/src/gl/m4/locale-fr.m4 \ + $(top_srcdir)/src/gl/m4/locale-ja.m4 \ + $(top_srcdir)/src/gl/m4/locale-tr.m4 \ + $(top_srcdir)/src/gl/m4/locale-zh.m4 \ + $(top_srcdir)/src/gl/m4/locale_h.m4 \ + $(top_srcdir)/src/gl/m4/localename.m4 \ + $(top_srcdir)/src/gl/m4/lstat.m4 \ + $(top_srcdir)/src/gl/m4/mktime.m4 \ + $(top_srcdir)/src/gl/m4/nanosleep.m4 \ + $(top_srcdir)/src/gl/m4/nstrftime.m4 \ + $(top_srcdir)/src/gl/m4/parse-datetime.m4 \ + $(top_srcdir)/src/gl/m4/perror.m4 \ + $(top_srcdir)/src/gl/m4/pipe.m4 \ + $(top_srcdir)/src/gl/m4/pthread-thread.m4 \ + $(top_srcdir)/src/gl/m4/pthread_h.m4 \ + $(top_srcdir)/src/gl/m4/pthread_sigmask.m4 \ + $(top_srcdir)/src/gl/m4/putenv.m4 \ + $(top_srcdir)/src/gl/m4/raise.m4 \ + $(top_srcdir)/src/gl/m4/reallocarray.m4 \ + $(top_srcdir)/src/gl/m4/sched_h.m4 \ + $(top_srcdir)/src/gl/m4/sched_yield.m4 \ + $(top_srcdir)/src/gl/m4/select.m4 \ + $(top_srcdir)/src/gl/m4/semaphore.m4 \ + $(top_srcdir)/src/gl/m4/servent.m4 \ + $(top_srcdir)/src/gl/m4/setenv.m4 \ + $(top_srcdir)/src/gl/m4/setlocale.m4 \ + $(top_srcdir)/src/gl/m4/setlocale_null.m4 \ + $(top_srcdir)/src/gl/m4/sigaction.m4 \ + $(top_srcdir)/src/gl/m4/signal_h.m4 \ + $(top_srcdir)/src/gl/m4/signalblocking.m4 \ + $(top_srcdir)/src/gl/m4/sleep.m4 \ + $(top_srcdir)/src/gl/m4/sockets.m4 \ + $(top_srcdir)/src/gl/m4/strerror.m4 \ + $(top_srcdir)/src/gl/m4/strerror_r.m4 \ + $(top_srcdir)/src/gl/m4/strtoll.m4 \ + $(top_srcdir)/src/gl/m4/symlink.m4 \ + $(top_srcdir)/src/gl/m4/sys_ioctl_h.m4 \ + $(top_srcdir)/src/gl/m4/sys_select_h.m4 \ + $(top_srcdir)/src/gl/m4/thread.m4 \ + $(top_srcdir)/src/gl/m4/time_rz.m4 \ + $(top_srcdir)/src/gl/m4/timegm.m4 \ + $(top_srcdir)/src/gl/m4/timespec.m4 \ + $(top_srcdir)/src/gl/m4/tm_gmtoff.m4 \ + $(top_srcdir)/src/gl/m4/tzset.m4 \ + $(top_srcdir)/src/gl/m4/usleep.m4 \ + $(top_srcdir)/src/gl/m4/visibility.m4 \ + $(top_srcdir)/src/gl/m4/xalloc.m4 \ + $(top_srcdir)/src/gl/m4/yield.m4 $(top_srcdir)/m4/00gnulib.m4 \ + $(top_srcdir)/m4/__inline.m4 \ + $(top_srcdir)/m4/absolute-header.m4 $(top_srcdir)/m4/alloca.m4 \ + $(top_srcdir)/m4/arpa_inet_h.m4 \ + $(top_srcdir)/m4/ax_ac_append_to_file.m4 \ + $(top_srcdir)/m4/ax_ac_print_to_file.m4 \ + $(top_srcdir)/m4/ax_add_am_macro_static.m4 \ + $(top_srcdir)/m4/ax_am_macros_static.m4 \ + $(top_srcdir)/m4/ax_check_gnu_make.m4 \ + $(top_srcdir)/m4/ax_code_coverage.m4 \ + $(top_srcdir)/m4/ax_file_escapes.m4 \ + $(top_srcdir)/m4/builtin-expect.m4 \ + $(top_srcdir)/m4/byteswap.m4 $(top_srcdir)/m4/close.m4 \ + $(top_srcdir)/m4/double-slash-root.m4 $(top_srcdir)/m4/dup2.m4 \ + $(top_srcdir)/m4/eealloc.m4 $(top_srcdir)/m4/errno_h.m4 \ + $(top_srcdir)/m4/explicit_bzero.m4 \ + $(top_srcdir)/m4/exponentd.m4 $(top_srcdir)/m4/extensions.m4 \ + $(top_srcdir)/m4/extern-inline.m4 $(top_srcdir)/m4/fcntl-o.m4 \ + $(top_srcdir)/m4/fcntl.m4 $(top_srcdir)/m4/fcntl_h.m4 \ + $(top_srcdir)/m4/float_h.m4 $(top_srcdir)/m4/fopen.m4 \ + $(top_srcdir)/m4/free.m4 $(top_srcdir)/m4/fseeko.m4 \ + $(top_srcdir)/m4/fstat.m4 $(top_srcdir)/m4/ftell.m4 \ + $(top_srcdir)/m4/ftello.m4 $(top_srcdir)/m4/func.m4 \ + $(top_srcdir)/m4/getdelim.m4 $(top_srcdir)/m4/getdtablesize.m4 \ + $(top_srcdir)/m4/getline.m4 $(top_srcdir)/m4/gettext.m4 \ + $(top_srcdir)/m4/gettimeofday.m4 \ + $(top_srcdir)/m4/gnulib-common.m4 \ + $(top_srcdir)/m4/gnulib-comp.m4 $(top_srcdir)/m4/gtk-doc.m4 \ + $(top_srcdir)/m4/guile.m4 $(top_srcdir)/m4/hooks.m4 \ + $(top_srcdir)/m4/host-cpu-c-abi.m4 $(top_srcdir)/m4/iconv.m4 \ + $(top_srcdir)/m4/include_next.m4 $(top_srcdir)/m4/inet_ntop.m4 \ + $(top_srcdir)/m4/inet_pton.m4 $(top_srcdir)/m4/intlmacosx.m4 \ + $(top_srcdir)/m4/intmax_t.m4 $(top_srcdir)/m4/inttypes.m4 \ + $(top_srcdir)/m4/inttypes_h.m4 $(top_srcdir)/m4/largefile.m4 \ + $(top_srcdir)/m4/ld-output-def.m4 \ + $(top_srcdir)/m4/ld-version-script.m4 $(top_srcdir)/m4/ldd.m4 \ + $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ + $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/limits-h.m4 $(top_srcdir)/m4/lock.m4 \ + $(top_srcdir)/m4/lseek.m4 $(top_srcdir)/m4/ltoptions.m4 \ + $(top_srcdir)/m4/ltsugar.m4 $(top_srcdir)/m4/ltversion.m4 \ + $(top_srcdir)/m4/lt~obsolete.m4 $(top_srcdir)/m4/malloc.m4 \ + $(top_srcdir)/m4/malloca.m4 $(top_srcdir)/m4/manywarnings.m4 \ + $(top_srcdir)/m4/memchr.m4 $(top_srcdir)/m4/memmem.m4 \ + $(top_srcdir)/m4/minmax.m4 $(top_srcdir)/m4/mmap-anon.m4 \ + $(top_srcdir)/m4/mode_t.m4 $(top_srcdir)/m4/msvc-inval.m4 \ + $(top_srcdir)/m4/msvc-nothrow.m4 $(top_srcdir)/m4/multiarch.m4 \ + $(top_srcdir)/m4/netdb_h.m4 $(top_srcdir)/m4/netinet_in_h.m4 \ + $(top_srcdir)/m4/nls.m4 $(top_srcdir)/m4/off_t.m4 \ + $(top_srcdir)/m4/open-cloexec.m4 \ + $(top_srcdir)/m4/open-slash.m4 $(top_srcdir)/m4/open.m4 \ + $(top_srcdir)/m4/pathmax.m4 $(top_srcdir)/m4/pkg.m4 \ + $(top_srcdir)/m4/po.m4 $(top_srcdir)/m4/printf.m4 \ + $(top_srcdir)/m4/progtest.m4 \ + $(top_srcdir)/m4/pthread_rwlock_rdlock.m4 \ + $(top_srcdir)/m4/read-file.m4 $(top_srcdir)/m4/realloc.m4 \ + $(top_srcdir)/m4/secure_getenv.m4 $(top_srcdir)/m4/size_max.m4 \ + $(top_srcdir)/m4/snprintf.m4 $(top_srcdir)/m4/socketlib.m4 \ + $(top_srcdir)/m4/socklen.m4 $(top_srcdir)/m4/sockpfaf.m4 \ + $(top_srcdir)/m4/ssize_t.m4 $(top_srcdir)/m4/stat-time.m4 \ + $(top_srcdir)/m4/stat.m4 $(top_srcdir)/m4/stdalign.m4 \ + $(top_srcdir)/m4/stdbool.m4 $(top_srcdir)/m4/stddef_h.m4 \ + $(top_srcdir)/m4/stdint.m4 $(top_srcdir)/m4/stdint_h.m4 \ + $(top_srcdir)/m4/stdio_h.m4 $(top_srcdir)/m4/stdlib_h.m4 \ + $(top_srcdir)/m4/stpcpy.m4 $(top_srcdir)/m4/strcase.m4 \ + $(top_srcdir)/m4/strdup.m4 $(top_srcdir)/m4/string_h.m4 \ + $(top_srcdir)/m4/strings_h.m4 $(top_srcdir)/m4/strndup.m4 \ + $(top_srcdir)/m4/strnlen.m4 $(top_srcdir)/m4/strtok_r.m4 \ + $(top_srcdir)/m4/strverscmp.m4 \ + $(top_srcdir)/m4/sys_socket_h.m4 \ + $(top_srcdir)/m4/sys_stat_h.m4 $(top_srcdir)/m4/sys_time_h.m4 \ + $(top_srcdir)/m4/sys_types_h.m4 $(top_srcdir)/m4/sys_uio_h.m4 \ + $(top_srcdir)/m4/threadlib.m4 $(top_srcdir)/m4/time_h.m4 \ + $(top_srcdir)/m4/time_r.m4 $(top_srcdir)/m4/ungetc.m4 \ + $(top_srcdir)/m4/unistd_h.m4 \ + $(top_srcdir)/m4/valgrind-tests.m4 \ + $(top_srcdir)/m4/vasnprintf.m4 $(top_srcdir)/m4/vasprintf.m4 \ + $(top_srcdir)/m4/vsnprintf.m4 $(top_srcdir)/m4/warn-on-use.m4 \ + $(top_srcdir)/m4/warnings.m4 $(top_srcdir)/m4/wchar_h.m4 \ + $(top_srcdir)/m4/wchar_t.m4 $(top_srcdir)/m4/wint_t.m4 \ + $(top_srcdir)/m4/xsize.m4 $(top_srcdir)/m4/zzgnulib.m4 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +DIST_COMMON = $(srcdir)/Makefile.am $(am__DIST_COMMON) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = +SOURCES = +DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = f=`echo $$p | sed -e 's|^.*/||'`; +am__install_max = 40 +am__nobase_strip_setup = \ + srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'` +am__nobase_strip = \ + for p in $$list; do echo "$$p"; done | sed -e "s|$$srcdirstrip/||" +am__nobase_list = $(am__nobase_strip_setup); \ + for p in $$list; do echo "$$p $$p"; done | \ + sed "s| $$srcdirstrip/| |;"' / .*\//!s/ .*/ ./; s,\( .*\)/[^/]*$$,\1,' | \ + $(AWK) 'BEGIN { files["."] = "" } { files[$$2] = files[$$2] " " $$1; \ + if (++n[$$2] == $(am__install_max)) \ + { print $$2, files[$$2]; n[$$2] = 0; files[$$2] = "" } } \ + END { for (dir in files) print dir, files[dir] }' +am__base_list = \ + sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ + sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } +man1dir = $(mandir)/man1 +am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man3dir)" +man3dir = $(mandir)/man3 +NROFF = nroff +MANS = $(man_MANS) +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) +am__DIST_COMMON = $(srcdir)/Makefile.in +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +AARCH64_CCASFLAGS = @AARCH64_CCASFLAGS@ +ACLOCAL = @ACLOCAL@ +ALLOCA = @ALLOCA@ +ALLOCA_H = @ALLOCA_H@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AM_VALGRINDFLAGS = @AM_VALGRINDFLAGS@ +APPLE_UNIVERSAL_BUILD = @APPLE_UNIVERSAL_BUILD@ +AR = @AR@ +ARFLAGS = @ARFLAGS@ +ASN1PARSER = @ASN1PARSER@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +BITSIZEOF_PTRDIFF_T = @BITSIZEOF_PTRDIFF_T@ +BITSIZEOF_SIG_ATOMIC_T = @BITSIZEOF_SIG_ATOMIC_T@ +BITSIZEOF_SIZE_T = @BITSIZEOF_SIZE_T@ +BITSIZEOF_WCHAR_T = @BITSIZEOF_WCHAR_T@ +BITSIZEOF_WINT_T = @BITSIZEOF_WINT_T@ +BYTESWAP_H = @BYTESWAP_H@ +CC = @CC@ +CCAS = @CCAS@ +CCASDEPMODE = @CCASDEPMODE@ +CCASFLAGS = @CCASFLAGS@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CFLAG_VISIBILITY = @CFLAG_VISIBILITY@ +CMOCKA_CFLAGS = @CMOCKA_CFLAGS@ +CMOCKA_LIBS = @CMOCKA_LIBS@ +CODE_COVERAGE_CFLAGS = @CODE_COVERAGE_CFLAGS@ +CODE_COVERAGE_CPPFLAGS = @CODE_COVERAGE_CPPFLAGS@ +CODE_COVERAGE_CXXFLAGS = @CODE_COVERAGE_CXXFLAGS@ +CODE_COVERAGE_ENABLED = @CODE_COVERAGE_ENABLED@ +CODE_COVERAGE_LIBS = @CODE_COVERAGE_LIBS@ +CONFIG_INCLUDE = @CONFIG_INCLUDE@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CRYWRAP_PATCHLEVEL = @CRYWRAP_PATCHLEVEL@ +CSCOPE = @CSCOPE@ +CTAGS = @CTAGS@ +CXX = @CXX@ +CXXCPP = @CXXCPP@ +CXXDEPMODE = @CXXDEPMODE@ +CXXFLAGS = @CXXFLAGS@ +CXX_LT_AGE = @CXX_LT_AGE@ +CXX_LT_CURRENT = @CXX_LT_CURRENT@ +CXX_LT_REVISION = @CXX_LT_REVISION@ +CYGPATH_W = @CYGPATH_W@ +DEFAULT_VALGRINDFLAGS = @DEFAULT_VALGRINDFLAGS@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DLL_SSL_VERSION = @DLL_SSL_VERSION@ +DLL_VERSION = @DLL_VERSION@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EMULTIHOP_HIDDEN = @EMULTIHOP_HIDDEN@ +EMULTIHOP_VALUE = @EMULTIHOP_VALUE@ +ENABLE_PADLOCK = @ENABLE_PADLOCK@ +ENOLINK_HIDDEN = @ENOLINK_HIDDEN@ +ENOLINK_VALUE = @ENOLINK_VALUE@ +EOVERFLOW_HIDDEN = @EOVERFLOW_HIDDEN@ +EOVERFLOW_VALUE = @EOVERFLOW_VALUE@ +ERRNO_H = @ERRNO_H@ +ETAGS = @ETAGS@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +FILECMD = @FILECMD@ +FIPS140_LIBS = @FIPS140_LIBS@ +FLOAT_H = @FLOAT_H@ +GCOV = @GCOV@ +GENHTML = @GENHTML@ +GETADDRINFO_LIB = @GETADDRINFO_LIB@ +GETTEXT_MACRO_VERSION = @GETTEXT_MACRO_VERSION@ +GL_GGL_GNULIB_ACCEPT = @GL_GGL_GNULIB_ACCEPT@ +GL_GGL_GNULIB_ACCEPT4 = @GL_GGL_GNULIB_ACCEPT4@ +GL_GGL_GNULIB_ACCESS = @GL_GGL_GNULIB_ACCESS@ +GL_GGL_GNULIB_ALIGNED_ALLOC = @GL_GGL_GNULIB_ALIGNED_ALLOC@ +GL_GGL_GNULIB_ATOLL = @GL_GGL_GNULIB_ATOLL@ +GL_GGL_GNULIB_BIND = @GL_GGL_GNULIB_BIND@ +GL_GGL_GNULIB_BTOWC = @GL_GGL_GNULIB_BTOWC@ +GL_GGL_GNULIB_CALLOC_POSIX = @GL_GGL_GNULIB_CALLOC_POSIX@ +GL_GGL_GNULIB_CANONICALIZE_FILE_NAME = @GL_GGL_GNULIB_CANONICALIZE_FILE_NAME@ +GL_GGL_GNULIB_CHDIR = @GL_GGL_GNULIB_CHDIR@ +GL_GGL_GNULIB_CHOWN = @GL_GGL_GNULIB_CHOWN@ +GL_GGL_GNULIB_CLOSE = @GL_GGL_GNULIB_CLOSE@ +GL_GGL_GNULIB_CONNECT = @GL_GGL_GNULIB_CONNECT@ +GL_GGL_GNULIB_COPY_FILE_RANGE = @GL_GGL_GNULIB_COPY_FILE_RANGE@ +GL_GGL_GNULIB_CREAT = @GL_GGL_GNULIB_CREAT@ +GL_GGL_GNULIB_CTIME = @GL_GGL_GNULIB_CTIME@ +GL_GGL_GNULIB_DPRINTF = @GL_GGL_GNULIB_DPRINTF@ +GL_GGL_GNULIB_DUP = @GL_GGL_GNULIB_DUP@ +GL_GGL_GNULIB_DUP2 = @GL_GGL_GNULIB_DUP2@ +GL_GGL_GNULIB_DUP3 = @GL_GGL_GNULIB_DUP3@ +GL_GGL_GNULIB_DUPLOCALE = @GL_GGL_GNULIB_DUPLOCALE@ +GL_GGL_GNULIB_ENVIRON = @GL_GGL_GNULIB_ENVIRON@ +GL_GGL_GNULIB_EUIDACCESS = @GL_GGL_GNULIB_EUIDACCESS@ +GL_GGL_GNULIB_EXECL = @GL_GGL_GNULIB_EXECL@ +GL_GGL_GNULIB_EXECLE = @GL_GGL_GNULIB_EXECLE@ +GL_GGL_GNULIB_EXECLP = @GL_GGL_GNULIB_EXECLP@ +GL_GGL_GNULIB_EXECV = @GL_GGL_GNULIB_EXECV@ +GL_GGL_GNULIB_EXECVE = @GL_GGL_GNULIB_EXECVE@ +GL_GGL_GNULIB_EXECVP = @GL_GGL_GNULIB_EXECVP@ +GL_GGL_GNULIB_EXECVPE = @GL_GGL_GNULIB_EXECVPE@ +GL_GGL_GNULIB_EXPLICIT_BZERO = @GL_GGL_GNULIB_EXPLICIT_BZERO@ +GL_GGL_GNULIB_FACCESSAT = @GL_GGL_GNULIB_FACCESSAT@ +GL_GGL_GNULIB_FCHDIR = @GL_GGL_GNULIB_FCHDIR@ +GL_GGL_GNULIB_FCHMODAT = @GL_GGL_GNULIB_FCHMODAT@ +GL_GGL_GNULIB_FCHOWNAT = @GL_GGL_GNULIB_FCHOWNAT@ +GL_GGL_GNULIB_FCLOSE = @GL_GGL_GNULIB_FCLOSE@ +GL_GGL_GNULIB_FCNTL = @GL_GGL_GNULIB_FCNTL@ +GL_GGL_GNULIB_FDATASYNC = @GL_GGL_GNULIB_FDATASYNC@ +GL_GGL_GNULIB_FDOPEN = @GL_GGL_GNULIB_FDOPEN@ +GL_GGL_GNULIB_FFLUSH = @GL_GGL_GNULIB_FFLUSH@ +GL_GGL_GNULIB_FFS = @GL_GGL_GNULIB_FFS@ +GL_GGL_GNULIB_FFSL = @GL_GGL_GNULIB_FFSL@ +GL_GGL_GNULIB_FFSLL = @GL_GGL_GNULIB_FFSLL@ +GL_GGL_GNULIB_FGETC = @GL_GGL_GNULIB_FGETC@ +GL_GGL_GNULIB_FGETS = @GL_GGL_GNULIB_FGETS@ +GL_GGL_GNULIB_FOPEN = @GL_GGL_GNULIB_FOPEN@ +GL_GGL_GNULIB_FPRINTF = @GL_GGL_GNULIB_FPRINTF@ +GL_GGL_GNULIB_FPRINTF_POSIX = @GL_GGL_GNULIB_FPRINTF_POSIX@ +GL_GGL_GNULIB_FPURGE = @GL_GGL_GNULIB_FPURGE@ +GL_GGL_GNULIB_FPUTC = @GL_GGL_GNULIB_FPUTC@ +GL_GGL_GNULIB_FPUTS = @GL_GGL_GNULIB_FPUTS@ +GL_GGL_GNULIB_FREAD = @GL_GGL_GNULIB_FREAD@ +GL_GGL_GNULIB_FREE_POSIX = @GL_GGL_GNULIB_FREE_POSIX@ +GL_GGL_GNULIB_FREOPEN = @GL_GGL_GNULIB_FREOPEN@ +GL_GGL_GNULIB_FSCANF = @GL_GGL_GNULIB_FSCANF@ +GL_GGL_GNULIB_FSEEK = @GL_GGL_GNULIB_FSEEK@ +GL_GGL_GNULIB_FSEEKO = @GL_GGL_GNULIB_FSEEKO@ +GL_GGL_GNULIB_FSTAT = @GL_GGL_GNULIB_FSTAT@ +GL_GGL_GNULIB_FSTATAT = @GL_GGL_GNULIB_FSTATAT@ +GL_GGL_GNULIB_FSYNC = @GL_GGL_GNULIB_FSYNC@ +GL_GGL_GNULIB_FTELL = @GL_GGL_GNULIB_FTELL@ +GL_GGL_GNULIB_FTELLO = @GL_GGL_GNULIB_FTELLO@ +GL_GGL_GNULIB_FTRUNCATE = @GL_GGL_GNULIB_FTRUNCATE@ +GL_GGL_GNULIB_FUTIMENS = @GL_GGL_GNULIB_FUTIMENS@ +GL_GGL_GNULIB_FWRITE = @GL_GGL_GNULIB_FWRITE@ +GL_GGL_GNULIB_GETADDRINFO = @GL_GGL_GNULIB_GETADDRINFO@ +GL_GGL_GNULIB_GETC = @GL_GGL_GNULIB_GETC@ +GL_GGL_GNULIB_GETCHAR = @GL_GGL_GNULIB_GETCHAR@ +GL_GGL_GNULIB_GETCWD = @GL_GGL_GNULIB_GETCWD@ +GL_GGL_GNULIB_GETDELIM = @GL_GGL_GNULIB_GETDELIM@ +GL_GGL_GNULIB_GETDOMAINNAME = @GL_GGL_GNULIB_GETDOMAINNAME@ +GL_GGL_GNULIB_GETDTABLESIZE = @GL_GGL_GNULIB_GETDTABLESIZE@ +GL_GGL_GNULIB_GETENTROPY = @GL_GGL_GNULIB_GETENTROPY@ +GL_GGL_GNULIB_GETGROUPS = @GL_GGL_GNULIB_GETGROUPS@ +GL_GGL_GNULIB_GETHOSTNAME = @GL_GGL_GNULIB_GETHOSTNAME@ +GL_GGL_GNULIB_GETLINE = @GL_GGL_GNULIB_GETLINE@ +GL_GGL_GNULIB_GETLOADAVG = @GL_GGL_GNULIB_GETLOADAVG@ +GL_GGL_GNULIB_GETLOGIN = @GL_GGL_GNULIB_GETLOGIN@ +GL_GGL_GNULIB_GETLOGIN_R = @GL_GGL_GNULIB_GETLOGIN_R@ +GL_GGL_GNULIB_GETOPT_POSIX = @GL_GGL_GNULIB_GETOPT_POSIX@ +GL_GGL_GNULIB_GETPAGESIZE = @GL_GGL_GNULIB_GETPAGESIZE@ +GL_GGL_GNULIB_GETPASS = @GL_GGL_GNULIB_GETPASS@ +GL_GGL_GNULIB_GETPEERNAME = @GL_GGL_GNULIB_GETPEERNAME@ +GL_GGL_GNULIB_GETSOCKNAME = @GL_GGL_GNULIB_GETSOCKNAME@ +GL_GGL_GNULIB_GETSOCKOPT = @GL_GGL_GNULIB_GETSOCKOPT@ +GL_GGL_GNULIB_GETSUBOPT = @GL_GGL_GNULIB_GETSUBOPT@ +GL_GGL_GNULIB_GETTIMEOFDAY = @GL_GGL_GNULIB_GETTIMEOFDAY@ +GL_GGL_GNULIB_GETUMASK = @GL_GGL_GNULIB_GETUMASK@ +GL_GGL_GNULIB_GETUSERSHELL = @GL_GGL_GNULIB_GETUSERSHELL@ +GL_GGL_GNULIB_GRANTPT = @GL_GGL_GNULIB_GRANTPT@ +GL_GGL_GNULIB_GROUP_MEMBER = @GL_GGL_GNULIB_GROUP_MEMBER@ +GL_GGL_GNULIB_IMAXABS = @GL_GGL_GNULIB_IMAXABS@ +GL_GGL_GNULIB_IMAXDIV = @GL_GGL_GNULIB_IMAXDIV@ +GL_GGL_GNULIB_INET_NTOP = @GL_GGL_GNULIB_INET_NTOP@ +GL_GGL_GNULIB_INET_PTON = @GL_GGL_GNULIB_INET_PTON@ +GL_GGL_GNULIB_IOCTL = @GL_GGL_GNULIB_IOCTL@ +GL_GGL_GNULIB_ISATTY = @GL_GGL_GNULIB_ISATTY@ +GL_GGL_GNULIB_ISBLANK = @GL_GGL_GNULIB_ISBLANK@ +GL_GGL_GNULIB_LCHMOD = @GL_GGL_GNULIB_LCHMOD@ +GL_GGL_GNULIB_LCHOWN = @GL_GGL_GNULIB_LCHOWN@ +GL_GGL_GNULIB_LINK = @GL_GGL_GNULIB_LINK@ +GL_GGL_GNULIB_LINKAT = @GL_GGL_GNULIB_LINKAT@ +GL_GGL_GNULIB_LISTEN = @GL_GGL_GNULIB_LISTEN@ +GL_GGL_GNULIB_LOCALECONV = @GL_GGL_GNULIB_LOCALECONV@ +GL_GGL_GNULIB_LOCALENAME = @GL_GGL_GNULIB_LOCALENAME@ +GL_GGL_GNULIB_LOCALTIME = @GL_GGL_GNULIB_LOCALTIME@ +GL_GGL_GNULIB_LSEEK = @GL_GGL_GNULIB_LSEEK@ +GL_GGL_GNULIB_LSTAT = @GL_GGL_GNULIB_LSTAT@ +GL_GGL_GNULIB_MALLOC_POSIX = @GL_GGL_GNULIB_MALLOC_POSIX@ +GL_GGL_GNULIB_MBRLEN = @GL_GGL_GNULIB_MBRLEN@ +GL_GGL_GNULIB_MBRTOWC = @GL_GGL_GNULIB_MBRTOWC@ +GL_GGL_GNULIB_MBSCASECMP = @GL_GGL_GNULIB_MBSCASECMP@ +GL_GGL_GNULIB_MBSCASESTR = @GL_GGL_GNULIB_MBSCASESTR@ +GL_GGL_GNULIB_MBSCHR = @GL_GGL_GNULIB_MBSCHR@ +GL_GGL_GNULIB_MBSCSPN = @GL_GGL_GNULIB_MBSCSPN@ +GL_GGL_GNULIB_MBSINIT = @GL_GGL_GNULIB_MBSINIT@ +GL_GGL_GNULIB_MBSLEN = @GL_GGL_GNULIB_MBSLEN@ +GL_GGL_GNULIB_MBSNCASECMP = @GL_GGL_GNULIB_MBSNCASECMP@ +GL_GGL_GNULIB_MBSNLEN = @GL_GGL_GNULIB_MBSNLEN@ +GL_GGL_GNULIB_MBSNRTOWCS = @GL_GGL_GNULIB_MBSNRTOWCS@ +GL_GGL_GNULIB_MBSPBRK = @GL_GGL_GNULIB_MBSPBRK@ +GL_GGL_GNULIB_MBSPCASECMP = @GL_GGL_GNULIB_MBSPCASECMP@ +GL_GGL_GNULIB_MBSRCHR = @GL_GGL_GNULIB_MBSRCHR@ +GL_GGL_GNULIB_MBSRTOWCS = @GL_GGL_GNULIB_MBSRTOWCS@ +GL_GGL_GNULIB_MBSSEP = @GL_GGL_GNULIB_MBSSEP@ +GL_GGL_GNULIB_MBSSPN = @GL_GGL_GNULIB_MBSSPN@ +GL_GGL_GNULIB_MBSSTR = @GL_GGL_GNULIB_MBSSTR@ +GL_GGL_GNULIB_MBSTOK_R = @GL_GGL_GNULIB_MBSTOK_R@ +GL_GGL_GNULIB_MBTOWC = @GL_GGL_GNULIB_MBTOWC@ +GL_GGL_GNULIB_MDA_ACCESS = @GL_GGL_GNULIB_MDA_ACCESS@ +GL_GGL_GNULIB_MDA_CHDIR = @GL_GGL_GNULIB_MDA_CHDIR@ +GL_GGL_GNULIB_MDA_CHMOD = @GL_GGL_GNULIB_MDA_CHMOD@ +GL_GGL_GNULIB_MDA_CLOSE = @GL_GGL_GNULIB_MDA_CLOSE@ +GL_GGL_GNULIB_MDA_CREAT = @GL_GGL_GNULIB_MDA_CREAT@ +GL_GGL_GNULIB_MDA_DUP = @GL_GGL_GNULIB_MDA_DUP@ +GL_GGL_GNULIB_MDA_DUP2 = @GL_GGL_GNULIB_MDA_DUP2@ +GL_GGL_GNULIB_MDA_ECVT = @GL_GGL_GNULIB_MDA_ECVT@ +GL_GGL_GNULIB_MDA_EXECL = @GL_GGL_GNULIB_MDA_EXECL@ +GL_GGL_GNULIB_MDA_EXECLE = @GL_GGL_GNULIB_MDA_EXECLE@ +GL_GGL_GNULIB_MDA_EXECLP = @GL_GGL_GNULIB_MDA_EXECLP@ +GL_GGL_GNULIB_MDA_EXECV = @GL_GGL_GNULIB_MDA_EXECV@ +GL_GGL_GNULIB_MDA_EXECVE = @GL_GGL_GNULIB_MDA_EXECVE@ +GL_GGL_GNULIB_MDA_EXECVP = @GL_GGL_GNULIB_MDA_EXECVP@ +GL_GGL_GNULIB_MDA_EXECVPE = @GL_GGL_GNULIB_MDA_EXECVPE@ +GL_GGL_GNULIB_MDA_FCLOSEALL = @GL_GGL_GNULIB_MDA_FCLOSEALL@ +GL_GGL_GNULIB_MDA_FCVT = @GL_GGL_GNULIB_MDA_FCVT@ +GL_GGL_GNULIB_MDA_FDOPEN = @GL_GGL_GNULIB_MDA_FDOPEN@ +GL_GGL_GNULIB_MDA_FILENO = @GL_GGL_GNULIB_MDA_FILENO@ +GL_GGL_GNULIB_MDA_GCVT = @GL_GGL_GNULIB_MDA_GCVT@ +GL_GGL_GNULIB_MDA_GETCWD = @GL_GGL_GNULIB_MDA_GETCWD@ +GL_GGL_GNULIB_MDA_GETPID = @GL_GGL_GNULIB_MDA_GETPID@ +GL_GGL_GNULIB_MDA_GETW = @GL_GGL_GNULIB_MDA_GETW@ +GL_GGL_GNULIB_MDA_ISATTY = @GL_GGL_GNULIB_MDA_ISATTY@ +GL_GGL_GNULIB_MDA_LSEEK = @GL_GGL_GNULIB_MDA_LSEEK@ +GL_GGL_GNULIB_MDA_MEMCCPY = @GL_GGL_GNULIB_MDA_MEMCCPY@ +GL_GGL_GNULIB_MDA_MKDIR = @GL_GGL_GNULIB_MDA_MKDIR@ +GL_GGL_GNULIB_MDA_MKTEMP = @GL_GGL_GNULIB_MDA_MKTEMP@ +GL_GGL_GNULIB_MDA_OPEN = @GL_GGL_GNULIB_MDA_OPEN@ +GL_GGL_GNULIB_MDA_PUTENV = @GL_GGL_GNULIB_MDA_PUTENV@ +GL_GGL_GNULIB_MDA_PUTW = @GL_GGL_GNULIB_MDA_PUTW@ +GL_GGL_GNULIB_MDA_READ = @GL_GGL_GNULIB_MDA_READ@ +GL_GGL_GNULIB_MDA_RMDIR = @GL_GGL_GNULIB_MDA_RMDIR@ +GL_GGL_GNULIB_MDA_STRDUP = @GL_GGL_GNULIB_MDA_STRDUP@ +GL_GGL_GNULIB_MDA_SWAB = @GL_GGL_GNULIB_MDA_SWAB@ +GL_GGL_GNULIB_MDA_TEMPNAM = @GL_GGL_GNULIB_MDA_TEMPNAM@ +GL_GGL_GNULIB_MDA_TZSET = @GL_GGL_GNULIB_MDA_TZSET@ +GL_GGL_GNULIB_MDA_UMASK = @GL_GGL_GNULIB_MDA_UMASK@ +GL_GGL_GNULIB_MDA_UNLINK = @GL_GGL_GNULIB_MDA_UNLINK@ +GL_GGL_GNULIB_MDA_WCSDUP = @GL_GGL_GNULIB_MDA_WCSDUP@ +GL_GGL_GNULIB_MDA_WRITE = @GL_GGL_GNULIB_MDA_WRITE@ +GL_GGL_GNULIB_MEMCHR = @GL_GGL_GNULIB_MEMCHR@ +GL_GGL_GNULIB_MEMMEM = @GL_GGL_GNULIB_MEMMEM@ +GL_GGL_GNULIB_MEMPCPY = @GL_GGL_GNULIB_MEMPCPY@ +GL_GGL_GNULIB_MEMRCHR = @GL_GGL_GNULIB_MEMRCHR@ +GL_GGL_GNULIB_MKDIR = @GL_GGL_GNULIB_MKDIR@ +GL_GGL_GNULIB_MKDIRAT = @GL_GGL_GNULIB_MKDIRAT@ +GL_GGL_GNULIB_MKDTEMP = @GL_GGL_GNULIB_MKDTEMP@ +GL_GGL_GNULIB_MKFIFO = @GL_GGL_GNULIB_MKFIFO@ +GL_GGL_GNULIB_MKFIFOAT = @GL_GGL_GNULIB_MKFIFOAT@ +GL_GGL_GNULIB_MKNOD = @GL_GGL_GNULIB_MKNOD@ +GL_GGL_GNULIB_MKNODAT = @GL_GGL_GNULIB_MKNODAT@ +GL_GGL_GNULIB_MKOSTEMP = @GL_GGL_GNULIB_MKOSTEMP@ +GL_GGL_GNULIB_MKOSTEMPS = @GL_GGL_GNULIB_MKOSTEMPS@ +GL_GGL_GNULIB_MKSTEMP = @GL_GGL_GNULIB_MKSTEMP@ +GL_GGL_GNULIB_MKSTEMPS = @GL_GGL_GNULIB_MKSTEMPS@ +GL_GGL_GNULIB_MKTIME = @GL_GGL_GNULIB_MKTIME@ +GL_GGL_GNULIB_NANOSLEEP = @GL_GGL_GNULIB_NANOSLEEP@ +GL_GGL_GNULIB_NL_LANGINFO = @GL_GGL_GNULIB_NL_LANGINFO@ +GL_GGL_GNULIB_NONBLOCKING = @GL_GGL_GNULIB_NONBLOCKING@ +GL_GGL_GNULIB_OBSTACK_PRINTF = @GL_GGL_GNULIB_OBSTACK_PRINTF@ +GL_GGL_GNULIB_OBSTACK_PRINTF_POSIX = @GL_GGL_GNULIB_OBSTACK_PRINTF_POSIX@ +GL_GGL_GNULIB_OPEN = @GL_GGL_GNULIB_OPEN@ +GL_GGL_GNULIB_OPENAT = @GL_GGL_GNULIB_OPENAT@ +GL_GGL_GNULIB_OVERRIDES_STRUCT_STAT = @GL_GGL_GNULIB_OVERRIDES_STRUCT_STAT@ +GL_GGL_GNULIB_PCLOSE = @GL_GGL_GNULIB_PCLOSE@ +GL_GGL_GNULIB_PERROR = @GL_GGL_GNULIB_PERROR@ +GL_GGL_GNULIB_PIPE = @GL_GGL_GNULIB_PIPE@ +GL_GGL_GNULIB_PIPE2 = @GL_GGL_GNULIB_PIPE2@ +GL_GGL_GNULIB_POPEN = @GL_GGL_GNULIB_POPEN@ +GL_GGL_GNULIB_POSIX_MEMALIGN = @GL_GGL_GNULIB_POSIX_MEMALIGN@ +GL_GGL_GNULIB_POSIX_OPENPT = @GL_GGL_GNULIB_POSIX_OPENPT@ +GL_GGL_GNULIB_PREAD = @GL_GGL_GNULIB_PREAD@ +GL_GGL_GNULIB_PRINTF = @GL_GGL_GNULIB_PRINTF@ +GL_GGL_GNULIB_PRINTF_POSIX = @GL_GGL_GNULIB_PRINTF_POSIX@ +GL_GGL_GNULIB_PSELECT = @GL_GGL_GNULIB_PSELECT@ +GL_GGL_GNULIB_PTHREAD_COND = @GL_GGL_GNULIB_PTHREAD_COND@ +GL_GGL_GNULIB_PTHREAD_MUTEX = @GL_GGL_GNULIB_PTHREAD_MUTEX@ +GL_GGL_GNULIB_PTHREAD_MUTEX_TIMEDLOCK = @GL_GGL_GNULIB_PTHREAD_MUTEX_TIMEDLOCK@ +GL_GGL_GNULIB_PTHREAD_ONCE = @GL_GGL_GNULIB_PTHREAD_ONCE@ +GL_GGL_GNULIB_PTHREAD_RWLOCK = @GL_GGL_GNULIB_PTHREAD_RWLOCK@ +GL_GGL_GNULIB_PTHREAD_SIGMASK = @GL_GGL_GNULIB_PTHREAD_SIGMASK@ +GL_GGL_GNULIB_PTHREAD_SPIN = @GL_GGL_GNULIB_PTHREAD_SPIN@ +GL_GGL_GNULIB_PTHREAD_THREAD = @GL_GGL_GNULIB_PTHREAD_THREAD@ +GL_GGL_GNULIB_PTHREAD_TSS = @GL_GGL_GNULIB_PTHREAD_TSS@ +GL_GGL_GNULIB_PTSNAME = @GL_GGL_GNULIB_PTSNAME@ +GL_GGL_GNULIB_PTSNAME_R = @GL_GGL_GNULIB_PTSNAME_R@ +GL_GGL_GNULIB_PUTC = @GL_GGL_GNULIB_PUTC@ +GL_GGL_GNULIB_PUTCHAR = @GL_GGL_GNULIB_PUTCHAR@ +GL_GGL_GNULIB_PUTENV = @GL_GGL_GNULIB_PUTENV@ +GL_GGL_GNULIB_PUTS = @GL_GGL_GNULIB_PUTS@ +GL_GGL_GNULIB_PWRITE = @GL_GGL_GNULIB_PWRITE@ +GL_GGL_GNULIB_QSORT_R = @GL_GGL_GNULIB_QSORT_R@ +GL_GGL_GNULIB_RAISE = @GL_GGL_GNULIB_RAISE@ +GL_GGL_GNULIB_RANDOM = @GL_GGL_GNULIB_RANDOM@ +GL_GGL_GNULIB_RANDOM_R = @GL_GGL_GNULIB_RANDOM_R@ +GL_GGL_GNULIB_RAWMEMCHR = @GL_GGL_GNULIB_RAWMEMCHR@ +GL_GGL_GNULIB_READ = @GL_GGL_GNULIB_READ@ +GL_GGL_GNULIB_READLINK = @GL_GGL_GNULIB_READLINK@ +GL_GGL_GNULIB_READLINKAT = @GL_GGL_GNULIB_READLINKAT@ +GL_GGL_GNULIB_REALLOCARRAY = @GL_GGL_GNULIB_REALLOCARRAY@ +GL_GGL_GNULIB_REALLOC_POSIX = @GL_GGL_GNULIB_REALLOC_POSIX@ +GL_GGL_GNULIB_REALPATH = @GL_GGL_GNULIB_REALPATH@ +GL_GGL_GNULIB_RECV = @GL_GGL_GNULIB_RECV@ +GL_GGL_GNULIB_RECVFROM = @GL_GGL_GNULIB_RECVFROM@ +GL_GGL_GNULIB_REMOVE = @GL_GGL_GNULIB_REMOVE@ +GL_GGL_GNULIB_RENAME = @GL_GGL_GNULIB_RENAME@ +GL_GGL_GNULIB_RENAMEAT = @GL_GGL_GNULIB_RENAMEAT@ +GL_GGL_GNULIB_RMDIR = @GL_GGL_GNULIB_RMDIR@ +GL_GGL_GNULIB_RPMATCH = @GL_GGL_GNULIB_RPMATCH@ +GL_GGL_GNULIB_SCANF = @GL_GGL_GNULIB_SCANF@ +GL_GGL_GNULIB_SCHED_YIELD = @GL_GGL_GNULIB_SCHED_YIELD@ +GL_GGL_GNULIB_SECURE_GETENV = @GL_GGL_GNULIB_SECURE_GETENV@ +GL_GGL_GNULIB_SELECT = @GL_GGL_GNULIB_SELECT@ +GL_GGL_GNULIB_SEND = @GL_GGL_GNULIB_SEND@ +GL_GGL_GNULIB_SENDTO = @GL_GGL_GNULIB_SENDTO@ +GL_GGL_GNULIB_SETENV = @GL_GGL_GNULIB_SETENV@ +GL_GGL_GNULIB_SETHOSTNAME = @GL_GGL_GNULIB_SETHOSTNAME@ +GL_GGL_GNULIB_SETLOCALE = @GL_GGL_GNULIB_SETLOCALE@ +GL_GGL_GNULIB_SETLOCALE_NULL = @GL_GGL_GNULIB_SETLOCALE_NULL@ +GL_GGL_GNULIB_SETSOCKOPT = @GL_GGL_GNULIB_SETSOCKOPT@ +GL_GGL_GNULIB_SHUTDOWN = @GL_GGL_GNULIB_SHUTDOWN@ +GL_GGL_GNULIB_SIGABBREV_NP = @GL_GGL_GNULIB_SIGABBREV_NP@ +GL_GGL_GNULIB_SIGACTION = @GL_GGL_GNULIB_SIGACTION@ +GL_GGL_GNULIB_SIGDESCR_NP = @GL_GGL_GNULIB_SIGDESCR_NP@ +GL_GGL_GNULIB_SIGNAL_H_SIGPIPE = @GL_GGL_GNULIB_SIGNAL_H_SIGPIPE@ +GL_GGL_GNULIB_SIGPROCMASK = @GL_GGL_GNULIB_SIGPROCMASK@ +GL_GGL_GNULIB_SLEEP = @GL_GGL_GNULIB_SLEEP@ +GL_GGL_GNULIB_SNPRINTF = @GL_GGL_GNULIB_SNPRINTF@ +GL_GGL_GNULIB_SOCKET = @GL_GGL_GNULIB_SOCKET@ +GL_GGL_GNULIB_SPRINTF_POSIX = @GL_GGL_GNULIB_SPRINTF_POSIX@ +GL_GGL_GNULIB_STAT = @GL_GGL_GNULIB_STAT@ +GL_GGL_GNULIB_STDIO_H_NONBLOCKING = @GL_GGL_GNULIB_STDIO_H_NONBLOCKING@ +GL_GGL_GNULIB_STDIO_H_SIGPIPE = @GL_GGL_GNULIB_STDIO_H_SIGPIPE@ +GL_GGL_GNULIB_STPCPY = @GL_GGL_GNULIB_STPCPY@ +GL_GGL_GNULIB_STPNCPY = @GL_GGL_GNULIB_STPNCPY@ +GL_GGL_GNULIB_STRCASESTR = @GL_GGL_GNULIB_STRCASESTR@ +GL_GGL_GNULIB_STRCHRNUL = @GL_GGL_GNULIB_STRCHRNUL@ +GL_GGL_GNULIB_STRDUP = @GL_GGL_GNULIB_STRDUP@ +GL_GGL_GNULIB_STRERROR = @GL_GGL_GNULIB_STRERROR@ +GL_GGL_GNULIB_STRERRORNAME_NP = @GL_GGL_GNULIB_STRERRORNAME_NP@ +GL_GGL_GNULIB_STRERROR_R = @GL_GGL_GNULIB_STRERROR_R@ +GL_GGL_GNULIB_STRFTIME = @GL_GGL_GNULIB_STRFTIME@ +GL_GGL_GNULIB_STRNCAT = @GL_GGL_GNULIB_STRNCAT@ +GL_GGL_GNULIB_STRNDUP = @GL_GGL_GNULIB_STRNDUP@ +GL_GGL_GNULIB_STRNLEN = @GL_GGL_GNULIB_STRNLEN@ +GL_GGL_GNULIB_STRPBRK = @GL_GGL_GNULIB_STRPBRK@ +GL_GGL_GNULIB_STRPTIME = @GL_GGL_GNULIB_STRPTIME@ +GL_GGL_GNULIB_STRSEP = @GL_GGL_GNULIB_STRSEP@ +GL_GGL_GNULIB_STRSIGNAL = @GL_GGL_GNULIB_STRSIGNAL@ +GL_GGL_GNULIB_STRSTR = @GL_GGL_GNULIB_STRSTR@ +GL_GGL_GNULIB_STRTOD = @GL_GGL_GNULIB_STRTOD@ +GL_GGL_GNULIB_STRTOIMAX = @GL_GGL_GNULIB_STRTOIMAX@ +GL_GGL_GNULIB_STRTOK_R = @GL_GGL_GNULIB_STRTOK_R@ +GL_GGL_GNULIB_STRTOL = @GL_GGL_GNULIB_STRTOL@ +GL_GGL_GNULIB_STRTOLD = @GL_GGL_GNULIB_STRTOLD@ +GL_GGL_GNULIB_STRTOLL = @GL_GGL_GNULIB_STRTOLL@ +GL_GGL_GNULIB_STRTOUL = @GL_GGL_GNULIB_STRTOUL@ +GL_GGL_GNULIB_STRTOULL = @GL_GGL_GNULIB_STRTOULL@ +GL_GGL_GNULIB_STRTOUMAX = @GL_GGL_GNULIB_STRTOUMAX@ +GL_GGL_GNULIB_STRVERSCMP = @GL_GGL_GNULIB_STRVERSCMP@ +GL_GGL_GNULIB_SYMLINK = @GL_GGL_GNULIB_SYMLINK@ +GL_GGL_GNULIB_SYMLINKAT = @GL_GGL_GNULIB_SYMLINKAT@ +GL_GGL_GNULIB_SYSTEM_POSIX = @GL_GGL_GNULIB_SYSTEM_POSIX@ +GL_GGL_GNULIB_TIMEGM = @GL_GGL_GNULIB_TIMEGM@ +GL_GGL_GNULIB_TIMESPEC_GET = @GL_GGL_GNULIB_TIMESPEC_GET@ +GL_GGL_GNULIB_TIME_R = @GL_GGL_GNULIB_TIME_R@ +GL_GGL_GNULIB_TIME_RZ = @GL_GGL_GNULIB_TIME_RZ@ +GL_GGL_GNULIB_TMPFILE = @GL_GGL_GNULIB_TMPFILE@ +GL_GGL_GNULIB_TRUNCATE = @GL_GGL_GNULIB_TRUNCATE@ +GL_GGL_GNULIB_TTYNAME_R = @GL_GGL_GNULIB_TTYNAME_R@ +GL_GGL_GNULIB_TZSET = @GL_GGL_GNULIB_TZSET@ +GL_GGL_GNULIB_UNISTD_H_NONBLOCKING = @GL_GGL_GNULIB_UNISTD_H_NONBLOCKING@ +GL_GGL_GNULIB_UNISTD_H_SIGPIPE = @GL_GGL_GNULIB_UNISTD_H_SIGPIPE@ +GL_GGL_GNULIB_UNLINK = @GL_GGL_GNULIB_UNLINK@ +GL_GGL_GNULIB_UNLINKAT = @GL_GGL_GNULIB_UNLINKAT@ +GL_GGL_GNULIB_UNLOCKPT = @GL_GGL_GNULIB_UNLOCKPT@ +GL_GGL_GNULIB_UNSETENV = @GL_GGL_GNULIB_UNSETENV@ +GL_GGL_GNULIB_USLEEP = @GL_GGL_GNULIB_USLEEP@ +GL_GGL_GNULIB_UTIMENSAT = @GL_GGL_GNULIB_UTIMENSAT@ +GL_GGL_GNULIB_VASPRINTF = @GL_GGL_GNULIB_VASPRINTF@ +GL_GGL_GNULIB_VDPRINTF = @GL_GGL_GNULIB_VDPRINTF@ +GL_GGL_GNULIB_VFPRINTF = @GL_GGL_GNULIB_VFPRINTF@ +GL_GGL_GNULIB_VFPRINTF_POSIX = @GL_GGL_GNULIB_VFPRINTF_POSIX@ +GL_GGL_GNULIB_VFSCANF = @GL_GGL_GNULIB_VFSCANF@ +GL_GGL_GNULIB_VPRINTF = @GL_GGL_GNULIB_VPRINTF@ +GL_GGL_GNULIB_VPRINTF_POSIX = @GL_GGL_GNULIB_VPRINTF_POSIX@ +GL_GGL_GNULIB_VSCANF = @GL_GGL_GNULIB_VSCANF@ +GL_GGL_GNULIB_VSNPRINTF = @GL_GGL_GNULIB_VSNPRINTF@ +GL_GGL_GNULIB_VSPRINTF_POSIX = @GL_GGL_GNULIB_VSPRINTF_POSIX@ +GL_GGL_GNULIB_WCPCPY = @GL_GGL_GNULIB_WCPCPY@ +GL_GGL_GNULIB_WCPNCPY = @GL_GGL_GNULIB_WCPNCPY@ +GL_GGL_GNULIB_WCRTOMB = @GL_GGL_GNULIB_WCRTOMB@ +GL_GGL_GNULIB_WCSCASECMP = @GL_GGL_GNULIB_WCSCASECMP@ +GL_GGL_GNULIB_WCSCAT = @GL_GGL_GNULIB_WCSCAT@ +GL_GGL_GNULIB_WCSCHR = @GL_GGL_GNULIB_WCSCHR@ +GL_GGL_GNULIB_WCSCMP = @GL_GGL_GNULIB_WCSCMP@ +GL_GGL_GNULIB_WCSCOLL = @GL_GGL_GNULIB_WCSCOLL@ +GL_GGL_GNULIB_WCSCPY = @GL_GGL_GNULIB_WCSCPY@ +GL_GGL_GNULIB_WCSCSPN = @GL_GGL_GNULIB_WCSCSPN@ +GL_GGL_GNULIB_WCSDUP = @GL_GGL_GNULIB_WCSDUP@ +GL_GGL_GNULIB_WCSFTIME = @GL_GGL_GNULIB_WCSFTIME@ +GL_GGL_GNULIB_WCSLEN = @GL_GGL_GNULIB_WCSLEN@ +GL_GGL_GNULIB_WCSNCASECMP = @GL_GGL_GNULIB_WCSNCASECMP@ +GL_GGL_GNULIB_WCSNCAT = @GL_GGL_GNULIB_WCSNCAT@ +GL_GGL_GNULIB_WCSNCMP = @GL_GGL_GNULIB_WCSNCMP@ +GL_GGL_GNULIB_WCSNCPY = @GL_GGL_GNULIB_WCSNCPY@ +GL_GGL_GNULIB_WCSNLEN = @GL_GGL_GNULIB_WCSNLEN@ +GL_GGL_GNULIB_WCSNRTOMBS = @GL_GGL_GNULIB_WCSNRTOMBS@ +GL_GGL_GNULIB_WCSPBRK = @GL_GGL_GNULIB_WCSPBRK@ +GL_GGL_GNULIB_WCSRCHR = @GL_GGL_GNULIB_WCSRCHR@ +GL_GGL_GNULIB_WCSRTOMBS = @GL_GGL_GNULIB_WCSRTOMBS@ +GL_GGL_GNULIB_WCSSPN = @GL_GGL_GNULIB_WCSSPN@ +GL_GGL_GNULIB_WCSSTR = @GL_GGL_GNULIB_WCSSTR@ +GL_GGL_GNULIB_WCSTOK = @GL_GGL_GNULIB_WCSTOK@ +GL_GGL_GNULIB_WCSWIDTH = @GL_GGL_GNULIB_WCSWIDTH@ +GL_GGL_GNULIB_WCSXFRM = @GL_GGL_GNULIB_WCSXFRM@ +GL_GGL_GNULIB_WCTOB = @GL_GGL_GNULIB_WCTOB@ +GL_GGL_GNULIB_WCTOMB = @GL_GGL_GNULIB_WCTOMB@ +GL_GGL_GNULIB_WCWIDTH = @GL_GGL_GNULIB_WCWIDTH@ +GL_GGL_GNULIB_WMEMCHR = @GL_GGL_GNULIB_WMEMCHR@ +GL_GGL_GNULIB_WMEMCMP = @GL_GGL_GNULIB_WMEMCMP@ +GL_GGL_GNULIB_WMEMCPY = @GL_GGL_GNULIB_WMEMCPY@ +GL_GGL_GNULIB_WMEMMOVE = @GL_GGL_GNULIB_WMEMMOVE@ +GL_GGL_GNULIB_WMEMPCPY = @GL_GGL_GNULIB_WMEMPCPY@ +GL_GGL_GNULIB_WMEMSET = @GL_GGL_GNULIB_WMEMSET@ +GL_GGL_GNULIB_WRITE = @GL_GGL_GNULIB_WRITE@ +GL_GGL_GNULIB__EXIT = @GL_GGL_GNULIB__EXIT@ +GL_GNULIB_ACCEPT = @GL_GNULIB_ACCEPT@ +GL_GNULIB_ACCEPT4 = @GL_GNULIB_ACCEPT4@ +GL_GNULIB_ACCESS = @GL_GNULIB_ACCESS@ +GL_GNULIB_ALIGNED_ALLOC = @GL_GNULIB_ALIGNED_ALLOC@ +GL_GNULIB_ATOLL = @GL_GNULIB_ATOLL@ +GL_GNULIB_BIND = @GL_GNULIB_BIND@ +GL_GNULIB_BTOWC = @GL_GNULIB_BTOWC@ +GL_GNULIB_CALLOC_POSIX = @GL_GNULIB_CALLOC_POSIX@ +GL_GNULIB_CANONICALIZE_FILE_NAME = @GL_GNULIB_CANONICALIZE_FILE_NAME@ +GL_GNULIB_CHDIR = @GL_GNULIB_CHDIR@ +GL_GNULIB_CHOWN = @GL_GNULIB_CHOWN@ +GL_GNULIB_CLOSE = @GL_GNULIB_CLOSE@ +GL_GNULIB_CONNECT = @GL_GNULIB_CONNECT@ +GL_GNULIB_COPY_FILE_RANGE = @GL_GNULIB_COPY_FILE_RANGE@ +GL_GNULIB_CREAT = @GL_GNULIB_CREAT@ +GL_GNULIB_CTIME = @GL_GNULIB_CTIME@ +GL_GNULIB_DPRINTF = @GL_GNULIB_DPRINTF@ +GL_GNULIB_DUP = @GL_GNULIB_DUP@ +GL_GNULIB_DUP2 = @GL_GNULIB_DUP2@ +GL_GNULIB_DUP3 = @GL_GNULIB_DUP3@ +GL_GNULIB_ENVIRON = @GL_GNULIB_ENVIRON@ +GL_GNULIB_EUIDACCESS = @GL_GNULIB_EUIDACCESS@ +GL_GNULIB_EXECL = @GL_GNULIB_EXECL@ +GL_GNULIB_EXECLE = @GL_GNULIB_EXECLE@ +GL_GNULIB_EXECLP = @GL_GNULIB_EXECLP@ +GL_GNULIB_EXECV = @GL_GNULIB_EXECV@ +GL_GNULIB_EXECVE = @GL_GNULIB_EXECVE@ +GL_GNULIB_EXECVP = @GL_GNULIB_EXECVP@ +GL_GNULIB_EXECVPE = @GL_GNULIB_EXECVPE@ +GL_GNULIB_EXPLICIT_BZERO = @GL_GNULIB_EXPLICIT_BZERO@ +GL_GNULIB_FACCESSAT = @GL_GNULIB_FACCESSAT@ +GL_GNULIB_FCHDIR = @GL_GNULIB_FCHDIR@ +GL_GNULIB_FCHMODAT = @GL_GNULIB_FCHMODAT@ +GL_GNULIB_FCHOWNAT = @GL_GNULIB_FCHOWNAT@ +GL_GNULIB_FCLOSE = @GL_GNULIB_FCLOSE@ +GL_GNULIB_FCNTL = @GL_GNULIB_FCNTL@ +GL_GNULIB_FDATASYNC = @GL_GNULIB_FDATASYNC@ +GL_GNULIB_FDOPEN = @GL_GNULIB_FDOPEN@ +GL_GNULIB_FFLUSH = @GL_GNULIB_FFLUSH@ +GL_GNULIB_FFS = @GL_GNULIB_FFS@ +GL_GNULIB_FFSL = @GL_GNULIB_FFSL@ +GL_GNULIB_FFSLL = @GL_GNULIB_FFSLL@ +GL_GNULIB_FGETC = @GL_GNULIB_FGETC@ +GL_GNULIB_FGETS = @GL_GNULIB_FGETS@ +GL_GNULIB_FOPEN = @GL_GNULIB_FOPEN@ +GL_GNULIB_FPRINTF = @GL_GNULIB_FPRINTF@ +GL_GNULIB_FPRINTF_POSIX = @GL_GNULIB_FPRINTF_POSIX@ +GL_GNULIB_FPURGE = @GL_GNULIB_FPURGE@ +GL_GNULIB_FPUTC = @GL_GNULIB_FPUTC@ +GL_GNULIB_FPUTS = @GL_GNULIB_FPUTS@ +GL_GNULIB_FREAD = @GL_GNULIB_FREAD@ +GL_GNULIB_FREE_POSIX = @GL_GNULIB_FREE_POSIX@ +GL_GNULIB_FREOPEN = @GL_GNULIB_FREOPEN@ +GL_GNULIB_FSCANF = @GL_GNULIB_FSCANF@ +GL_GNULIB_FSEEK = @GL_GNULIB_FSEEK@ +GL_GNULIB_FSEEKO = @GL_GNULIB_FSEEKO@ +GL_GNULIB_FSTAT = @GL_GNULIB_FSTAT@ +GL_GNULIB_FSTATAT = @GL_GNULIB_FSTATAT@ +GL_GNULIB_FSYNC = @GL_GNULIB_FSYNC@ +GL_GNULIB_FTELL = @GL_GNULIB_FTELL@ +GL_GNULIB_FTELLO = @GL_GNULIB_FTELLO@ +GL_GNULIB_FTRUNCATE = @GL_GNULIB_FTRUNCATE@ +GL_GNULIB_FUTIMENS = @GL_GNULIB_FUTIMENS@ +GL_GNULIB_FWRITE = @GL_GNULIB_FWRITE@ +GL_GNULIB_GETADDRINFO = @GL_GNULIB_GETADDRINFO@ +GL_GNULIB_GETC = @GL_GNULIB_GETC@ +GL_GNULIB_GETCHAR = @GL_GNULIB_GETCHAR@ +GL_GNULIB_GETCWD = @GL_GNULIB_GETCWD@ +GL_GNULIB_GETDELIM = @GL_GNULIB_GETDELIM@ +GL_GNULIB_GETDOMAINNAME = @GL_GNULIB_GETDOMAINNAME@ +GL_GNULIB_GETDTABLESIZE = @GL_GNULIB_GETDTABLESIZE@ +GL_GNULIB_GETENTROPY = @GL_GNULIB_GETENTROPY@ +GL_GNULIB_GETGROUPS = @GL_GNULIB_GETGROUPS@ +GL_GNULIB_GETHOSTNAME = @GL_GNULIB_GETHOSTNAME@ +GL_GNULIB_GETLINE = @GL_GNULIB_GETLINE@ +GL_GNULIB_GETLOADAVG = @GL_GNULIB_GETLOADAVG@ +GL_GNULIB_GETLOGIN = @GL_GNULIB_GETLOGIN@ +GL_GNULIB_GETLOGIN_R = @GL_GNULIB_GETLOGIN_R@ +GL_GNULIB_GETOPT_POSIX = @GL_GNULIB_GETOPT_POSIX@ +GL_GNULIB_GETPAGESIZE = @GL_GNULIB_GETPAGESIZE@ +GL_GNULIB_GETPASS = @GL_GNULIB_GETPASS@ +GL_GNULIB_GETPEERNAME = @GL_GNULIB_GETPEERNAME@ +GL_GNULIB_GETSOCKNAME = @GL_GNULIB_GETSOCKNAME@ +GL_GNULIB_GETSOCKOPT = @GL_GNULIB_GETSOCKOPT@ +GL_GNULIB_GETSUBOPT = @GL_GNULIB_GETSUBOPT@ +GL_GNULIB_GETTIMEOFDAY = @GL_GNULIB_GETTIMEOFDAY@ +GL_GNULIB_GETUMASK = @GL_GNULIB_GETUMASK@ +GL_GNULIB_GETUSERSHELL = @GL_GNULIB_GETUSERSHELL@ +GL_GNULIB_GRANTPT = @GL_GNULIB_GRANTPT@ +GL_GNULIB_GROUP_MEMBER = @GL_GNULIB_GROUP_MEMBER@ +GL_GNULIB_IMAXABS = @GL_GNULIB_IMAXABS@ +GL_GNULIB_IMAXDIV = @GL_GNULIB_IMAXDIV@ +GL_GNULIB_INET_NTOP = @GL_GNULIB_INET_NTOP@ +GL_GNULIB_INET_PTON = @GL_GNULIB_INET_PTON@ +GL_GNULIB_ISATTY = @GL_GNULIB_ISATTY@ +GL_GNULIB_LCHMOD = @GL_GNULIB_LCHMOD@ +GL_GNULIB_LCHOWN = @GL_GNULIB_LCHOWN@ +GL_GNULIB_LINK = @GL_GNULIB_LINK@ +GL_GNULIB_LINKAT = @GL_GNULIB_LINKAT@ +GL_GNULIB_LISTEN = @GL_GNULIB_LISTEN@ +GL_GNULIB_LOCALTIME = @GL_GNULIB_LOCALTIME@ +GL_GNULIB_LSEEK = @GL_GNULIB_LSEEK@ +GL_GNULIB_LSTAT = @GL_GNULIB_LSTAT@ +GL_GNULIB_MALLOC_POSIX = @GL_GNULIB_MALLOC_POSIX@ +GL_GNULIB_MBRLEN = @GL_GNULIB_MBRLEN@ +GL_GNULIB_MBRTOWC = @GL_GNULIB_MBRTOWC@ +GL_GNULIB_MBSCASECMP = @GL_GNULIB_MBSCASECMP@ +GL_GNULIB_MBSCASESTR = @GL_GNULIB_MBSCASESTR@ +GL_GNULIB_MBSCHR = @GL_GNULIB_MBSCHR@ +GL_GNULIB_MBSCSPN = @GL_GNULIB_MBSCSPN@ +GL_GNULIB_MBSINIT = @GL_GNULIB_MBSINIT@ +GL_GNULIB_MBSLEN = @GL_GNULIB_MBSLEN@ +GL_GNULIB_MBSNCASECMP = @GL_GNULIB_MBSNCASECMP@ +GL_GNULIB_MBSNLEN = @GL_GNULIB_MBSNLEN@ +GL_GNULIB_MBSNRTOWCS = @GL_GNULIB_MBSNRTOWCS@ +GL_GNULIB_MBSPBRK = @GL_GNULIB_MBSPBRK@ +GL_GNULIB_MBSPCASECMP = @GL_GNULIB_MBSPCASECMP@ +GL_GNULIB_MBSRCHR = @GL_GNULIB_MBSRCHR@ +GL_GNULIB_MBSRTOWCS = @GL_GNULIB_MBSRTOWCS@ +GL_GNULIB_MBSSEP = @GL_GNULIB_MBSSEP@ +GL_GNULIB_MBSSPN = @GL_GNULIB_MBSSPN@ +GL_GNULIB_MBSSTR = @GL_GNULIB_MBSSTR@ +GL_GNULIB_MBSTOK_R = @GL_GNULIB_MBSTOK_R@ +GL_GNULIB_MBTOWC = @GL_GNULIB_MBTOWC@ +GL_GNULIB_MDA_ACCESS = @GL_GNULIB_MDA_ACCESS@ +GL_GNULIB_MDA_CHDIR = @GL_GNULIB_MDA_CHDIR@ +GL_GNULIB_MDA_CHMOD = @GL_GNULIB_MDA_CHMOD@ +GL_GNULIB_MDA_CLOSE = @GL_GNULIB_MDA_CLOSE@ +GL_GNULIB_MDA_CREAT = @GL_GNULIB_MDA_CREAT@ +GL_GNULIB_MDA_DUP = @GL_GNULIB_MDA_DUP@ +GL_GNULIB_MDA_DUP2 = @GL_GNULIB_MDA_DUP2@ +GL_GNULIB_MDA_ECVT = @GL_GNULIB_MDA_ECVT@ +GL_GNULIB_MDA_EXECL = @GL_GNULIB_MDA_EXECL@ +GL_GNULIB_MDA_EXECLE = @GL_GNULIB_MDA_EXECLE@ +GL_GNULIB_MDA_EXECLP = @GL_GNULIB_MDA_EXECLP@ +GL_GNULIB_MDA_EXECV = @GL_GNULIB_MDA_EXECV@ +GL_GNULIB_MDA_EXECVE = @GL_GNULIB_MDA_EXECVE@ +GL_GNULIB_MDA_EXECVP = @GL_GNULIB_MDA_EXECVP@ +GL_GNULIB_MDA_EXECVPE = @GL_GNULIB_MDA_EXECVPE@ +GL_GNULIB_MDA_FCLOSEALL = @GL_GNULIB_MDA_FCLOSEALL@ +GL_GNULIB_MDA_FCVT = @GL_GNULIB_MDA_FCVT@ +GL_GNULIB_MDA_FDOPEN = @GL_GNULIB_MDA_FDOPEN@ +GL_GNULIB_MDA_FILENO = @GL_GNULIB_MDA_FILENO@ +GL_GNULIB_MDA_GCVT = @GL_GNULIB_MDA_GCVT@ +GL_GNULIB_MDA_GETCWD = @GL_GNULIB_MDA_GETCWD@ +GL_GNULIB_MDA_GETPID = @GL_GNULIB_MDA_GETPID@ +GL_GNULIB_MDA_GETW = @GL_GNULIB_MDA_GETW@ +GL_GNULIB_MDA_ISATTY = @GL_GNULIB_MDA_ISATTY@ +GL_GNULIB_MDA_LSEEK = @GL_GNULIB_MDA_LSEEK@ +GL_GNULIB_MDA_MEMCCPY = @GL_GNULIB_MDA_MEMCCPY@ +GL_GNULIB_MDA_MKDIR = @GL_GNULIB_MDA_MKDIR@ +GL_GNULIB_MDA_MKTEMP = @GL_GNULIB_MDA_MKTEMP@ +GL_GNULIB_MDA_OPEN = @GL_GNULIB_MDA_OPEN@ +GL_GNULIB_MDA_PUTENV = @GL_GNULIB_MDA_PUTENV@ +GL_GNULIB_MDA_PUTW = @GL_GNULIB_MDA_PUTW@ +GL_GNULIB_MDA_READ = @GL_GNULIB_MDA_READ@ +GL_GNULIB_MDA_RMDIR = @GL_GNULIB_MDA_RMDIR@ +GL_GNULIB_MDA_STRDUP = @GL_GNULIB_MDA_STRDUP@ +GL_GNULIB_MDA_SWAB = @GL_GNULIB_MDA_SWAB@ +GL_GNULIB_MDA_TEMPNAM = @GL_GNULIB_MDA_TEMPNAM@ +GL_GNULIB_MDA_TZSET = @GL_GNULIB_MDA_TZSET@ +GL_GNULIB_MDA_UMASK = @GL_GNULIB_MDA_UMASK@ +GL_GNULIB_MDA_UNLINK = @GL_GNULIB_MDA_UNLINK@ +GL_GNULIB_MDA_WCSDUP = @GL_GNULIB_MDA_WCSDUP@ +GL_GNULIB_MDA_WRITE = @GL_GNULIB_MDA_WRITE@ +GL_GNULIB_MEMCHR = @GL_GNULIB_MEMCHR@ +GL_GNULIB_MEMMEM = @GL_GNULIB_MEMMEM@ +GL_GNULIB_MEMPCPY = @GL_GNULIB_MEMPCPY@ +GL_GNULIB_MEMRCHR = @GL_GNULIB_MEMRCHR@ +GL_GNULIB_MKDIR = @GL_GNULIB_MKDIR@ +GL_GNULIB_MKDIRAT = @GL_GNULIB_MKDIRAT@ +GL_GNULIB_MKDTEMP = @GL_GNULIB_MKDTEMP@ +GL_GNULIB_MKFIFO = @GL_GNULIB_MKFIFO@ +GL_GNULIB_MKFIFOAT = @GL_GNULIB_MKFIFOAT@ +GL_GNULIB_MKNOD = @GL_GNULIB_MKNOD@ +GL_GNULIB_MKNODAT = @GL_GNULIB_MKNODAT@ +GL_GNULIB_MKOSTEMP = @GL_GNULIB_MKOSTEMP@ +GL_GNULIB_MKOSTEMPS = @GL_GNULIB_MKOSTEMPS@ +GL_GNULIB_MKSTEMP = @GL_GNULIB_MKSTEMP@ +GL_GNULIB_MKSTEMPS = @GL_GNULIB_MKSTEMPS@ +GL_GNULIB_MKTIME = @GL_GNULIB_MKTIME@ +GL_GNULIB_NANOSLEEP = @GL_GNULIB_NANOSLEEP@ +GL_GNULIB_NONBLOCKING = @GL_GNULIB_NONBLOCKING@ +GL_GNULIB_OBSTACK_PRINTF = @GL_GNULIB_OBSTACK_PRINTF@ +GL_GNULIB_OBSTACK_PRINTF_POSIX = @GL_GNULIB_OBSTACK_PRINTF_POSIX@ +GL_GNULIB_OPEN = @GL_GNULIB_OPEN@ +GL_GNULIB_OPENAT = @GL_GNULIB_OPENAT@ +GL_GNULIB_OVERRIDES_STRUCT_STAT = @GL_GNULIB_OVERRIDES_STRUCT_STAT@ +GL_GNULIB_PCLOSE = @GL_GNULIB_PCLOSE@ +GL_GNULIB_PERROR = @GL_GNULIB_PERROR@ +GL_GNULIB_PIPE = @GL_GNULIB_PIPE@ +GL_GNULIB_PIPE2 = @GL_GNULIB_PIPE2@ +GL_GNULIB_POPEN = @GL_GNULIB_POPEN@ +GL_GNULIB_POSIX_MEMALIGN = @GL_GNULIB_POSIX_MEMALIGN@ +GL_GNULIB_POSIX_OPENPT = @GL_GNULIB_POSIX_OPENPT@ +GL_GNULIB_PREAD = @GL_GNULIB_PREAD@ +GL_GNULIB_PRINTF = @GL_GNULIB_PRINTF@ +GL_GNULIB_PRINTF_POSIX = @GL_GNULIB_PRINTF_POSIX@ +GL_GNULIB_PTSNAME = @GL_GNULIB_PTSNAME@ +GL_GNULIB_PTSNAME_R = @GL_GNULIB_PTSNAME_R@ +GL_GNULIB_PUTC = @GL_GNULIB_PUTC@ +GL_GNULIB_PUTCHAR = @GL_GNULIB_PUTCHAR@ +GL_GNULIB_PUTENV = @GL_GNULIB_PUTENV@ +GL_GNULIB_PUTS = @GL_GNULIB_PUTS@ +GL_GNULIB_PWRITE = @GL_GNULIB_PWRITE@ +GL_GNULIB_QSORT_R = @GL_GNULIB_QSORT_R@ +GL_GNULIB_RANDOM = @GL_GNULIB_RANDOM@ +GL_GNULIB_RANDOM_R = @GL_GNULIB_RANDOM_R@ +GL_GNULIB_RAWMEMCHR = @GL_GNULIB_RAWMEMCHR@ +GL_GNULIB_READ = @GL_GNULIB_READ@ +GL_GNULIB_READLINK = @GL_GNULIB_READLINK@ +GL_GNULIB_READLINKAT = @GL_GNULIB_READLINKAT@ +GL_GNULIB_REALLOCARRAY = @GL_GNULIB_REALLOCARRAY@ +GL_GNULIB_REALLOC_POSIX = @GL_GNULIB_REALLOC_POSIX@ +GL_GNULIB_REALPATH = @GL_GNULIB_REALPATH@ +GL_GNULIB_RECV = @GL_GNULIB_RECV@ +GL_GNULIB_RECVFROM = @GL_GNULIB_RECVFROM@ +GL_GNULIB_REMOVE = @GL_GNULIB_REMOVE@ +GL_GNULIB_RENAME = @GL_GNULIB_RENAME@ +GL_GNULIB_RENAMEAT = @GL_GNULIB_RENAMEAT@ +GL_GNULIB_RMDIR = @GL_GNULIB_RMDIR@ +GL_GNULIB_RPMATCH = @GL_GNULIB_RPMATCH@ +GL_GNULIB_SCANF = @GL_GNULIB_SCANF@ +GL_GNULIB_SECURE_GETENV = @GL_GNULIB_SECURE_GETENV@ +GL_GNULIB_SEND = @GL_GNULIB_SEND@ +GL_GNULIB_SENDTO = @GL_GNULIB_SENDTO@ +GL_GNULIB_SETENV = @GL_GNULIB_SETENV@ +GL_GNULIB_SETHOSTNAME = @GL_GNULIB_SETHOSTNAME@ +GL_GNULIB_SETSOCKOPT = @GL_GNULIB_SETSOCKOPT@ +GL_GNULIB_SHUTDOWN = @GL_GNULIB_SHUTDOWN@ +GL_GNULIB_SIGABBREV_NP = @GL_GNULIB_SIGABBREV_NP@ +GL_GNULIB_SIGDESCR_NP = @GL_GNULIB_SIGDESCR_NP@ +GL_GNULIB_SLEEP = @GL_GNULIB_SLEEP@ +GL_GNULIB_SNPRINTF = @GL_GNULIB_SNPRINTF@ +GL_GNULIB_SOCKET = @GL_GNULIB_SOCKET@ +GL_GNULIB_SPRINTF_POSIX = @GL_GNULIB_SPRINTF_POSIX@ +GL_GNULIB_STAT = @GL_GNULIB_STAT@ +GL_GNULIB_STDIO_H_NONBLOCKING = @GL_GNULIB_STDIO_H_NONBLOCKING@ +GL_GNULIB_STDIO_H_SIGPIPE = @GL_GNULIB_STDIO_H_SIGPIPE@ +GL_GNULIB_STPCPY = @GL_GNULIB_STPCPY@ +GL_GNULIB_STPNCPY = @GL_GNULIB_STPNCPY@ +GL_GNULIB_STRCASESTR = @GL_GNULIB_STRCASESTR@ +GL_GNULIB_STRCHRNUL = @GL_GNULIB_STRCHRNUL@ +GL_GNULIB_STRDUP = @GL_GNULIB_STRDUP@ +GL_GNULIB_STRERROR = @GL_GNULIB_STRERROR@ +GL_GNULIB_STRERRORNAME_NP = @GL_GNULIB_STRERRORNAME_NP@ +GL_GNULIB_STRERROR_R = @GL_GNULIB_STRERROR_R@ +GL_GNULIB_STRFTIME = @GL_GNULIB_STRFTIME@ +GL_GNULIB_STRNCAT = @GL_GNULIB_STRNCAT@ +GL_GNULIB_STRNDUP = @GL_GNULIB_STRNDUP@ +GL_GNULIB_STRNLEN = @GL_GNULIB_STRNLEN@ +GL_GNULIB_STRPBRK = @GL_GNULIB_STRPBRK@ +GL_GNULIB_STRPTIME = @GL_GNULIB_STRPTIME@ +GL_GNULIB_STRSEP = @GL_GNULIB_STRSEP@ +GL_GNULIB_STRSIGNAL = @GL_GNULIB_STRSIGNAL@ +GL_GNULIB_STRSTR = @GL_GNULIB_STRSTR@ +GL_GNULIB_STRTOD = @GL_GNULIB_STRTOD@ +GL_GNULIB_STRTOIMAX = @GL_GNULIB_STRTOIMAX@ +GL_GNULIB_STRTOK_R = @GL_GNULIB_STRTOK_R@ +GL_GNULIB_STRTOL = @GL_GNULIB_STRTOL@ +GL_GNULIB_STRTOLD = @GL_GNULIB_STRTOLD@ +GL_GNULIB_STRTOLL = @GL_GNULIB_STRTOLL@ +GL_GNULIB_STRTOUL = @GL_GNULIB_STRTOUL@ +GL_GNULIB_STRTOULL = @GL_GNULIB_STRTOULL@ +GL_GNULIB_STRTOUMAX = @GL_GNULIB_STRTOUMAX@ +GL_GNULIB_STRVERSCMP = @GL_GNULIB_STRVERSCMP@ +GL_GNULIB_SYMLINK = @GL_GNULIB_SYMLINK@ +GL_GNULIB_SYMLINKAT = @GL_GNULIB_SYMLINKAT@ +GL_GNULIB_SYSTEM_POSIX = @GL_GNULIB_SYSTEM_POSIX@ +GL_GNULIB_TIMEGM = @GL_GNULIB_TIMEGM@ +GL_GNULIB_TIMESPEC_GET = @GL_GNULIB_TIMESPEC_GET@ +GL_GNULIB_TIME_R = @GL_GNULIB_TIME_R@ +GL_GNULIB_TIME_RZ = @GL_GNULIB_TIME_RZ@ +GL_GNULIB_TMPFILE = @GL_GNULIB_TMPFILE@ +GL_GNULIB_TRUNCATE = @GL_GNULIB_TRUNCATE@ +GL_GNULIB_TTYNAME_R = @GL_GNULIB_TTYNAME_R@ +GL_GNULIB_TZSET = @GL_GNULIB_TZSET@ +GL_GNULIB_UNISTD_H_NONBLOCKING = @GL_GNULIB_UNISTD_H_NONBLOCKING@ +GL_GNULIB_UNISTD_H_SIGPIPE = @GL_GNULIB_UNISTD_H_SIGPIPE@ +GL_GNULIB_UNLINK = @GL_GNULIB_UNLINK@ +GL_GNULIB_UNLINKAT = @GL_GNULIB_UNLINKAT@ +GL_GNULIB_UNLOCKPT = @GL_GNULIB_UNLOCKPT@ +GL_GNULIB_UNSETENV = @GL_GNULIB_UNSETENV@ +GL_GNULIB_USLEEP = @GL_GNULIB_USLEEP@ +GL_GNULIB_UTIMENSAT = @GL_GNULIB_UTIMENSAT@ +GL_GNULIB_VASPRINTF = @GL_GNULIB_VASPRINTF@ +GL_GNULIB_VDPRINTF = @GL_GNULIB_VDPRINTF@ +GL_GNULIB_VFPRINTF = @GL_GNULIB_VFPRINTF@ +GL_GNULIB_VFPRINTF_POSIX = @GL_GNULIB_VFPRINTF_POSIX@ +GL_GNULIB_VFSCANF = @GL_GNULIB_VFSCANF@ +GL_GNULIB_VPRINTF = @GL_GNULIB_VPRINTF@ +GL_GNULIB_VPRINTF_POSIX = @GL_GNULIB_VPRINTF_POSIX@ +GL_GNULIB_VSCANF = @GL_GNULIB_VSCANF@ +GL_GNULIB_VSNPRINTF = @GL_GNULIB_VSNPRINTF@ +GL_GNULIB_VSPRINTF_POSIX = @GL_GNULIB_VSPRINTF_POSIX@ +GL_GNULIB_WCPCPY = @GL_GNULIB_WCPCPY@ +GL_GNULIB_WCPNCPY = @GL_GNULIB_WCPNCPY@ +GL_GNULIB_WCRTOMB = @GL_GNULIB_WCRTOMB@ +GL_GNULIB_WCSCASECMP = @GL_GNULIB_WCSCASECMP@ +GL_GNULIB_WCSCAT = @GL_GNULIB_WCSCAT@ +GL_GNULIB_WCSCHR = @GL_GNULIB_WCSCHR@ +GL_GNULIB_WCSCMP = @GL_GNULIB_WCSCMP@ +GL_GNULIB_WCSCOLL = @GL_GNULIB_WCSCOLL@ +GL_GNULIB_WCSCPY = @GL_GNULIB_WCSCPY@ +GL_GNULIB_WCSCSPN = @GL_GNULIB_WCSCSPN@ +GL_GNULIB_WCSDUP = @GL_GNULIB_WCSDUP@ +GL_GNULIB_WCSFTIME = @GL_GNULIB_WCSFTIME@ +GL_GNULIB_WCSLEN = @GL_GNULIB_WCSLEN@ +GL_GNULIB_WCSNCASECMP = @GL_GNULIB_WCSNCASECMP@ +GL_GNULIB_WCSNCAT = @GL_GNULIB_WCSNCAT@ +GL_GNULIB_WCSNCMP = @GL_GNULIB_WCSNCMP@ +GL_GNULIB_WCSNCPY = @GL_GNULIB_WCSNCPY@ +GL_GNULIB_WCSNLEN = @GL_GNULIB_WCSNLEN@ +GL_GNULIB_WCSNRTOMBS = @GL_GNULIB_WCSNRTOMBS@ +GL_GNULIB_WCSPBRK = @GL_GNULIB_WCSPBRK@ +GL_GNULIB_WCSRCHR = @GL_GNULIB_WCSRCHR@ +GL_GNULIB_WCSRTOMBS = @GL_GNULIB_WCSRTOMBS@ +GL_GNULIB_WCSSPN = @GL_GNULIB_WCSSPN@ +GL_GNULIB_WCSSTR = @GL_GNULIB_WCSSTR@ +GL_GNULIB_WCSTOK = @GL_GNULIB_WCSTOK@ +GL_GNULIB_WCSWIDTH = @GL_GNULIB_WCSWIDTH@ +GL_GNULIB_WCSXFRM = @GL_GNULIB_WCSXFRM@ +GL_GNULIB_WCTOB = @GL_GNULIB_WCTOB@ +GL_GNULIB_WCTOMB = @GL_GNULIB_WCTOMB@ +GL_GNULIB_WCWIDTH = @GL_GNULIB_WCWIDTH@ +GL_GNULIB_WMEMCHR = @GL_GNULIB_WMEMCHR@ +GL_GNULIB_WMEMCMP = @GL_GNULIB_WMEMCMP@ +GL_GNULIB_WMEMCPY = @GL_GNULIB_WMEMCPY@ +GL_GNULIB_WMEMMOVE = @GL_GNULIB_WMEMMOVE@ +GL_GNULIB_WMEMPCPY = @GL_GNULIB_WMEMPCPY@ +GL_GNULIB_WMEMSET = @GL_GNULIB_WMEMSET@ +GL_GNULIB_WRITE = @GL_GNULIB_WRITE@ +GL_GNULIB__EXIT = @GL_GNULIB__EXIT@ +GMP_CFLAGS = @GMP_CFLAGS@ +GMP_LIBS = @GMP_LIBS@ +GMSGFMT = @GMSGFMT@ +GMSGFMT_015 = @GMSGFMT_015@ +GNULIBHEADERS_OVERRIDE_WINT_T = @GNULIBHEADERS_OVERRIDE_WINT_T@ +GNULIB_GETTIMEOFDAY = @GNULIB_GETTIMEOFDAY@ +GNUTLS_LIBS_PRIVATE = @GNUTLS_LIBS_PRIVATE@ +GNUTLS_REQUIRES_PRIVATE = @GNUTLS_REQUIRES_PRIVATE@ +GPERF = @GPERF@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_CHECK_PATH = @GTKDOC_CHECK_PATH@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +GUILD = @GUILD@ +GUILE = @GUILE@ +GUILE_CFLAGS = @GUILE_CFLAGS@ +GUILE_CONFIG = @GUILE_CONFIG@ +GUILE_EFFECTIVE_VERSION = @GUILE_EFFECTIVE_VERSION@ +GUILE_EXTENSION = @GUILE_EXTENSION@ +GUILE_LDFLAGS = @GUILE_LDFLAGS@ +GUILE_LIBS = @GUILE_LIBS@ +GUILE_LTLIBS = @GUILE_LTLIBS@ +GUILE_SITE = @GUILE_SITE@ +GUILE_SITE_CCACHE = @GUILE_SITE_CCACHE@ +GUILE_TOOLS = @GUILE_TOOLS@ +HAVE_ACCEPT4 = @HAVE_ACCEPT4@ +HAVE_ALIGNED_ALLOC = @HAVE_ALIGNED_ALLOC@ +HAVE_ALLOCA_H = @HAVE_ALLOCA_H@ +HAVE_ARPA_INET_H = @HAVE_ARPA_INET_H@ +HAVE_ATOLL = @HAVE_ATOLL@ +HAVE_BTOWC = @HAVE_BTOWC@ +HAVE_C99_STDINT_H = @HAVE_C99_STDINT_H@ +HAVE_CANONICALIZE_FILE_NAME = @HAVE_CANONICALIZE_FILE_NAME@ +HAVE_CHOWN = @HAVE_CHOWN@ +HAVE_COPY_FILE_RANGE = @HAVE_COPY_FILE_RANGE@ +HAVE_CRTDEFS_H = @HAVE_CRTDEFS_H@ +HAVE_DECL_ECVT = @HAVE_DECL_ECVT@ +HAVE_DECL_ENVIRON = @HAVE_DECL_ENVIRON@ +HAVE_DECL_EXECVPE = @HAVE_DECL_EXECVPE@ +HAVE_DECL_FCHDIR = @HAVE_DECL_FCHDIR@ +HAVE_DECL_FCLOSEALL = @HAVE_DECL_FCLOSEALL@ +HAVE_DECL_FCVT = @HAVE_DECL_FCVT@ +HAVE_DECL_FDATASYNC = @HAVE_DECL_FDATASYNC@ +HAVE_DECL_FPURGE = @HAVE_DECL_FPURGE@ +HAVE_DECL_FREEADDRINFO = @HAVE_DECL_FREEADDRINFO@ +HAVE_DECL_FSEEKO = @HAVE_DECL_FSEEKO@ +HAVE_DECL_FTELLO = @HAVE_DECL_FTELLO@ +HAVE_DECL_GAI_STRERROR = @HAVE_DECL_GAI_STRERROR@ +HAVE_DECL_GCVT = @HAVE_DECL_GCVT@ +HAVE_DECL_GETADDRINFO = @HAVE_DECL_GETADDRINFO@ +HAVE_DECL_GETDELIM = @HAVE_DECL_GETDELIM@ +HAVE_DECL_GETDOMAINNAME = @HAVE_DECL_GETDOMAINNAME@ +HAVE_DECL_GETLINE = @HAVE_DECL_GETLINE@ +HAVE_DECL_GETLOADAVG = @HAVE_DECL_GETLOADAVG@ +HAVE_DECL_GETLOGIN = @HAVE_DECL_GETLOGIN@ +HAVE_DECL_GETLOGIN_R = @HAVE_DECL_GETLOGIN_R@ +HAVE_DECL_GETNAMEINFO = @HAVE_DECL_GETNAMEINFO@ +HAVE_DECL_GETPAGESIZE = @HAVE_DECL_GETPAGESIZE@ +HAVE_DECL_GETUSERSHELL = @HAVE_DECL_GETUSERSHELL@ +HAVE_DECL_IMAXABS = @HAVE_DECL_IMAXABS@ +HAVE_DECL_IMAXDIV = @HAVE_DECL_IMAXDIV@ +HAVE_DECL_INET_NTOP = @HAVE_DECL_INET_NTOP@ +HAVE_DECL_INET_PTON = @HAVE_DECL_INET_PTON@ +HAVE_DECL_INITSTATE = @HAVE_DECL_INITSTATE@ +HAVE_DECL_LOCALTIME_R = @HAVE_DECL_LOCALTIME_R@ +HAVE_DECL_MEMMEM = @HAVE_DECL_MEMMEM@ +HAVE_DECL_MEMRCHR = @HAVE_DECL_MEMRCHR@ +HAVE_DECL_OBSTACK_PRINTF = @HAVE_DECL_OBSTACK_PRINTF@ +HAVE_DECL_SETENV = @HAVE_DECL_SETENV@ +HAVE_DECL_SETHOSTNAME = @HAVE_DECL_SETHOSTNAME@ +HAVE_DECL_SETSTATE = @HAVE_DECL_SETSTATE@ +HAVE_DECL_SNPRINTF = @HAVE_DECL_SNPRINTF@ +HAVE_DECL_STRDUP = @HAVE_DECL_STRDUP@ +HAVE_DECL_STRERROR_R = @HAVE_DECL_STRERROR_R@ +HAVE_DECL_STRNCASECMP = @HAVE_DECL_STRNCASECMP@ +HAVE_DECL_STRNDUP = @HAVE_DECL_STRNDUP@ +HAVE_DECL_STRNLEN = @HAVE_DECL_STRNLEN@ +HAVE_DECL_STRSIGNAL = @HAVE_DECL_STRSIGNAL@ +HAVE_DECL_STRTOIMAX = @HAVE_DECL_STRTOIMAX@ +HAVE_DECL_STRTOK_R = @HAVE_DECL_STRTOK_R@ +HAVE_DECL_STRTOUMAX = @HAVE_DECL_STRTOUMAX@ +HAVE_DECL_TRUNCATE = @HAVE_DECL_TRUNCATE@ +HAVE_DECL_TTYNAME_R = @HAVE_DECL_TTYNAME_R@ +HAVE_DECL_UNSETENV = @HAVE_DECL_UNSETENV@ +HAVE_DECL_VSNPRINTF = @HAVE_DECL_VSNPRINTF@ +HAVE_DECL_WCSDUP = @HAVE_DECL_WCSDUP@ +HAVE_DECL_WCTOB = @HAVE_DECL_WCTOB@ +HAVE_DECL_WCWIDTH = @HAVE_DECL_WCWIDTH@ +HAVE_DPRINTF = @HAVE_DPRINTF@ +HAVE_DUP3 = @HAVE_DUP3@ +HAVE_DUPLOCALE = @HAVE_DUPLOCALE@ +HAVE_EUIDACCESS = @HAVE_EUIDACCESS@ +HAVE_EXECVPE = @HAVE_EXECVPE@ +HAVE_EXPLICIT_BZERO = @HAVE_EXPLICIT_BZERO@ +HAVE_FACCESSAT = @HAVE_FACCESSAT@ +HAVE_FCHDIR = @HAVE_FCHDIR@ +HAVE_FCHMODAT = @HAVE_FCHMODAT@ +HAVE_FCHOWNAT = @HAVE_FCHOWNAT@ +HAVE_FCNTL = @HAVE_FCNTL@ +HAVE_FDATASYNC = @HAVE_FDATASYNC@ +HAVE_FEATURES_H = @HAVE_FEATURES_H@ +HAVE_FFS = @HAVE_FFS@ +HAVE_FFSL = @HAVE_FFSL@ +HAVE_FFSLL = @HAVE_FFSLL@ +HAVE_FREELOCALE = @HAVE_FREELOCALE@ +HAVE_FSEEKO = @HAVE_FSEEKO@ +HAVE_FSTATAT = @HAVE_FSTATAT@ +HAVE_FSYNC = @HAVE_FSYNC@ +HAVE_FTELLO = @HAVE_FTELLO@ +HAVE_FTRUNCATE = @HAVE_FTRUNCATE@ +HAVE_FUTIMENS = @HAVE_FUTIMENS@ +HAVE_GETDTABLESIZE = @HAVE_GETDTABLESIZE@ +HAVE_GETENTROPY = @HAVE_GETENTROPY@ +HAVE_GETGROUPS = @HAVE_GETGROUPS@ +HAVE_GETHOSTNAME = @HAVE_GETHOSTNAME@ +HAVE_GETLOGIN = @HAVE_GETLOGIN@ +HAVE_GETPAGESIZE = @HAVE_GETPAGESIZE@ +HAVE_GETPASS = @HAVE_GETPASS@ +HAVE_GETSUBOPT = @HAVE_GETSUBOPT@ +HAVE_GETTIMEOFDAY = @HAVE_GETTIMEOFDAY@ +HAVE_GETUMASK = @HAVE_GETUMASK@ +HAVE_GRANTPT = @HAVE_GRANTPT@ +HAVE_GROUP_MEMBER = @HAVE_GROUP_MEMBER@ +HAVE_IMAXDIV_T = @HAVE_IMAXDIV_T@ +HAVE_INITSTATE = @HAVE_INITSTATE@ +HAVE_INTTYPES_H = @HAVE_INTTYPES_H@ +HAVE_ISBLANK = @HAVE_ISBLANK@ +HAVE_LANGINFO_ALTMON = @HAVE_LANGINFO_ALTMON@ +HAVE_LANGINFO_CODESET = @HAVE_LANGINFO_CODESET@ +HAVE_LANGINFO_ERA = @HAVE_LANGINFO_ERA@ +HAVE_LANGINFO_H = @HAVE_LANGINFO_H@ +HAVE_LANGINFO_T_FMT_AMPM = @HAVE_LANGINFO_T_FMT_AMPM@ +HAVE_LANGINFO_YESEXPR = @HAVE_LANGINFO_YESEXPR@ +HAVE_LCHMOD = @HAVE_LCHMOD@ +HAVE_LCHOWN = @HAVE_LCHOWN@ +HAVE_LIBCRYPTO = @HAVE_LIBCRYPTO@ +HAVE_LIBDL = @HAVE_LIBDL@ +HAVE_LIBEV = @HAVE_LIBEV@ +HAVE_LIBPTHREAD = @HAVE_LIBPTHREAD@ +HAVE_LIBRT = @HAVE_LIBRT@ +HAVE_LIBSECCOMP = @HAVE_LIBSECCOMP@ +HAVE_LIBZ = @HAVE_LIBZ@ +HAVE_LINK = @HAVE_LINK@ +HAVE_LINKAT = @HAVE_LINKAT@ +HAVE_LSTAT = @HAVE_LSTAT@ +HAVE_MAX_ALIGN_T = @HAVE_MAX_ALIGN_T@ +HAVE_MBRLEN = @HAVE_MBRLEN@ +HAVE_MBRTOWC = @HAVE_MBRTOWC@ +HAVE_MBSINIT = @HAVE_MBSINIT@ +HAVE_MBSLEN = @HAVE_MBSLEN@ +HAVE_MBSNRTOWCS = @HAVE_MBSNRTOWCS@ +HAVE_MBSRTOWCS = @HAVE_MBSRTOWCS@ +HAVE_MBTOWC = @HAVE_MBTOWC@ +HAVE_MEMPCPY = @HAVE_MEMPCPY@ +HAVE_MKDIRAT = @HAVE_MKDIRAT@ +HAVE_MKDTEMP = @HAVE_MKDTEMP@ +HAVE_MKFIFO = @HAVE_MKFIFO@ +HAVE_MKFIFOAT = @HAVE_MKFIFOAT@ +HAVE_MKNOD = @HAVE_MKNOD@ +HAVE_MKNODAT = @HAVE_MKNODAT@ +HAVE_MKOSTEMP = @HAVE_MKOSTEMP@ +HAVE_MKOSTEMPS = @HAVE_MKOSTEMPS@ +HAVE_MKSTEMP = @HAVE_MKSTEMP@ +HAVE_MKSTEMPS = @HAVE_MKSTEMPS@ +HAVE_MSVC_INVALID_PARAMETER_HANDLER = @HAVE_MSVC_INVALID_PARAMETER_HANDLER@ +HAVE_NANOSLEEP = @HAVE_NANOSLEEP@ +HAVE_NETDB_H = @HAVE_NETDB_H@ +HAVE_NETINET_IN_H = @HAVE_NETINET_IN_H@ +HAVE_NEWLOCALE = @HAVE_NEWLOCALE@ +HAVE_NL_LANGINFO = @HAVE_NL_LANGINFO@ +HAVE_OPENAT = @HAVE_OPENAT@ +HAVE_OS_H = @HAVE_OS_H@ +HAVE_PCLOSE = @HAVE_PCLOSE@ +HAVE_PIPE = @HAVE_PIPE@ +HAVE_PIPE2 = @HAVE_PIPE2@ +HAVE_POPEN = @HAVE_POPEN@ +HAVE_POSIX_MEMALIGN = @HAVE_POSIX_MEMALIGN@ +HAVE_POSIX_OPENPT = @HAVE_POSIX_OPENPT@ +HAVE_POSIX_SIGNALBLOCKING = @HAVE_POSIX_SIGNALBLOCKING@ +HAVE_PREAD = @HAVE_PREAD@ +HAVE_PSELECT = @HAVE_PSELECT@ +HAVE_PTHREAD_ATTR_DESTROY = @HAVE_PTHREAD_ATTR_DESTROY@ +HAVE_PTHREAD_ATTR_GETDETACHSTATE = @HAVE_PTHREAD_ATTR_GETDETACHSTATE@ +HAVE_PTHREAD_ATTR_INIT = @HAVE_PTHREAD_ATTR_INIT@ +HAVE_PTHREAD_ATTR_SETDETACHSTATE = @HAVE_PTHREAD_ATTR_SETDETACHSTATE@ +HAVE_PTHREAD_CONDATTR_DESTROY = @HAVE_PTHREAD_CONDATTR_DESTROY@ +HAVE_PTHREAD_CONDATTR_INIT = @HAVE_PTHREAD_CONDATTR_INIT@ +HAVE_PTHREAD_COND_BROADCAST = @HAVE_PTHREAD_COND_BROADCAST@ +HAVE_PTHREAD_COND_DESTROY = @HAVE_PTHREAD_COND_DESTROY@ +HAVE_PTHREAD_COND_INIT = @HAVE_PTHREAD_COND_INIT@ +HAVE_PTHREAD_COND_SIGNAL = @HAVE_PTHREAD_COND_SIGNAL@ +HAVE_PTHREAD_COND_TIMEDWAIT = @HAVE_PTHREAD_COND_TIMEDWAIT@ +HAVE_PTHREAD_COND_WAIT = @HAVE_PTHREAD_COND_WAIT@ +HAVE_PTHREAD_CREATE = @HAVE_PTHREAD_CREATE@ +HAVE_PTHREAD_CREATE_DETACHED = @HAVE_PTHREAD_CREATE_DETACHED@ +HAVE_PTHREAD_DETACH = @HAVE_PTHREAD_DETACH@ +HAVE_PTHREAD_EQUAL = @HAVE_PTHREAD_EQUAL@ +HAVE_PTHREAD_EXIT = @HAVE_PTHREAD_EXIT@ +HAVE_PTHREAD_GETSPECIFIC = @HAVE_PTHREAD_GETSPECIFIC@ +HAVE_PTHREAD_H = @HAVE_PTHREAD_H@ +HAVE_PTHREAD_JOIN = @HAVE_PTHREAD_JOIN@ +HAVE_PTHREAD_KEY_CREATE = @HAVE_PTHREAD_KEY_CREATE@ +HAVE_PTHREAD_KEY_DELETE = @HAVE_PTHREAD_KEY_DELETE@ +HAVE_PTHREAD_MUTEXATTR_DESTROY = @HAVE_PTHREAD_MUTEXATTR_DESTROY@ +HAVE_PTHREAD_MUTEXATTR_GETROBUST = @HAVE_PTHREAD_MUTEXATTR_GETROBUST@ +HAVE_PTHREAD_MUTEXATTR_GETTYPE = @HAVE_PTHREAD_MUTEXATTR_GETTYPE@ +HAVE_PTHREAD_MUTEXATTR_INIT = @HAVE_PTHREAD_MUTEXATTR_INIT@ +HAVE_PTHREAD_MUTEXATTR_SETROBUST = @HAVE_PTHREAD_MUTEXATTR_SETROBUST@ +HAVE_PTHREAD_MUTEXATTR_SETTYPE = @HAVE_PTHREAD_MUTEXATTR_SETTYPE@ +HAVE_PTHREAD_MUTEX_DESTROY = @HAVE_PTHREAD_MUTEX_DESTROY@ +HAVE_PTHREAD_MUTEX_INIT = @HAVE_PTHREAD_MUTEX_INIT@ +HAVE_PTHREAD_MUTEX_LOCK = @HAVE_PTHREAD_MUTEX_LOCK@ +HAVE_PTHREAD_MUTEX_RECURSIVE = @HAVE_PTHREAD_MUTEX_RECURSIVE@ +HAVE_PTHREAD_MUTEX_ROBUST = @HAVE_PTHREAD_MUTEX_ROBUST@ +HAVE_PTHREAD_MUTEX_TIMEDLOCK = @HAVE_PTHREAD_MUTEX_TIMEDLOCK@ +HAVE_PTHREAD_MUTEX_TRYLOCK = @HAVE_PTHREAD_MUTEX_TRYLOCK@ +HAVE_PTHREAD_MUTEX_UNLOCK = @HAVE_PTHREAD_MUTEX_UNLOCK@ +HAVE_PTHREAD_ONCE = @HAVE_PTHREAD_ONCE@ +HAVE_PTHREAD_PROCESS_SHARED = @HAVE_PTHREAD_PROCESS_SHARED@ +HAVE_PTHREAD_RWLOCKATTR_DESTROY = @HAVE_PTHREAD_RWLOCKATTR_DESTROY@ +HAVE_PTHREAD_RWLOCKATTR_INIT = @HAVE_PTHREAD_RWLOCKATTR_INIT@ +HAVE_PTHREAD_RWLOCK_DESTROY = @HAVE_PTHREAD_RWLOCK_DESTROY@ +HAVE_PTHREAD_RWLOCK_INIT = @HAVE_PTHREAD_RWLOCK_INIT@ +HAVE_PTHREAD_RWLOCK_RDLOCK = @HAVE_PTHREAD_RWLOCK_RDLOCK@ +HAVE_PTHREAD_RWLOCK_TIMEDRDLOCK = @HAVE_PTHREAD_RWLOCK_TIMEDRDLOCK@ +HAVE_PTHREAD_RWLOCK_TIMEDWRLOCK = @HAVE_PTHREAD_RWLOCK_TIMEDWRLOCK@ +HAVE_PTHREAD_RWLOCK_TRYRDLOCK = @HAVE_PTHREAD_RWLOCK_TRYRDLOCK@ +HAVE_PTHREAD_RWLOCK_TRYWRLOCK = @HAVE_PTHREAD_RWLOCK_TRYWRLOCK@ +HAVE_PTHREAD_RWLOCK_UNLOCK = @HAVE_PTHREAD_RWLOCK_UNLOCK@ +HAVE_PTHREAD_RWLOCK_WRLOCK = @HAVE_PTHREAD_RWLOCK_WRLOCK@ +HAVE_PTHREAD_SELF = @HAVE_PTHREAD_SELF@ +HAVE_PTHREAD_SETSPECIFIC = @HAVE_PTHREAD_SETSPECIFIC@ +HAVE_PTHREAD_SIGMASK = @HAVE_PTHREAD_SIGMASK@ +HAVE_PTHREAD_SPINLOCK_T = @HAVE_PTHREAD_SPINLOCK_T@ +HAVE_PTHREAD_SPIN_DESTROY = @HAVE_PTHREAD_SPIN_DESTROY@ +HAVE_PTHREAD_SPIN_INIT = @HAVE_PTHREAD_SPIN_INIT@ +HAVE_PTHREAD_SPIN_LOCK = @HAVE_PTHREAD_SPIN_LOCK@ +HAVE_PTHREAD_SPIN_TRYLOCK = @HAVE_PTHREAD_SPIN_TRYLOCK@ +HAVE_PTHREAD_SPIN_UNLOCK = @HAVE_PTHREAD_SPIN_UNLOCK@ +HAVE_PTHREAD_T = @HAVE_PTHREAD_T@ +HAVE_PTSNAME = @HAVE_PTSNAME@ +HAVE_PTSNAME_R = @HAVE_PTSNAME_R@ +HAVE_PWRITE = @HAVE_PWRITE@ +HAVE_QSORT_R = @HAVE_QSORT_R@ +HAVE_RAISE = @HAVE_RAISE@ +HAVE_RANDOM = @HAVE_RANDOM@ +HAVE_RANDOM_H = @HAVE_RANDOM_H@ +HAVE_RANDOM_R = @HAVE_RANDOM_R@ +HAVE_RAWMEMCHR = @HAVE_RAWMEMCHR@ +HAVE_READLINK = @HAVE_READLINK@ +HAVE_READLINKAT = @HAVE_READLINKAT@ +HAVE_REALLOCARRAY = @HAVE_REALLOCARRAY@ +HAVE_REALPATH = @HAVE_REALPATH@ +HAVE_RENAMEAT = @HAVE_RENAMEAT@ +HAVE_RPMATCH = @HAVE_RPMATCH@ +HAVE_SA_FAMILY_T = @HAVE_SA_FAMILY_T@ +HAVE_SCHED_H = @HAVE_SCHED_H@ +HAVE_SCHED_YIELD = @HAVE_SCHED_YIELD@ +HAVE_SECURE_GETENV = @HAVE_SECURE_GETENV@ +HAVE_SETENV = @HAVE_SETENV@ +HAVE_SETHOSTNAME = @HAVE_SETHOSTNAME@ +HAVE_SETSTATE = @HAVE_SETSTATE@ +HAVE_SIGABBREV_NP = @HAVE_SIGABBREV_NP@ +HAVE_SIGACTION = @HAVE_SIGACTION@ +HAVE_SIGDESCR_NP = @HAVE_SIGDESCR_NP@ +HAVE_SIGHANDLER_T = @HAVE_SIGHANDLER_T@ +HAVE_SIGINFO_T = @HAVE_SIGINFO_T@ +HAVE_SIGNED_SIG_ATOMIC_T = @HAVE_SIGNED_SIG_ATOMIC_T@ +HAVE_SIGNED_WCHAR_T = @HAVE_SIGNED_WCHAR_T@ +HAVE_SIGNED_WINT_T = @HAVE_SIGNED_WINT_T@ +HAVE_SIGSET_T = @HAVE_SIGSET_T@ +HAVE_SLEEP = @HAVE_SLEEP@ +HAVE_STDINT_H = @HAVE_STDINT_H@ +HAVE_STPCPY = @HAVE_STPCPY@ +HAVE_STPNCPY = @HAVE_STPNCPY@ +HAVE_STRCASECMP = @HAVE_STRCASECMP@ +HAVE_STRCASESTR = @HAVE_STRCASESTR@ +HAVE_STRCHRNUL = @HAVE_STRCHRNUL@ +HAVE_STRERRORNAME_NP = @HAVE_STRERRORNAME_NP@ +HAVE_STRINGS_H = @HAVE_STRINGS_H@ +HAVE_STRPBRK = @HAVE_STRPBRK@ +HAVE_STRPTIME = @HAVE_STRPTIME@ +HAVE_STRSEP = @HAVE_STRSEP@ +HAVE_STRTOD = @HAVE_STRTOD@ +HAVE_STRTOL = @HAVE_STRTOL@ +HAVE_STRTOLD = @HAVE_STRTOLD@ +HAVE_STRTOLL = @HAVE_STRTOLL@ +HAVE_STRTOUL = @HAVE_STRTOUL@ +HAVE_STRTOULL = @HAVE_STRTOULL@ +HAVE_STRUCT_ADDRINFO = @HAVE_STRUCT_ADDRINFO@ +HAVE_STRUCT_RANDOM_DATA = @HAVE_STRUCT_RANDOM_DATA@ +HAVE_STRUCT_SCHED_PARAM = @HAVE_STRUCT_SCHED_PARAM@ +HAVE_STRUCT_SIGACTION_SA_SIGACTION = @HAVE_STRUCT_SIGACTION_SA_SIGACTION@ +HAVE_STRUCT_SOCKADDR_STORAGE = @HAVE_STRUCT_SOCKADDR_STORAGE@ +HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY = @HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY@ +HAVE_STRUCT_TIMEVAL = @HAVE_STRUCT_TIMEVAL@ +HAVE_STRVERSCMP = @HAVE_STRVERSCMP@ +HAVE_SYMLINK = @HAVE_SYMLINK@ +HAVE_SYMLINKAT = @HAVE_SYMLINKAT@ +HAVE_SYS_BITYPES_H = @HAVE_SYS_BITYPES_H@ +HAVE_SYS_CDEFS_H = @HAVE_SYS_CDEFS_H@ +HAVE_SYS_INTTYPES_H = @HAVE_SYS_INTTYPES_H@ +HAVE_SYS_IOCTL_H = @HAVE_SYS_IOCTL_H@ +HAVE_SYS_LOADAVG_H = @HAVE_SYS_LOADAVG_H@ +HAVE_SYS_PARAM_H = @HAVE_SYS_PARAM_H@ +HAVE_SYS_SELECT_H = @HAVE_SYS_SELECT_H@ +HAVE_SYS_SOCKET_H = @HAVE_SYS_SOCKET_H@ +HAVE_SYS_TIME_H = @HAVE_SYS_TIME_H@ +HAVE_SYS_TYPES_H = @HAVE_SYS_TYPES_H@ +HAVE_SYS_UIO_H = @HAVE_SYS_UIO_H@ +HAVE_TIMEGM = @HAVE_TIMEGM@ +HAVE_TIMESPEC_GET = @HAVE_TIMESPEC_GET@ +HAVE_TIMEZONE_T = @HAVE_TIMEZONE_T@ +HAVE_TYPE_VOLATILE_SIG_ATOMIC_T = @HAVE_TYPE_VOLATILE_SIG_ATOMIC_T@ +HAVE_UNISTD_H = @HAVE_UNISTD_H@ +HAVE_UNLINKAT = @HAVE_UNLINKAT@ +HAVE_UNLOCKPT = @HAVE_UNLOCKPT@ +HAVE_USLEEP = @HAVE_USLEEP@ +HAVE_UTIMENSAT = @HAVE_UTIMENSAT@ +HAVE_VASPRINTF = @HAVE_VASPRINTF@ +HAVE_VDPRINTF = @HAVE_VDPRINTF@ +HAVE_VISIBILITY = @HAVE_VISIBILITY@ +HAVE_WCHAR_H = @HAVE_WCHAR_H@ +HAVE_WCHAR_T = @HAVE_WCHAR_T@ +HAVE_WCPCPY = @HAVE_WCPCPY@ +HAVE_WCPNCPY = @HAVE_WCPNCPY@ +HAVE_WCRTOMB = @HAVE_WCRTOMB@ +HAVE_WCSCASECMP = @HAVE_WCSCASECMP@ +HAVE_WCSCAT = @HAVE_WCSCAT@ +HAVE_WCSCHR = @HAVE_WCSCHR@ +HAVE_WCSCMP = @HAVE_WCSCMP@ +HAVE_WCSCOLL = @HAVE_WCSCOLL@ +HAVE_WCSCPY = @HAVE_WCSCPY@ +HAVE_WCSCSPN = @HAVE_WCSCSPN@ +HAVE_WCSDUP = @HAVE_WCSDUP@ +HAVE_WCSFTIME = @HAVE_WCSFTIME@ +HAVE_WCSLEN = @HAVE_WCSLEN@ +HAVE_WCSNCASECMP = @HAVE_WCSNCASECMP@ +HAVE_WCSNCAT = @HAVE_WCSNCAT@ +HAVE_WCSNCMP = @HAVE_WCSNCMP@ +HAVE_WCSNCPY = @HAVE_WCSNCPY@ +HAVE_WCSNLEN = @HAVE_WCSNLEN@ +HAVE_WCSNRTOMBS = @HAVE_WCSNRTOMBS@ +HAVE_WCSPBRK = @HAVE_WCSPBRK@ +HAVE_WCSRCHR = @HAVE_WCSRCHR@ +HAVE_WCSRTOMBS = @HAVE_WCSRTOMBS@ +HAVE_WCSSPN = @HAVE_WCSSPN@ +HAVE_WCSSTR = @HAVE_WCSSTR@ +HAVE_WCSTOK = @HAVE_WCSTOK@ +HAVE_WCSWIDTH = @HAVE_WCSWIDTH@ +HAVE_WCSXFRM = @HAVE_WCSXFRM@ +HAVE_WINSOCK2_H = @HAVE_WINSOCK2_H@ +HAVE_WINT_T = @HAVE_WINT_T@ +HAVE_WMEMCHR = @HAVE_WMEMCHR@ +HAVE_WMEMCMP = @HAVE_WMEMCMP@ +HAVE_WMEMCPY = @HAVE_WMEMCPY@ +HAVE_WMEMMOVE = @HAVE_WMEMMOVE@ +HAVE_WMEMPCPY = @HAVE_WMEMPCPY@ +HAVE_WMEMSET = @HAVE_WMEMSET@ +HAVE_WS2TCPIP_H = @HAVE_WS2TCPIP_H@ +HAVE_XLOCALE_H = @HAVE_XLOCALE_H@ +HAVE__BOOL = @HAVE__BOOL@ +HAVE__EXIT = @HAVE__EXIT@ +HOGWEED_CFLAGS = @HOGWEED_CFLAGS@ +HOGWEED_LIBS = @HOGWEED_LIBS@ +HOSTENT_LIB = @HOSTENT_LIB@ +HTML_DIR = @HTML_DIR@ +INCLUDE_NEXT = @INCLUDE_NEXT@ +INCLUDE_NEXT_AS_FIRST_DIRECTIVE = @INCLUDE_NEXT_AS_FIRST_DIRECTIVE@ +INET_NTOP_LIB = @INET_NTOP_LIB@ +INET_PTON_LIB = @INET_PTON_LIB@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INT32_MAX_LT_INTMAX_MAX = @INT32_MAX_LT_INTMAX_MAX@ +INT64_MAX_EQ_LONG_MAX = @INT64_MAX_EQ_LONG_MAX@ +INTLLIBS = @INTLLIBS@ +INTL_MACOSX_LIBS = @INTL_MACOSX_LIBS@ +LCOV = @LCOV@ +LD = @LD@ +LDDPOSTPROC = @LDDPOSTPROC@ +LDDPROG = @LDDPROG@ +LDFLAGS = @LDFLAGS@ +LIBATOMIC_LIBS = @LIBATOMIC_LIBS@ +LIBBROTLIDEC_CFLAGS = @LIBBROTLIDEC_CFLAGS@ +LIBBROTLIDEC_LIBS = @LIBBROTLIDEC_LIBS@ +LIBBROTLIENC_CFLAGS = @LIBBROTLIENC_CFLAGS@ +LIBBROTLIENC_LIBS = @LIBBROTLIENC_LIBS@ +LIBCRYPTO = @LIBCRYPTO@ +LIBCRYPTO_PREFIX = @LIBCRYPTO_PREFIX@ +LIBDL = @LIBDL@ +LIBDL_PREFIX = @LIBDL_PREFIX@ +LIBEV = @LIBEV@ +LIBEV_LIBS = @LIBEV_LIBS@ +LIBEV_PREFIX = @LIBEV_PREFIX@ +LIBGNUTLS_CFLAGS = @LIBGNUTLS_CFLAGS@ +LIBGNUTLS_LIBS = @LIBGNUTLS_LIBS@ +LIBICONV = @LIBICONV@ +LIBIDN2_CFLAGS = @LIBIDN2_CFLAGS@ +LIBIDN2_LIBS = @LIBIDN2_LIBS@ +LIBINTL = @LIBINTL@ +LIBKCAPI_CFLAGS = @LIBKCAPI_CFLAGS@ +LIBKCAPI_LIBS = @LIBKCAPI_LIBS@ +LIBMULTITHREAD = @LIBMULTITHREAD@ +LIBOBJS = @LIBOBJS@ +LIBPMULTITHREAD = @LIBPMULTITHREAD@ +LIBPTHREAD = @LIBPTHREAD@ +LIBPTHREAD_PREFIX = @LIBPTHREAD_PREFIX@ +LIBRT = @LIBRT@ +LIBRT_PREFIX = @LIBRT_PREFIX@ +LIBS = @LIBS@ +LIBSECCOMP = @LIBSECCOMP@ +LIBSECCOMP_PREFIX = @LIBSECCOMP_PREFIX@ +LIBSOCKET = @LIBSOCKET@ +LIBSTDTHREAD = @LIBSTDTHREAD@ +LIBTASN1_CFLAGS = @LIBTASN1_CFLAGS@ +LIBTASN1_LIBS = @LIBTASN1_LIBS@ +LIBTESTS_LIBDEPS = @LIBTESTS_LIBDEPS@ +LIBTHREAD = @LIBTHREAD@ +LIBTOOL = @LIBTOOL@ +LIBUNISTRING = @LIBUNISTRING@ +LIBUNISTRING_UNICTYPE_H = @LIBUNISTRING_UNICTYPE_H@ +LIBUNISTRING_UNINORM_H = @LIBUNISTRING_UNINORM_H@ +LIBUNISTRING_UNISTR_H = @LIBUNISTRING_UNISTR_H@ +LIBUNISTRING_UNITYPES_H = @LIBUNISTRING_UNITYPES_H@ +LIBZ = @LIBZ@ +LIBZSTD_CFLAGS = @LIBZSTD_CFLAGS@ +LIBZSTD_LIBS = @LIBZSTD_LIBS@ +LIBZ_PC = @LIBZ_PC@ +LIBZ_PREFIX = @LIBZ_PREFIX@ +LIB_CLOCK_GETTIME = @LIB_CLOCK_GETTIME@ +LIB_NANOSLEEP = @LIB_NANOSLEEP@ +LIB_PTHREAD = @LIB_PTHREAD@ +LIB_PTHREAD_SIGMASK = @LIB_PTHREAD_SIGMASK@ +LIB_SCHED_YIELD = @LIB_SCHED_YIELD@ +LIB_SELECT = @LIB_SELECT@ +LIB_SEMAPHORE = @LIB_SEMAPHORE@ +LIB_SETLOCALE = @LIB_SETLOCALE@ +LIB_SETLOCALE_NULL = @LIB_SETLOCALE_NULL@ +LIMITS_H = @LIMITS_H@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LOCALENAME_ENHANCE_LOCALE_FUNCS = @LOCALENAME_ENHANCE_LOCALE_FUNCS@ +LOCALE_FR = @LOCALE_FR@ +LOCALE_FR_UTF8 = @LOCALE_FR_UTF8@ +LOCALE_JA = @LOCALE_JA@ +LOCALE_TR_UTF8 = @LOCALE_TR_UTF8@ +LOCALE_ZH_CN = @LOCALE_ZH_CN@ +LOG_VALGRIND = @LOG_VALGRIND@ +LTALLOCA = @LTALLOCA@ +LTLIBCRYPTO = @LTLIBCRYPTO@ +LTLIBDL = @LTLIBDL@ +LTLIBEV = @LTLIBEV@ +LTLIBICONV = @LTLIBICONV@ +LTLIBINTL = @LTLIBINTL@ +LTLIBMULTITHREAD = @LTLIBMULTITHREAD@ +LTLIBOBJS = @LTLIBOBJS@ +LTLIBPTHREAD = @LTLIBPTHREAD@ +LTLIBRT = @LTLIBRT@ +LTLIBSECCOMP = @LTLIBSECCOMP@ +LTLIBTHREAD = @LTLIBTHREAD@ +LTLIBZ = @LTLIBZ@ +LT_AGE = @LT_AGE@ +LT_CURRENT = @LT_CURRENT@ +LT_DANE_AGE = @LT_DANE_AGE@ +LT_DANE_CURRENT = @LT_DANE_CURRENT@ +LT_DANE_REVISION = @LT_DANE_REVISION@ +LT_REVISION = @LT_REVISION@ +LT_SSL_AGE = @LT_SSL_AGE@ +LT_SSL_CURRENT = @LT_SSL_CURRENT@ +LT_SSL_REVISION = @LT_SSL_REVISION@ +LT_SYS_LIBRARY_PATH = @LT_SYS_LIBRARY_PATH@ +LT_XSSL_AGE = @LT_XSSL_AGE@ +LT_XSSL_CURRENT = @LT_XSSL_CURRENT@ +LT_XSSL_REVISION = @LT_XSSL_REVISION@ +MAINT = @MAINT@ +MAJOR_VERSION = @MAJOR_VERSION@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MINOR_VERSION = @MINOR_VERSION@ +MKDIR_P = @MKDIR_P@ +MSGFMT = @MSGFMT@ +MSGMERGE = @MSGMERGE@ +MSGMERGE_FOR_MSGFMT_OPTION = @MSGMERGE_FOR_MSGFMT_OPTION@ +NETINET_IN_H = @NETINET_IN_H@ +NETTLE_CFLAGS = @NETTLE_CFLAGS@ +NETTLE_LIBS = @NETTLE_LIBS@ +NEXT_ARPA_INET_H = @NEXT_ARPA_INET_H@ +NEXT_AS_FIRST_DIRECTIVE_ARPA_INET_H = @NEXT_AS_FIRST_DIRECTIVE_ARPA_INET_H@ +NEXT_AS_FIRST_DIRECTIVE_CTYPE_H = @NEXT_AS_FIRST_DIRECTIVE_CTYPE_H@ +NEXT_AS_FIRST_DIRECTIVE_ERRNO_H = @NEXT_AS_FIRST_DIRECTIVE_ERRNO_H@ +NEXT_AS_FIRST_DIRECTIVE_FCNTL_H = @NEXT_AS_FIRST_DIRECTIVE_FCNTL_H@ +NEXT_AS_FIRST_DIRECTIVE_FLOAT_H = @NEXT_AS_FIRST_DIRECTIVE_FLOAT_H@ +NEXT_AS_FIRST_DIRECTIVE_INTTYPES_H = @NEXT_AS_FIRST_DIRECTIVE_INTTYPES_H@ +NEXT_AS_FIRST_DIRECTIVE_LANGINFO_H = @NEXT_AS_FIRST_DIRECTIVE_LANGINFO_H@ +NEXT_AS_FIRST_DIRECTIVE_LIMITS_H = @NEXT_AS_FIRST_DIRECTIVE_LIMITS_H@ +NEXT_AS_FIRST_DIRECTIVE_LOCALE_H = @NEXT_AS_FIRST_DIRECTIVE_LOCALE_H@ +NEXT_AS_FIRST_DIRECTIVE_NETDB_H = @NEXT_AS_FIRST_DIRECTIVE_NETDB_H@ +NEXT_AS_FIRST_DIRECTIVE_NETINET_IN_H = @NEXT_AS_FIRST_DIRECTIVE_NETINET_IN_H@ +NEXT_AS_FIRST_DIRECTIVE_PTHREAD_H = @NEXT_AS_FIRST_DIRECTIVE_PTHREAD_H@ +NEXT_AS_FIRST_DIRECTIVE_SCHED_H = @NEXT_AS_FIRST_DIRECTIVE_SCHED_H@ +NEXT_AS_FIRST_DIRECTIVE_SIGNAL_H = @NEXT_AS_FIRST_DIRECTIVE_SIGNAL_H@ +NEXT_AS_FIRST_DIRECTIVE_STDDEF_H = @NEXT_AS_FIRST_DIRECTIVE_STDDEF_H@ +NEXT_AS_FIRST_DIRECTIVE_STDINT_H = @NEXT_AS_FIRST_DIRECTIVE_STDINT_H@ +NEXT_AS_FIRST_DIRECTIVE_STDIO_H = @NEXT_AS_FIRST_DIRECTIVE_STDIO_H@ +NEXT_AS_FIRST_DIRECTIVE_STDLIB_H = @NEXT_AS_FIRST_DIRECTIVE_STDLIB_H@ +NEXT_AS_FIRST_DIRECTIVE_STRINGS_H = @NEXT_AS_FIRST_DIRECTIVE_STRINGS_H@ +NEXT_AS_FIRST_DIRECTIVE_STRING_H = @NEXT_AS_FIRST_DIRECTIVE_STRING_H@ +NEXT_AS_FIRST_DIRECTIVE_SYS_IOCTL_H = @NEXT_AS_FIRST_DIRECTIVE_SYS_IOCTL_H@ +NEXT_AS_FIRST_DIRECTIVE_SYS_SELECT_H = @NEXT_AS_FIRST_DIRECTIVE_SYS_SELECT_H@ +NEXT_AS_FIRST_DIRECTIVE_SYS_SOCKET_H = @NEXT_AS_FIRST_DIRECTIVE_SYS_SOCKET_H@ +NEXT_AS_FIRST_DIRECTIVE_SYS_STAT_H = @NEXT_AS_FIRST_DIRECTIVE_SYS_STAT_H@ +NEXT_AS_FIRST_DIRECTIVE_SYS_TIME_H = @NEXT_AS_FIRST_DIRECTIVE_SYS_TIME_H@ +NEXT_AS_FIRST_DIRECTIVE_SYS_TYPES_H = @NEXT_AS_FIRST_DIRECTIVE_SYS_TYPES_H@ +NEXT_AS_FIRST_DIRECTIVE_SYS_UIO_H = @NEXT_AS_FIRST_DIRECTIVE_SYS_UIO_H@ +NEXT_AS_FIRST_DIRECTIVE_TIME_H = @NEXT_AS_FIRST_DIRECTIVE_TIME_H@ +NEXT_AS_FIRST_DIRECTIVE_UNISTD_H = @NEXT_AS_FIRST_DIRECTIVE_UNISTD_H@ +NEXT_AS_FIRST_DIRECTIVE_WCHAR_H = @NEXT_AS_FIRST_DIRECTIVE_WCHAR_H@ +NEXT_CTYPE_H = @NEXT_CTYPE_H@ +NEXT_ERRNO_H = @NEXT_ERRNO_H@ +NEXT_FCNTL_H = @NEXT_FCNTL_H@ +NEXT_FLOAT_H = @NEXT_FLOAT_H@ +NEXT_INTTYPES_H = @NEXT_INTTYPES_H@ +NEXT_LANGINFO_H = @NEXT_LANGINFO_H@ +NEXT_LIMITS_H = @NEXT_LIMITS_H@ +NEXT_LOCALE_H = @NEXT_LOCALE_H@ +NEXT_NETDB_H = @NEXT_NETDB_H@ +NEXT_NETINET_IN_H = @NEXT_NETINET_IN_H@ +NEXT_PTHREAD_H = @NEXT_PTHREAD_H@ +NEXT_SCHED_H = @NEXT_SCHED_H@ +NEXT_SIGNAL_H = @NEXT_SIGNAL_H@ +NEXT_STDDEF_H = @NEXT_STDDEF_H@ +NEXT_STDINT_H = @NEXT_STDINT_H@ +NEXT_STDIO_H = @NEXT_STDIO_H@ +NEXT_STDLIB_H = @NEXT_STDLIB_H@ +NEXT_STRINGS_H = @NEXT_STRINGS_H@ +NEXT_STRING_H = @NEXT_STRING_H@ +NEXT_SYS_IOCTL_H = @NEXT_SYS_IOCTL_H@ +NEXT_SYS_SELECT_H = @NEXT_SYS_SELECT_H@ +NEXT_SYS_SOCKET_H = @NEXT_SYS_SOCKET_H@ +NEXT_SYS_STAT_H = @NEXT_SYS_STAT_H@ +NEXT_SYS_TIME_H = @NEXT_SYS_TIME_H@ +NEXT_SYS_TYPES_H = @NEXT_SYS_TYPES_H@ +NEXT_SYS_UIO_H = @NEXT_SYS_UIO_H@ +NEXT_TIME_H = @NEXT_TIME_H@ +NEXT_UNISTD_H = @NEXT_UNISTD_H@ +NEXT_WCHAR_H = @NEXT_WCHAR_H@ +NM = @NM@ +NMEDIT = @NMEDIT@ +NUMBER_VERSION = @NUMBER_VERSION@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +P11_KIT_CFLAGS = @P11_KIT_CFLAGS@ +P11_KIT_LIBS = @P11_KIT_LIBS@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PARSE_DATETIME_BISON = @PARSE_DATETIME_BISON@ +PATCH_VERSION = @PATCH_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKCS12_ITER_COUNT = @PKCS12_ITER_COUNT@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +PMCCABE = @PMCCABE@ +POSUB = @POSUB@ +PRAGMA_COLUMNS = @PRAGMA_COLUMNS@ +PRAGMA_SYSTEM_HEADER = @PRAGMA_SYSTEM_HEADER@ +PRIPTR_PREFIX = @PRIPTR_PREFIX@ +PTHREAD_H_DEFINES_STRUCT_TIMESPEC = @PTHREAD_H_DEFINES_STRUCT_TIMESPEC@ +PTRDIFF_T_SUFFIX = @PTRDIFF_T_SUFFIX@ +PYTHON = @PYTHON@ +PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@ +PYTHON_PLATFORM = @PYTHON_PLATFORM@ +PYTHON_PREFIX = @PYTHON_PREFIX@ +PYTHON_VERSION = @PYTHON_VERSION@ +RANLIB = @RANLIB@ +REPLACE_ACCESS = @REPLACE_ACCESS@ +REPLACE_ALIGNED_ALLOC = @REPLACE_ALIGNED_ALLOC@ +REPLACE_BTOWC = @REPLACE_BTOWC@ +REPLACE_CALLOC = @REPLACE_CALLOC@ +REPLACE_CANONICALIZE_FILE_NAME = @REPLACE_CANONICALIZE_FILE_NAME@ +REPLACE_CHOWN = @REPLACE_CHOWN@ +REPLACE_CLOSE = @REPLACE_CLOSE@ +REPLACE_CREAT = @REPLACE_CREAT@ +REPLACE_CTIME = @REPLACE_CTIME@ +REPLACE_DPRINTF = @REPLACE_DPRINTF@ +REPLACE_DUP = @REPLACE_DUP@ +REPLACE_DUP2 = @REPLACE_DUP2@ +REPLACE_DUPLOCALE = @REPLACE_DUPLOCALE@ +REPLACE_EXECL = @REPLACE_EXECL@ +REPLACE_EXECLE = @REPLACE_EXECLE@ +REPLACE_EXECLP = @REPLACE_EXECLP@ +REPLACE_EXECV = @REPLACE_EXECV@ +REPLACE_EXECVE = @REPLACE_EXECVE@ +REPLACE_EXECVP = @REPLACE_EXECVP@ +REPLACE_EXECVPE = @REPLACE_EXECVPE@ +REPLACE_FACCESSAT = @REPLACE_FACCESSAT@ +REPLACE_FCHMODAT = @REPLACE_FCHMODAT@ +REPLACE_FCHOWNAT = @REPLACE_FCHOWNAT@ +REPLACE_FCLOSE = @REPLACE_FCLOSE@ +REPLACE_FCNTL = @REPLACE_FCNTL@ +REPLACE_FDOPEN = @REPLACE_FDOPEN@ +REPLACE_FFLUSH = @REPLACE_FFLUSH@ +REPLACE_FFSLL = @REPLACE_FFSLL@ +REPLACE_FOPEN = @REPLACE_FOPEN@ +REPLACE_FPRINTF = @REPLACE_FPRINTF@ +REPLACE_FPURGE = @REPLACE_FPURGE@ +REPLACE_FREE = @REPLACE_FREE@ +REPLACE_FREELOCALE = @REPLACE_FREELOCALE@ +REPLACE_FREOPEN = @REPLACE_FREOPEN@ +REPLACE_FSEEK = @REPLACE_FSEEK@ +REPLACE_FSEEKO = @REPLACE_FSEEKO@ +REPLACE_FSTAT = @REPLACE_FSTAT@ +REPLACE_FSTATAT = @REPLACE_FSTATAT@ +REPLACE_FTELL = @REPLACE_FTELL@ +REPLACE_FTELLO = @REPLACE_FTELLO@ +REPLACE_FTRUNCATE = @REPLACE_FTRUNCATE@ +REPLACE_FUTIMENS = @REPLACE_FUTIMENS@ +REPLACE_GAI_STRERROR = @REPLACE_GAI_STRERROR@ +REPLACE_GETADDRINFO = @REPLACE_GETADDRINFO@ +REPLACE_GETCWD = @REPLACE_GETCWD@ +REPLACE_GETDELIM = @REPLACE_GETDELIM@ +REPLACE_GETDOMAINNAME = @REPLACE_GETDOMAINNAME@ +REPLACE_GETDTABLESIZE = @REPLACE_GETDTABLESIZE@ +REPLACE_GETGROUPS = @REPLACE_GETGROUPS@ +REPLACE_GETLINE = @REPLACE_GETLINE@ +REPLACE_GETLOGIN_R = @REPLACE_GETLOGIN_R@ +REPLACE_GETPAGESIZE = @REPLACE_GETPAGESIZE@ +REPLACE_GETPASS = @REPLACE_GETPASS@ +REPLACE_GETTIMEOFDAY = @REPLACE_GETTIMEOFDAY@ +REPLACE_GMTIME = @REPLACE_GMTIME@ +REPLACE_INET_NTOP = @REPLACE_INET_NTOP@ +REPLACE_INET_PTON = @REPLACE_INET_PTON@ +REPLACE_INITSTATE = @REPLACE_INITSTATE@ +REPLACE_IOCTL = @REPLACE_IOCTL@ +REPLACE_ISATTY = @REPLACE_ISATTY@ +REPLACE_ITOLD = @REPLACE_ITOLD@ +REPLACE_LCHOWN = @REPLACE_LCHOWN@ +REPLACE_LINK = @REPLACE_LINK@ +REPLACE_LINKAT = @REPLACE_LINKAT@ +REPLACE_LOCALECONV = @REPLACE_LOCALECONV@ +REPLACE_LOCALTIME = @REPLACE_LOCALTIME@ +REPLACE_LOCALTIME_R = @REPLACE_LOCALTIME_R@ +REPLACE_LSEEK = @REPLACE_LSEEK@ +REPLACE_LSTAT = @REPLACE_LSTAT@ +REPLACE_MALLOC = @REPLACE_MALLOC@ +REPLACE_MBRLEN = @REPLACE_MBRLEN@ +REPLACE_MBRTOWC = @REPLACE_MBRTOWC@ +REPLACE_MBSINIT = @REPLACE_MBSINIT@ +REPLACE_MBSNRTOWCS = @REPLACE_MBSNRTOWCS@ +REPLACE_MBSRTOWCS = @REPLACE_MBSRTOWCS@ +REPLACE_MBSTATE_T = @REPLACE_MBSTATE_T@ +REPLACE_MBTOWC = @REPLACE_MBTOWC@ +REPLACE_MEMCHR = @REPLACE_MEMCHR@ +REPLACE_MEMMEM = @REPLACE_MEMMEM@ +REPLACE_MKDIR = @REPLACE_MKDIR@ +REPLACE_MKFIFO = @REPLACE_MKFIFO@ +REPLACE_MKFIFOAT = @REPLACE_MKFIFOAT@ +REPLACE_MKNOD = @REPLACE_MKNOD@ +REPLACE_MKNODAT = @REPLACE_MKNODAT@ +REPLACE_MKSTEMP = @REPLACE_MKSTEMP@ +REPLACE_MKTIME = @REPLACE_MKTIME@ +REPLACE_NANOSLEEP = @REPLACE_NANOSLEEP@ +REPLACE_NEWLOCALE = @REPLACE_NEWLOCALE@ +REPLACE_NL_LANGINFO = @REPLACE_NL_LANGINFO@ +REPLACE_NULL = @REPLACE_NULL@ +REPLACE_OBSTACK_PRINTF = @REPLACE_OBSTACK_PRINTF@ +REPLACE_OPEN = @REPLACE_OPEN@ +REPLACE_OPENAT = @REPLACE_OPENAT@ +REPLACE_PERROR = @REPLACE_PERROR@ +REPLACE_POPEN = @REPLACE_POPEN@ +REPLACE_POSIX_MEMALIGN = @REPLACE_POSIX_MEMALIGN@ +REPLACE_PREAD = @REPLACE_PREAD@ +REPLACE_PRINTF = @REPLACE_PRINTF@ +REPLACE_PSELECT = @REPLACE_PSELECT@ +REPLACE_PTHREAD_ATTR_DESTROY = @REPLACE_PTHREAD_ATTR_DESTROY@ +REPLACE_PTHREAD_ATTR_GETDETACHSTATE = @REPLACE_PTHREAD_ATTR_GETDETACHSTATE@ +REPLACE_PTHREAD_ATTR_INIT = @REPLACE_PTHREAD_ATTR_INIT@ +REPLACE_PTHREAD_ATTR_SETDETACHSTATE = @REPLACE_PTHREAD_ATTR_SETDETACHSTATE@ +REPLACE_PTHREAD_CONDATTR_DESTROY = @REPLACE_PTHREAD_CONDATTR_DESTROY@ +REPLACE_PTHREAD_CONDATTR_INIT = @REPLACE_PTHREAD_CONDATTR_INIT@ +REPLACE_PTHREAD_COND_BROADCAST = @REPLACE_PTHREAD_COND_BROADCAST@ +REPLACE_PTHREAD_COND_DESTROY = @REPLACE_PTHREAD_COND_DESTROY@ +REPLACE_PTHREAD_COND_INIT = @REPLACE_PTHREAD_COND_INIT@ +REPLACE_PTHREAD_COND_SIGNAL = @REPLACE_PTHREAD_COND_SIGNAL@ +REPLACE_PTHREAD_COND_TIMEDWAIT = @REPLACE_PTHREAD_COND_TIMEDWAIT@ +REPLACE_PTHREAD_COND_WAIT = @REPLACE_PTHREAD_COND_WAIT@ +REPLACE_PTHREAD_CREATE = @REPLACE_PTHREAD_CREATE@ +REPLACE_PTHREAD_DETACH = @REPLACE_PTHREAD_DETACH@ +REPLACE_PTHREAD_EQUAL = @REPLACE_PTHREAD_EQUAL@ +REPLACE_PTHREAD_EXIT = @REPLACE_PTHREAD_EXIT@ +REPLACE_PTHREAD_GETSPECIFIC = @REPLACE_PTHREAD_GETSPECIFIC@ +REPLACE_PTHREAD_JOIN = @REPLACE_PTHREAD_JOIN@ +REPLACE_PTHREAD_KEY_CREATE = @REPLACE_PTHREAD_KEY_CREATE@ +REPLACE_PTHREAD_KEY_DELETE = @REPLACE_PTHREAD_KEY_DELETE@ +REPLACE_PTHREAD_MUTEXATTR_DESTROY = @REPLACE_PTHREAD_MUTEXATTR_DESTROY@ +REPLACE_PTHREAD_MUTEXATTR_GETROBUST = @REPLACE_PTHREAD_MUTEXATTR_GETROBUST@ +REPLACE_PTHREAD_MUTEXATTR_GETTYPE = @REPLACE_PTHREAD_MUTEXATTR_GETTYPE@ +REPLACE_PTHREAD_MUTEXATTR_INIT = @REPLACE_PTHREAD_MUTEXATTR_INIT@ +REPLACE_PTHREAD_MUTEXATTR_SETROBUST = @REPLACE_PTHREAD_MUTEXATTR_SETROBUST@ +REPLACE_PTHREAD_MUTEXATTR_SETTYPE = @REPLACE_PTHREAD_MUTEXATTR_SETTYPE@ +REPLACE_PTHREAD_MUTEX_DESTROY = @REPLACE_PTHREAD_MUTEX_DESTROY@ +REPLACE_PTHREAD_MUTEX_INIT = @REPLACE_PTHREAD_MUTEX_INIT@ +REPLACE_PTHREAD_MUTEX_LOCK = @REPLACE_PTHREAD_MUTEX_LOCK@ +REPLACE_PTHREAD_MUTEX_TIMEDLOCK = @REPLACE_PTHREAD_MUTEX_TIMEDLOCK@ +REPLACE_PTHREAD_MUTEX_TRYLOCK = @REPLACE_PTHREAD_MUTEX_TRYLOCK@ +REPLACE_PTHREAD_MUTEX_UNLOCK = @REPLACE_PTHREAD_MUTEX_UNLOCK@ +REPLACE_PTHREAD_ONCE = @REPLACE_PTHREAD_ONCE@ +REPLACE_PTHREAD_RWLOCKATTR_DESTROY = @REPLACE_PTHREAD_RWLOCKATTR_DESTROY@ +REPLACE_PTHREAD_RWLOCKATTR_INIT = @REPLACE_PTHREAD_RWLOCKATTR_INIT@ +REPLACE_PTHREAD_RWLOCK_DESTROY = @REPLACE_PTHREAD_RWLOCK_DESTROY@ +REPLACE_PTHREAD_RWLOCK_INIT = @REPLACE_PTHREAD_RWLOCK_INIT@ +REPLACE_PTHREAD_RWLOCK_RDLOCK = @REPLACE_PTHREAD_RWLOCK_RDLOCK@ +REPLACE_PTHREAD_RWLOCK_TIMEDRDLOCK = @REPLACE_PTHREAD_RWLOCK_TIMEDRDLOCK@ +REPLACE_PTHREAD_RWLOCK_TIMEDWRLOCK = @REPLACE_PTHREAD_RWLOCK_TIMEDWRLOCK@ +REPLACE_PTHREAD_RWLOCK_TRYRDLOCK = @REPLACE_PTHREAD_RWLOCK_TRYRDLOCK@ +REPLACE_PTHREAD_RWLOCK_TRYWRLOCK = @REPLACE_PTHREAD_RWLOCK_TRYWRLOCK@ +REPLACE_PTHREAD_RWLOCK_UNLOCK = @REPLACE_PTHREAD_RWLOCK_UNLOCK@ +REPLACE_PTHREAD_RWLOCK_WRLOCK = @REPLACE_PTHREAD_RWLOCK_WRLOCK@ +REPLACE_PTHREAD_SELF = @REPLACE_PTHREAD_SELF@ +REPLACE_PTHREAD_SETSPECIFIC = @REPLACE_PTHREAD_SETSPECIFIC@ +REPLACE_PTHREAD_SIGMASK = @REPLACE_PTHREAD_SIGMASK@ +REPLACE_PTHREAD_SPIN_DESTROY = @REPLACE_PTHREAD_SPIN_DESTROY@ +REPLACE_PTHREAD_SPIN_INIT = @REPLACE_PTHREAD_SPIN_INIT@ +REPLACE_PTHREAD_SPIN_LOCK = @REPLACE_PTHREAD_SPIN_LOCK@ +REPLACE_PTHREAD_SPIN_TRYLOCK = @REPLACE_PTHREAD_SPIN_TRYLOCK@ +REPLACE_PTHREAD_SPIN_UNLOCK = @REPLACE_PTHREAD_SPIN_UNLOCK@ +REPLACE_PTSNAME = @REPLACE_PTSNAME@ +REPLACE_PTSNAME_R = @REPLACE_PTSNAME_R@ +REPLACE_PUTENV = @REPLACE_PUTENV@ +REPLACE_PWRITE = @REPLACE_PWRITE@ +REPLACE_QSORT_R = @REPLACE_QSORT_R@ +REPLACE_RAISE = @REPLACE_RAISE@ +REPLACE_RANDOM = @REPLACE_RANDOM@ +REPLACE_RANDOM_R = @REPLACE_RANDOM_R@ +REPLACE_READ = @REPLACE_READ@ +REPLACE_READLINK = @REPLACE_READLINK@ +REPLACE_READLINKAT = @REPLACE_READLINKAT@ +REPLACE_REALLOC = @REPLACE_REALLOC@ +REPLACE_REALLOCARRAY = @REPLACE_REALLOCARRAY@ +REPLACE_REALPATH = @REPLACE_REALPATH@ +REPLACE_REMOVE = @REPLACE_REMOVE@ +REPLACE_RENAME = @REPLACE_RENAME@ +REPLACE_RENAMEAT = @REPLACE_RENAMEAT@ +REPLACE_RMDIR = @REPLACE_RMDIR@ +REPLACE_SCHED_YIELD = @REPLACE_SCHED_YIELD@ +REPLACE_SELECT = @REPLACE_SELECT@ +REPLACE_SETENV = @REPLACE_SETENV@ +REPLACE_SETLOCALE = @REPLACE_SETLOCALE@ +REPLACE_SETSTATE = @REPLACE_SETSTATE@ +REPLACE_SLEEP = @REPLACE_SLEEP@ +REPLACE_SNPRINTF = @REPLACE_SNPRINTF@ +REPLACE_SPRINTF = @REPLACE_SPRINTF@ +REPLACE_STAT = @REPLACE_STAT@ +REPLACE_STDIO_READ_FUNCS = @REPLACE_STDIO_READ_FUNCS@ +REPLACE_STDIO_WRITE_FUNCS = @REPLACE_STDIO_WRITE_FUNCS@ +REPLACE_STPNCPY = @REPLACE_STPNCPY@ +REPLACE_STRCASESTR = @REPLACE_STRCASESTR@ +REPLACE_STRCHRNUL = @REPLACE_STRCHRNUL@ +REPLACE_STRDUP = @REPLACE_STRDUP@ +REPLACE_STRERROR = @REPLACE_STRERROR@ +REPLACE_STRERRORNAME_NP = @REPLACE_STRERRORNAME_NP@ +REPLACE_STRERROR_R = @REPLACE_STRERROR_R@ +REPLACE_STRFTIME = @REPLACE_STRFTIME@ +REPLACE_STRNCAT = @REPLACE_STRNCAT@ +REPLACE_STRNDUP = @REPLACE_STRNDUP@ +REPLACE_STRNLEN = @REPLACE_STRNLEN@ +REPLACE_STRSIGNAL = @REPLACE_STRSIGNAL@ +REPLACE_STRSTR = @REPLACE_STRSTR@ +REPLACE_STRTOD = @REPLACE_STRTOD@ +REPLACE_STRTOIMAX = @REPLACE_STRTOIMAX@ +REPLACE_STRTOK_R = @REPLACE_STRTOK_R@ +REPLACE_STRTOL = @REPLACE_STRTOL@ +REPLACE_STRTOLD = @REPLACE_STRTOLD@ +REPLACE_STRTOLL = @REPLACE_STRTOLL@ +REPLACE_STRTOUL = @REPLACE_STRTOUL@ +REPLACE_STRTOULL = @REPLACE_STRTOULL@ +REPLACE_STRTOUMAX = @REPLACE_STRTOUMAX@ +REPLACE_STRUCT_LCONV = @REPLACE_STRUCT_LCONV@ +REPLACE_STRUCT_TIMEVAL = @REPLACE_STRUCT_TIMEVAL@ +REPLACE_SYMLINK = @REPLACE_SYMLINK@ +REPLACE_SYMLINKAT = @REPLACE_SYMLINKAT@ +REPLACE_TIMEGM = @REPLACE_TIMEGM@ +REPLACE_TMPFILE = @REPLACE_TMPFILE@ +REPLACE_TRUNCATE = @REPLACE_TRUNCATE@ +REPLACE_TTYNAME_R = @REPLACE_TTYNAME_R@ +REPLACE_TZSET = @REPLACE_TZSET@ +REPLACE_UNLINK = @REPLACE_UNLINK@ +REPLACE_UNLINKAT = @REPLACE_UNLINKAT@ +REPLACE_UNSETENV = @REPLACE_UNSETENV@ +REPLACE_USLEEP = @REPLACE_USLEEP@ +REPLACE_UTIMENSAT = @REPLACE_UTIMENSAT@ +REPLACE_VASPRINTF = @REPLACE_VASPRINTF@ +REPLACE_VDPRINTF = @REPLACE_VDPRINTF@ +REPLACE_VFPRINTF = @REPLACE_VFPRINTF@ +REPLACE_VPRINTF = @REPLACE_VPRINTF@ +REPLACE_VSNPRINTF = @REPLACE_VSNPRINTF@ +REPLACE_VSPRINTF = @REPLACE_VSPRINTF@ +REPLACE_WCRTOMB = @REPLACE_WCRTOMB@ +REPLACE_WCSFTIME = @REPLACE_WCSFTIME@ +REPLACE_WCSNRTOMBS = @REPLACE_WCSNRTOMBS@ +REPLACE_WCSRTOMBS = @REPLACE_WCSRTOMBS@ +REPLACE_WCSTOK = @REPLACE_WCSTOK@ +REPLACE_WCSWIDTH = @REPLACE_WCSWIDTH@ +REPLACE_WCTOB = @REPLACE_WCTOB@ +REPLACE_WCTOMB = @REPLACE_WCTOMB@ +REPLACE_WCWIDTH = @REPLACE_WCWIDTH@ +REPLACE_WRITE = @REPLACE_WRITE@ +SED = @SED@ +SERVENT_LIB = @SERVENT_LIB@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +SIG_ATOMIC_T_SUFFIX = @SIG_ATOMIC_T_SUFFIX@ +SIZE_T_SUFFIX = @SIZE_T_SUFFIX@ +STDALIGN_H = @STDALIGN_H@ +STDBOOL_H = @STDBOOL_H@ +STDDEF_H = @STDDEF_H@ +STDINT_H = @STDINT_H@ +STRIP = @STRIP@ +SYS_IOCTL_H_HAVE_WINSOCK2_H = @SYS_IOCTL_H_HAVE_WINSOCK2_H@ +SYS_IOCTL_H_HAVE_WINSOCK2_H_AND_USE_SOCKETS = @SYS_IOCTL_H_HAVE_WINSOCK2_H_AND_USE_SOCKETS@ +SYS_TIME_H_DEFINES_STRUCT_TIMESPEC = @SYS_TIME_H_DEFINES_STRUCT_TIMESPEC@ +TIME_H_DEFINES_STRUCT_TIMESPEC = @TIME_H_DEFINES_STRUCT_TIMESPEC@ +TIME_H_DEFINES_TIME_UTC = @TIME_H_DEFINES_TIME_UTC@ +TROUSERS_LIB = @TROUSERS_LIB@ +TSS2_CFLAGS = @TSS2_CFLAGS@ +TSS2_LIBS = @TSS2_LIBS@ +TSS_CFLAGS = @TSS_CFLAGS@ +TSS_LIBS = @TSS_LIBS@ +UINT32_MAX_LT_UINTMAX_MAX = @UINT32_MAX_LT_UINTMAX_MAX@ +UINT64_MAX_EQ_ULONG_MAX = @UINT64_MAX_EQ_ULONG_MAX@ +UNBOUND_CFLAGS = @UNBOUND_CFLAGS@ +UNBOUND_LIBS = @UNBOUND_LIBS@ +UNDEFINE_STRTOK_R = @UNDEFINE_STRTOK_R@ +UNISTD_H_DEFINES_STRUCT_TIMESPEC = @UNISTD_H_DEFINES_STRUCT_TIMESPEC@ +UNISTD_H_HAVE_SYS_RANDOM_H = @UNISTD_H_HAVE_SYS_RANDOM_H@ +UNISTD_H_HAVE_WINSOCK2_H = @UNISTD_H_HAVE_WINSOCK2_H@ +UNISTD_H_HAVE_WINSOCK2_H_AND_USE_SOCKETS = @UNISTD_H_HAVE_WINSOCK2_H_AND_USE_SOCKETS@ +USE_NLS = @USE_NLS@ +VALGRIND = @VALGRIND@ +VALGRINDFLAGS = @VALGRINDFLAGS@ +VALGRIND_PROGRAM = @VALGRIND_PROGRAM@ +VERSION = @VERSION@ +WARN_CFLAGS = @WARN_CFLAGS@ +WCHAR_T_SUFFIX = @WCHAR_T_SUFFIX@ +WERROR_CFLAGS = @WERROR_CFLAGS@ +WINDOWS_64_BIT_OFF_T = @WINDOWS_64_BIT_OFF_T@ +WINDOWS_64_BIT_ST_SIZE = @WINDOWS_64_BIT_ST_SIZE@ +WINDOWS_STAT_INODES = @WINDOWS_STAT_INODES@ +WINDOWS_STAT_TIMESPEC = @WINDOWS_STAT_TIMESPEC@ +WINT_T_SUFFIX = @WINT_T_SUFFIX@ +WSTACK_CFLAGS = @WSTACK_CFLAGS@ +XGETTEXT = @XGETTEXT@ +XGETTEXT_015 = @XGETTEXT_015@ +XGETTEXT_EXTRA_OPTIONS = @XGETTEXT_EXTRA_OPTIONS@ +YACC = @YACC@ +YFLAGS = @YFLAGS@ +YIELD_LIB = @YIELD_LIB@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +ac_cv_sizeof_time_t = @ac_cv_sizeof_time_t@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +ggl_LIBOBJS = @ggl_LIBOBJS@ +ggl_LTLIBOBJS = @ggl_LTLIBOBJS@ +ggltests_LIBOBJS = @ggltests_LIBOBJS@ +ggltests_LTLIBOBJS = @ggltests_LTLIBOBJS@ +ggltests_WITNESS = @ggltests_WITNESS@ +gl_LIBOBJS = @gl_LIBOBJS@ +gl_LTLIBOBJS = @gl_LTLIBOBJS@ +gltests_LIBOBJS = @gltests_LIBOBJS@ +gltests_LTLIBOBJS = @gltests_LTLIBOBJS@ +gltests_WITNESS = @gltests_WITNESS@ +gnutls_so = @gnutls_so@ +guile_snarf = @guile_snarf@ +guileextensiondir = @guileextensiondir@ +guilesiteccachedir = @guilesiteccachedir@ +guilesitedir = @guilesitedir@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +ifGNUmake = @ifGNUmake@ +ifnGNUmake = @ifnGNUmake@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +maybe_guileextensiondir = @maybe_guileextensiondir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +pkgpyexecdir = @pkgpyexecdir@ +pkgpythondir = @pkgpythondir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +pyexecdir = @pyexecdir@ +pythondir = @pythondir@ +runstatedir = @runstatedir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +unistring_LIBOBJS = @unistring_LIBOBJS@ +unistring_LTLIBOBJS = @unistring_LTLIBOBJS@ +unistringtests_LIBOBJS = @unistringtests_LIBOBJS@ +unistringtests_LTLIBOBJS = @unistringtests_LTLIBOBJS@ +unistringtests_WITNESS = @unistringtests_WITNESS@ +man_MANS = $(am__append_1) $(am__append_2) $(am__append_3) \ + $(am__append_4) +EXTRA_DIST = stamp_mans $(TOOLS_MANS) $(SRP_MANS) $(DANE_MANS) \ + $(APIMANS) +MAINTAINERCLEANFILES = stamp_mans $(TOOLS_MANS) $(SRP_MANS) \ + $(DANE_MANS) $(APIMANS) +TOOLS_MANS = gnutls-cli.1 gnutls-cli-debug.1 gnutls-serv.1 \ + certtool.1 psktool.1 p11tool.1 ocsptool.1 tpmtool.1 + +SRP_MANS = srptool.1 +DANE_MANS = danetool.1 +CLIGEN_ARGS = \ + --license=gpl3+ \ + --package '$(PACKAGE)' \ + --version='$(VERSION)' \ + --authors='Nikos Mavrogiannopoulos, Simon Josefsson and others; see /usr/share/doc/gnutls/AUTHORS for a complete list.' \ + --copyright-year=2020-2021 \ + --copyright-holder='Free Software Foundation, and others all rights reserved.' \ + --bug-email=bugs@gnutls.org + +APIMANS = dane_cert_type_name.3 dane_cert_usage_name.3 \ + dane_match_type_name.3 dane_query_data.3 dane_query_deinit.3 \ + dane_query_entries.3 dane_query_status.3 dane_query_tlsa.3 \ + dane_query_to_raw_tlsa.3 dane_raw_tlsa.3 dane_state_deinit.3 \ + dane_state_init.3 dane_state_set_dlv_file.3 dane_strerror.3 \ + dane_verification_status_print.3 dane_verify_crt.3 \ + dane_verify_crt_raw.3 dane_verify_session_crt.3 \ + gnutls_aead_cipher_decrypt.3 gnutls_aead_cipher_decryptv2.3 \ + gnutls_aead_cipher_deinit.3 gnutls_aead_cipher_encrypt.3 \ + gnutls_aead_cipher_encryptv.3 gnutls_aead_cipher_encryptv2.3 \ + gnutls_aead_cipher_init.3 gnutls_aead_cipher_set_key.3 \ + gnutls_alert_get.3 gnutls_alert_get_name.3 \ + gnutls_alert_get_strname.3 gnutls_alert_send.3 \ + gnutls_alert_send_appropriate.3 \ + gnutls_alert_set_read_function.3 \ + gnutls_alpn_get_selected_protocol.3 \ + gnutls_alpn_set_protocols.3 \ + gnutls_anon_allocate_client_credentials.3 \ + gnutls_anon_allocate_server_credentials.3 \ + gnutls_anon_free_client_credentials.3 \ + gnutls_anon_free_server_credentials.3 \ + gnutls_anon_set_params_function.3 \ + gnutls_anon_set_server_dh_params.3 \ + gnutls_anon_set_server_known_dh_params.3 \ + gnutls_anon_set_server_params_function.3 \ + gnutls_anti_replay_deinit.3 gnutls_anti_replay_enable.3 \ + gnutls_anti_replay_init.3 \ + gnutls_anti_replay_set_add_function.3 \ + gnutls_anti_replay_set_ptr.3 gnutls_anti_replay_set_window.3 \ + gnutls_auth_client_get_type.3 gnutls_auth_get_type.3 \ + gnutls_auth_server_get_type.3 gnutls_base64_decode2.3 \ + gnutls_base64_encode2.3 gnutls_buffer_append_data.3 \ + gnutls_bye.3 gnutls_certificate_activation_time_peers.3 \ + gnutls_certificate_allocate_credentials.3 \ + gnutls_certificate_client_get_request_status.3 \ + gnutls_certificate_expiration_time_peers.3 \ + gnutls_certificate_free_ca_names.3 \ + gnutls_certificate_free_cas.3 \ + gnutls_certificate_free_credentials.3 \ + gnutls_certificate_free_crls.3 gnutls_certificate_free_keys.3 \ + gnutls_certificate_get_crt_raw.3 \ + gnutls_certificate_get_issuer.3 \ + gnutls_certificate_get_ocsp_expiration.3 \ + gnutls_certificate_get_ours.3 gnutls_certificate_get_peers.3 \ + gnutls_certificate_get_peers_subkey_id.3 \ + gnutls_certificate_get_trust_list.3 \ + gnutls_certificate_get_verify_flags.3 \ + gnutls_certificate_get_x509_crt.3 \ + gnutls_certificate_get_x509_key.3 \ + gnutls_certificate_send_x509_rdn_sequence.3 \ + gnutls_certificate_server_set_request.3 \ + gnutls_certificate_set_dh_params.3 \ + gnutls_certificate_set_flags.3 gnutls_certificate_set_key.3 \ + gnutls_certificate_set_known_dh_params.3 \ + gnutls_certificate_set_ocsp_status_request_file.3 \ + gnutls_certificate_set_ocsp_status_request_file2.3 \ + gnutls_certificate_set_ocsp_status_request_function.3 \ + gnutls_certificate_set_ocsp_status_request_function2.3 \ + gnutls_certificate_set_ocsp_status_request_mem.3 \ + gnutls_certificate_set_params_function.3 \ + gnutls_certificate_set_pin_function.3 \ + gnutls_certificate_set_rawpk_key_file.3 \ + gnutls_certificate_set_rawpk_key_mem.3 \ + gnutls_certificate_set_retrieve_function.3 \ + gnutls_certificate_set_retrieve_function2.3 \ + gnutls_certificate_set_retrieve_function3.3 \ + gnutls_certificate_set_trust_list.3 \ + gnutls_certificate_set_verify_flags.3 \ + gnutls_certificate_set_verify_function.3 \ + gnutls_certificate_set_verify_limits.3 \ + gnutls_certificate_set_x509_crl.3 \ + gnutls_certificate_set_x509_crl_file.3 \ + gnutls_certificate_set_x509_crl_mem.3 \ + gnutls_certificate_set_x509_key.3 \ + gnutls_certificate_set_x509_key_file.3 \ + gnutls_certificate_set_x509_key_file2.3 \ + gnutls_certificate_set_x509_key_mem.3 \ + gnutls_certificate_set_x509_key_mem2.3 \ + gnutls_certificate_set_x509_simple_pkcs12_file.3 \ + gnutls_certificate_set_x509_simple_pkcs12_mem.3 \ + gnutls_certificate_set_x509_system_trust.3 \ + gnutls_certificate_set_x509_trust.3 \ + gnutls_certificate_set_x509_trust_dir.3 \ + gnutls_certificate_set_x509_trust_file.3 \ + gnutls_certificate_set_x509_trust_mem.3 \ + gnutls_certificate_type_get.3 gnutls_certificate_type_get2.3 \ + gnutls_certificate_type_get_id.3 \ + gnutls_certificate_type_get_name.3 \ + gnutls_certificate_type_list.3 \ + gnutls_certificate_verification_profile_get_id.3 \ + gnutls_certificate_verification_profile_get_name.3 \ + gnutls_certificate_verification_status_print.3 \ + gnutls_certificate_verify_peers.3 \ + gnutls_certificate_verify_peers2.3 \ + gnutls_certificate_verify_peers3.3 gnutls_check_version.3 \ + gnutls_cipher_add_auth.3 gnutls_cipher_decrypt.3 \ + gnutls_cipher_decrypt2.3 gnutls_cipher_decrypt3.3 \ + gnutls_cipher_deinit.3 gnutls_cipher_encrypt.3 \ + gnutls_cipher_encrypt2.3 gnutls_cipher_encrypt3.3 \ + gnutls_cipher_get.3 gnutls_cipher_get_block_size.3 \ + gnutls_cipher_get_id.3 gnutls_cipher_get_iv_size.3 \ + gnutls_cipher_get_key_size.3 gnutls_cipher_get_name.3 \ + gnutls_cipher_get_tag_size.3 gnutls_cipher_init.3 \ + gnutls_cipher_list.3 gnutls_cipher_set_iv.3 \ + gnutls_ciphersuite_get.3 gnutls_cipher_suite_get_name.3 \ + gnutls_cipher_suite_info.3 gnutls_cipher_tag.3 \ + gnutls_compress_certificate_get_selected_method.3 \ + gnutls_compress_certificate_set_methods.3 \ + gnutls_compression_get.3 gnutls_compression_get_id.3 \ + gnutls_compression_get_name.3 gnutls_compression_list.3 \ + gnutls_credentials_clear.3 gnutls_credentials_get.3 \ + gnutls_credentials_set.3 gnutls_crypto_register_aead_cipher.3 \ + gnutls_crypto_register_cipher.3 \ + gnutls_crypto_register_digest.3 gnutls_crypto_register_mac.3 \ + gnutls_db_check_entry.3 gnutls_db_check_entry_expire_time.3 \ + gnutls_db_check_entry_time.3 \ + gnutls_db_get_default_cache_expiration.3 gnutls_db_get_ptr.3 \ + gnutls_db_remove_session.3 gnutls_db_set_cache_expiration.3 \ + gnutls_db_set_ptr.3 gnutls_db_set_remove_function.3 \ + gnutls_db_set_retrieve_function.3 \ + gnutls_db_set_store_function.3 gnutls_decode_ber_digest_info.3 \ + gnutls_decode_gost_rs_value.3 gnutls_decode_rs_value.3 \ + gnutls_deinit.3 gnutls_dh_get_group.3 \ + gnutls_dh_get_peers_public_bits.3 gnutls_dh_get_prime_bits.3 \ + gnutls_dh_get_pubkey.3 gnutls_dh_get_secret_bits.3 \ + gnutls_dh_params_cpy.3 gnutls_dh_params_deinit.3 \ + gnutls_dh_params_export2_pkcs3.3 \ + gnutls_dh_params_export_pkcs3.3 gnutls_dh_params_export_raw.3 \ + gnutls_dh_params_generate2.3 gnutls_dh_params_import_dsa.3 \ + gnutls_dh_params_import_pkcs3.3 gnutls_dh_params_import_raw.3 \ + gnutls_dh_params_import_raw2.3 gnutls_dh_params_import_raw3.3 \ + gnutls_dh_params_init.3 gnutls_dh_set_prime_bits.3 \ + gnutls_digest_get_id.3 gnutls_digest_get_name.3 \ + gnutls_digest_get_oid.3 gnutls_digest_list.3 \ + gnutls_digest_set_secure.3 gnutls_dtls_cookie_send.3 \ + gnutls_dtls_cookie_verify.3 gnutls_dtls_get_data_mtu.3 \ + gnutls_dtls_get_mtu.3 gnutls_dtls_get_timeout.3 \ + gnutls_dtls_prestate_set.3 gnutls_dtls_set_data_mtu.3 \ + gnutls_dtls_set_mtu.3 gnutls_dtls_set_timeouts.3 \ + gnutls_early_cipher_get.3 gnutls_early_prf_hash_get.3 \ + gnutls_ecc_curve_get.3 gnutls_ecc_curve_get_id.3 \ + gnutls_ecc_curve_get_name.3 gnutls_ecc_curve_get_oid.3 \ + gnutls_ecc_curve_get_pk.3 gnutls_ecc_curve_get_size.3 \ + gnutls_ecc_curve_list.3 gnutls_ecc_curve_set_enabled.3 \ + gnutls_encode_ber_digest_info.3 gnutls_encode_gost_rs_value.3 \ + gnutls_encode_rs_value.3 gnutls_error_is_fatal.3 \ + gnutls_error_to_alert.3 gnutls_est_record_overhead_size.3 \ + gnutls_ext_get_current_msg.3 gnutls_ext_get_data.3 \ + gnutls_ext_get_name.3 gnutls_ext_get_name2.3 \ + gnutls_ext_raw_parse.3 gnutls_ext_register.3 \ + gnutls_ext_set_data.3 gnutls_fingerprint.3 \ + gnutls_fips140_context_deinit.3 gnutls_fips140_context_init.3 \ + gnutls_fips140_get_operation_state.3 \ + gnutls_fips140_mode_enabled.3 gnutls_fips140_pop_context.3 \ + gnutls_fips140_push_context.3 gnutls_fips140_run_self_tests.3 \ + gnutls_fips140_set_mode.3 gnutls_get_library_config.3 \ + gnutls_get_system_config_file.3 gnutls_global_deinit.3 \ + gnutls_global_init.3 gnutls_global_set_audit_log_function.3 \ + gnutls_global_set_log_function.3 gnutls_global_set_log_level.3 \ + gnutls_global_set_mem_functions.3 gnutls_global_set_mutex.3 \ + gnutls_global_set_time_function.3 \ + gnutls_gost_paramset_get_name.3 gnutls_gost_paramset_get_oid.3 \ + gnutls_group_get.3 gnutls_group_get_id.3 \ + gnutls_group_get_name.3 gnutls_group_list.3 gnutls_handshake.3 \ + gnutls_handshake_description_get_name.3 \ + gnutls_handshake_get_last_in.3 gnutls_handshake_get_last_out.3 \ + gnutls_handshake_set_hook_function.3 \ + gnutls_handshake_set_max_packet_length.3 \ + gnutls_handshake_set_post_client_hello_function.3 \ + gnutls_handshake_set_private_extensions.3 \ + gnutls_handshake_set_random.3 \ + gnutls_handshake_set_read_function.3 \ + gnutls_handshake_set_secret_function.3 \ + gnutls_handshake_set_timeout.3 gnutls_handshake_write.3 \ + gnutls_hash.3 gnutls_hash_copy.3 gnutls_hash_deinit.3 \ + gnutls_hash_fast.3 gnutls_hash_get_len.3 gnutls_hash_init.3 \ + gnutls_hash_output.3 gnutls_heartbeat_allowed.3 \ + gnutls_heartbeat_enable.3 gnutls_heartbeat_get_timeout.3 \ + gnutls_heartbeat_ping.3 gnutls_heartbeat_pong.3 \ + gnutls_heartbeat_set_timeouts.3 gnutls_hex2bin.3 \ + gnutls_hex_decode.3 gnutls_hex_decode2.3 gnutls_hex_encode.3 \ + gnutls_hex_encode2.3 gnutls_hkdf_expand.3 \ + gnutls_hkdf_extract.3 gnutls_hmac.3 gnutls_hmac_copy.3 \ + gnutls_hmac_deinit.3 gnutls_hmac_fast.3 \ + gnutls_hmac_get_key_size.3 gnutls_hmac_get_len.3 \ + gnutls_hmac_init.3 gnutls_hmac_output.3 \ + gnutls_hmac_set_nonce.3 gnutls_idna_map.3 \ + gnutls_idna_reverse_map.3 gnutls_init.3 gnutls_key_generate.3 \ + gnutls_kx_get.3 gnutls_kx_get_id.3 gnutls_kx_get_name.3 \ + gnutls_kx_list.3 gnutls_load_file.3 gnutls_mac_get.3 \ + gnutls_mac_get_id.3 gnutls_mac_get_key_size.3 \ + gnutls_mac_get_name.3 gnutls_mac_get_nonce_size.3 \ + gnutls_mac_list.3 gnutls_memcmp.3 gnutls_memset.3 \ + gnutls_ocsp_req_add_cert.3 gnutls_ocsp_req_add_cert_id.3 \ + gnutls_ocsp_req_deinit.3 gnutls_ocsp_req_export.3 \ + gnutls_ocsp_req_get_cert_id.3 gnutls_ocsp_req_get_extension.3 \ + gnutls_ocsp_req_get_nonce.3 gnutls_ocsp_req_get_version.3 \ + gnutls_ocsp_req_import.3 gnutls_ocsp_req_init.3 \ + gnutls_ocsp_req_print.3 gnutls_ocsp_req_randomize_nonce.3 \ + gnutls_ocsp_req_set_extension.3 gnutls_ocsp_req_set_nonce.3 \ + gnutls_ocsp_resp_check_crt.3 gnutls_ocsp_resp_deinit.3 \ + gnutls_ocsp_resp_export.3 gnutls_ocsp_resp_export2.3 \ + gnutls_ocsp_resp_get_certs.3 gnutls_ocsp_resp_get_extension.3 \ + gnutls_ocsp_resp_get_nonce.3 gnutls_ocsp_resp_get_produced.3 \ + gnutls_ocsp_resp_get_responder.3 \ + gnutls_ocsp_resp_get_responder2.3 \ + gnutls_ocsp_resp_get_responder_raw_id.3 \ + gnutls_ocsp_resp_get_response.3 \ + gnutls_ocsp_resp_get_signature.3 \ + gnutls_ocsp_resp_get_signature_algorithm.3 \ + gnutls_ocsp_resp_get_single.3 gnutls_ocsp_resp_get_status.3 \ + gnutls_ocsp_resp_get_version.3 gnutls_ocsp_resp_import.3 \ + gnutls_ocsp_resp_import2.3 gnutls_ocsp_resp_init.3 \ + gnutls_ocsp_resp_list_import2.3 gnutls_ocsp_resp_print.3 \ + gnutls_ocsp_resp_verify.3 gnutls_ocsp_resp_verify_direct.3 \ + gnutls_ocsp_status_request_enable_client.3 \ + gnutls_ocsp_status_request_get.3 \ + gnutls_ocsp_status_request_get2.3 \ + gnutls_ocsp_status_request_is_checked.3 gnutls_oid_to_digest.3 \ + gnutls_oid_to_ecc_curve.3 gnutls_oid_to_gost_paramset.3 \ + gnutls_oid_to_mac.3 gnutls_oid_to_pk.3 gnutls_oid_to_sign.3 \ + gnutls_openpgp_privkey_sign_hash.3 gnutls_openpgp_send_cert.3 \ + gnutls_packet_deinit.3 gnutls_packet_get.3 gnutls_pbkdf2.3 \ + gnutls_pcert_deinit.3 gnutls_pcert_export_openpgp.3 \ + gnutls_pcert_export_x509.3 gnutls_pcert_import_openpgp.3 \ + gnutls_pcert_import_openpgp_raw.3 gnutls_pcert_import_rawpk.3 \ + gnutls_pcert_import_rawpk_raw.3 gnutls_pcert_import_x509.3 \ + gnutls_pcert_import_x509_list.3 gnutls_pcert_import_x509_raw.3 \ + gnutls_pcert_list_import_x509_file.3 \ + gnutls_pcert_list_import_x509_raw.3 gnutls_pem_base64_decode.3 \ + gnutls_pem_base64_decode2.3 gnutls_pem_base64_encode.3 \ + gnutls_pem_base64_encode2.3 gnutls_perror.3 \ + gnutls_pk_algorithm_get_name.3 gnutls_pk_bits_to_sec_param.3 \ + gnutls_pkcs11_add_provider.3 \ + gnutls_pkcs11_copy_attached_extension.3 \ + gnutls_pkcs11_copy_pubkey.3 gnutls_pkcs11_copy_secret_key.3 \ + gnutls_pkcs11_copy_x509_crt.3 gnutls_pkcs11_copy_x509_crt2.3 \ + gnutls_pkcs11_copy_x509_privkey.3 \ + gnutls_pkcs11_copy_x509_privkey2.3 \ + gnutls_pkcs11_crt_is_known.3 gnutls_pkcs11_deinit.3 \ + gnutls_pkcs11_delete_url.3 gnutls_pkcs11_get_pin_function.3 \ + gnutls_pkcs11_get_raw_issuer.3 \ + gnutls_pkcs11_get_raw_issuer_by_dn.3 \ + gnutls_pkcs11_get_raw_issuer_by_subject_key_id.3 \ + gnutls_pkcs11_init.3 gnutls_pkcs11_obj_deinit.3 \ + gnutls_pkcs11_obj_export.3 gnutls_pkcs11_obj_export2.3 \ + gnutls_pkcs11_obj_export3.3 gnutls_pkcs11_obj_export_url.3 \ + gnutls_pkcs11_obj_flags_get_str.3 gnutls_pkcs11_obj_get_exts.3 \ + gnutls_pkcs11_obj_get_flags.3 gnutls_pkcs11_obj_get_info.3 \ + gnutls_pkcs11_obj_get_ptr.3 gnutls_pkcs11_obj_get_type.3 \ + gnutls_pkcs11_obj_import_url.3 gnutls_pkcs11_obj_init.3 \ + gnutls_pkcs11_obj_list_import_url3.3 \ + gnutls_pkcs11_obj_list_import_url4.3 \ + gnutls_pkcs11_obj_set_info.3 \ + gnutls_pkcs11_obj_set_pin_function.3 \ + gnutls_pkcs11_privkey_cpy.3 gnutls_pkcs11_privkey_deinit.3 \ + gnutls_pkcs11_privkey_export_pubkey.3 \ + gnutls_pkcs11_privkey_export_url.3 \ + gnutls_pkcs11_privkey_generate.3 \ + gnutls_pkcs11_privkey_generate2.3 \ + gnutls_pkcs11_privkey_generate3.3 \ + gnutls_pkcs11_privkey_get_info.3 \ + gnutls_pkcs11_privkey_get_pk_algorithm.3 \ + gnutls_pkcs11_privkey_import_url.3 \ + gnutls_pkcs11_privkey_init.3 \ + gnutls_pkcs11_privkey_set_pin_function.3 \ + gnutls_pkcs11_privkey_status.3 gnutls_pkcs11_reinit.3 \ + gnutls_pkcs11_set_pin_function.3 \ + gnutls_pkcs11_set_token_function.3 \ + gnutls_pkcs11_token_check_mechanism.3 \ + gnutls_pkcs11_token_get_flags.3 gnutls_pkcs11_token_get_info.3 \ + gnutls_pkcs11_token_get_mechanism.3 \ + gnutls_pkcs11_token_get_ptr.3 gnutls_pkcs11_token_get_random.3 \ + gnutls_pkcs11_token_get_url.3 gnutls_pkcs11_token_init.3 \ + gnutls_pkcs11_token_set_pin.3 gnutls_pkcs11_type_get_name.3 \ + gnutls_pkcs12_bag_decrypt.3 gnutls_pkcs12_bag_deinit.3 \ + gnutls_pkcs12_bag_enc_info.3 gnutls_pkcs12_bag_encrypt.3 \ + gnutls_pkcs12_bag_get_count.3 gnutls_pkcs12_bag_get_data.3 \ + gnutls_pkcs12_bag_get_friendly_name.3 \ + gnutls_pkcs12_bag_get_key_id.3 gnutls_pkcs12_bag_get_type.3 \ + gnutls_pkcs12_bag_init.3 gnutls_pkcs12_bag_set_crl.3 \ + gnutls_pkcs12_bag_set_crt.3 gnutls_pkcs12_bag_set_data.3 \ + gnutls_pkcs12_bag_set_friendly_name.3 \ + gnutls_pkcs12_bag_set_key_id.3 gnutls_pkcs12_bag_set_privkey.3 \ + gnutls_pkcs12_deinit.3 gnutls_pkcs12_export.3 \ + gnutls_pkcs12_export2.3 gnutls_pkcs12_generate_mac.3 \ + gnutls_pkcs12_generate_mac2.3 gnutls_pkcs12_get_bag.3 \ + gnutls_pkcs12_import.3 gnutls_pkcs12_init.3 \ + gnutls_pkcs12_mac_info.3 gnutls_pkcs12_set_bag.3 \ + gnutls_pkcs12_simple_parse.3 gnutls_pkcs12_verify_mac.3 \ + gnutls_pkcs7_add_attr.3 gnutls_pkcs7_attrs_deinit.3 \ + gnutls_pkcs7_deinit.3 gnutls_pkcs7_delete_crl.3 \ + gnutls_pkcs7_delete_crt.3 gnutls_pkcs7_export.3 \ + gnutls_pkcs7_export2.3 gnutls_pkcs7_get_attr.3 \ + gnutls_pkcs7_get_crl_count.3 gnutls_pkcs7_get_crl_raw.3 \ + gnutls_pkcs7_get_crl_raw2.3 gnutls_pkcs7_get_crt_count.3 \ + gnutls_pkcs7_get_crt_raw.3 gnutls_pkcs7_get_crt_raw2.3 \ + gnutls_pkcs7_get_embedded_data.3 \ + gnutls_pkcs7_get_embedded_data_oid.3 \ + gnutls_pkcs7_get_signature_count.3 \ + gnutls_pkcs7_get_signature_info.3 gnutls_pkcs7_import.3 \ + gnutls_pkcs7_init.3 gnutls_pkcs7_print.3 \ + gnutls_pkcs7_print_signature_info.3 gnutls_pkcs7_set_crl.3 \ + gnutls_pkcs7_set_crl_raw.3 gnutls_pkcs7_set_crt.3 \ + gnutls_pkcs7_set_crt_raw.3 gnutls_pkcs7_sign.3 \ + gnutls_pkcs7_signature_info_deinit.3 gnutls_pkcs7_verify.3 \ + gnutls_pkcs7_verify_direct.3 gnutls_pkcs8_info.3 \ + gnutls_pkcs_schema_get_name.3 gnutls_pkcs_schema_get_oid.3 \ + gnutls_pk_get_id.3 gnutls_pk_get_name.3 gnutls_pk_get_oid.3 \ + gnutls_pk_list.3 gnutls_pk_to_sign.3 gnutls_prf.3 \ + gnutls_prf_early.3 gnutls_prf_hash_get.3 gnutls_prf_raw.3 \ + gnutls_prf_rfc5705.3 gnutls_priority_certificate_type_list.3 \ + gnutls_priority_certificate_type_list2.3 \ + gnutls_priority_cipher_list.3 \ + gnutls_priority_compression_list.3 gnutls_priority_deinit.3 \ + gnutls_priority_ecc_curve_list.3 \ + gnutls_priority_get_cipher_suite_index.3 \ + gnutls_priority_group_list.3 gnutls_priority_init.3 \ + gnutls_priority_init2.3 gnutls_priority_kx_list.3 \ + gnutls_priority_mac_list.3 gnutls_priority_protocol_list.3 \ + gnutls_priority_set.3 gnutls_priority_set_direct.3 \ + gnutls_priority_sign_list.3 gnutls_priority_string_list.3 \ + gnutls_privkey_decrypt_data.3 gnutls_privkey_decrypt_data2.3 \ + gnutls_privkey_deinit.3 gnutls_privkey_export_dsa_raw.3 \ + gnutls_privkey_export_dsa_raw2.3 \ + gnutls_privkey_export_ecc_raw.3 \ + gnutls_privkey_export_ecc_raw2.3 \ + gnutls_privkey_export_gost_raw2.3 \ + gnutls_privkey_export_openpgp.3 gnutls_privkey_export_pkcs11.3 \ + gnutls_privkey_export_rsa_raw.3 \ + gnutls_privkey_export_rsa_raw2.3 gnutls_privkey_export_x509.3 \ + gnutls_privkey_generate.3 gnutls_privkey_generate2.3 \ + gnutls_privkey_get_pk_algorithm.3 gnutls_privkey_get_seed.3 \ + gnutls_privkey_get_spki.3 gnutls_privkey_get_type.3 \ + gnutls_privkey_import_dsa_raw.3 \ + gnutls_privkey_import_ecc_raw.3 gnutls_privkey_import_ext.3 \ + gnutls_privkey_import_ext2.3 gnutls_privkey_import_ext3.3 \ + gnutls_privkey_import_ext4.3 gnutls_privkey_import_gost_raw.3 \ + gnutls_privkey_import_openpgp.3 \ + gnutls_privkey_import_openpgp_raw.3 \ + gnutls_privkey_import_pkcs11.3 \ + gnutls_privkey_import_pkcs11_url.3 \ + gnutls_privkey_import_rsa_raw.3 \ + gnutls_privkey_import_tpm_raw.3 \ + gnutls_privkey_import_tpm_url.3 gnutls_privkey_import_url.3 \ + gnutls_privkey_import_x509.3 gnutls_privkey_import_x509_raw.3 \ + gnutls_privkey_init.3 gnutls_privkey_set_flags.3 \ + gnutls_privkey_set_pin_function.3 gnutls_privkey_set_spki.3 \ + gnutls_privkey_sign_data.3 gnutls_privkey_sign_data2.3 \ + gnutls_privkey_sign_hash.3 gnutls_privkey_sign_hash2.3 \ + gnutls_privkey_status.3 gnutls_privkey_verify_params.3 \ + gnutls_privkey_verify_seed.3 gnutls_protocol_get_id.3 \ + gnutls_protocol_get_name.3 gnutls_protocol_get_version.3 \ + gnutls_protocol_list.3 gnutls_protocol_set_enabled.3 \ + gnutls_psk_allocate_client_credentials.3 \ + gnutls_psk_allocate_server_credentials.3 \ + gnutls_psk_client_get_hint.3 \ + gnutls_psk_free_client_credentials.3 \ + gnutls_psk_free_server_credentials.3 \ + gnutls_psk_server_get_username.3 \ + gnutls_psk_server_get_username2.3 \ + gnutls_psk_set_client_credentials.3 \ + gnutls_psk_set_client_credentials2.3 \ + gnutls_psk_set_client_credentials_function.3 \ + gnutls_psk_set_client_credentials_function2.3 \ + gnutls_psk_set_params_function.3 \ + gnutls_psk_set_server_credentials_file.3 \ + gnutls_psk_set_server_credentials_function.3 \ + gnutls_psk_set_server_credentials_function2.3 \ + gnutls_psk_set_server_credentials_hint.3 \ + gnutls_psk_set_server_dh_params.3 \ + gnutls_psk_set_server_known_dh_params.3 \ + gnutls_psk_set_server_params_function.3 gnutls_pubkey_deinit.3 \ + gnutls_pubkey_encrypt_data.3 gnutls_pubkey_export.3 \ + gnutls_pubkey_export2.3 gnutls_pubkey_export_dsa_raw.3 \ + gnutls_pubkey_export_dsa_raw2.3 gnutls_pubkey_export_ecc_raw.3 \ + gnutls_pubkey_export_ecc_raw2.3 \ + gnutls_pubkey_export_ecc_x962.3 \ + gnutls_pubkey_export_gost_raw2.3 \ + gnutls_pubkey_export_rsa_raw.3 gnutls_pubkey_export_rsa_raw2.3 \ + gnutls_pubkey_get_key_id.3 gnutls_pubkey_get_key_usage.3 \ + gnutls_pubkey_get_openpgp_key_id.3 \ + gnutls_pubkey_get_pk_algorithm.3 \ + gnutls_pubkey_get_preferred_hash_algorithm.3 \ + gnutls_pubkey_get_spki.3 gnutls_pubkey_import.3 \ + gnutls_pubkey_import_dsa_raw.3 gnutls_pubkey_import_ecc_raw.3 \ + gnutls_pubkey_import_ecc_x962.3 \ + gnutls_pubkey_import_gost_raw.3 gnutls_pubkey_import_openpgp.3 \ + gnutls_pubkey_import_openpgp_raw.3 \ + gnutls_pubkey_import_pkcs11.3 gnutls_pubkey_import_privkey.3 \ + gnutls_pubkey_import_rsa_raw.3 gnutls_pubkey_import_tpm_raw.3 \ + gnutls_pubkey_import_tpm_url.3 gnutls_pubkey_import_url.3 \ + gnutls_pubkey_import_x509.3 gnutls_pubkey_import_x509_crq.3 \ + gnutls_pubkey_import_x509_raw.3 gnutls_pubkey_init.3 \ + gnutls_pubkey_print.3 gnutls_pubkey_set_key_usage.3 \ + gnutls_pubkey_set_pin_function.3 gnutls_pubkey_set_spki.3 \ + gnutls_pubkey_verify_data2.3 gnutls_pubkey_verify_hash2.3 \ + gnutls_pubkey_verify_params.3 gnutls_random_art.3 \ + gnutls_range_split.3 gnutls_reauth.3 \ + gnutls_record_can_use_length_hiding.3 \ + gnutls_record_check_corked.3 gnutls_record_check_pending.3 \ + gnutls_record_cork.3 gnutls_record_disable_padding.3 \ + gnutls_record_discard_queued.3 gnutls_record_get_direction.3 \ + gnutls_record_get_discarded.3 \ + gnutls_record_get_max_early_data_size.3 \ + gnutls_record_get_max_size.3 gnutls_record_get_state.3 \ + gnutls_record_overhead_size.3 gnutls_record_recv.3 \ + gnutls_record_recv_early_data.3 gnutls_record_recv_packet.3 \ + gnutls_record_recv_seq.3 gnutls_record_send.3 \ + gnutls_record_send2.3 gnutls_record_send_early_data.3 \ + gnutls_record_send_file.3 gnutls_record_send_range.3 \ + gnutls_record_set_max_early_data_size.3 \ + gnutls_record_set_max_recv_size.3 gnutls_record_set_max_size.3 \ + gnutls_record_set_state.3 gnutls_record_set_timeout.3 \ + gnutls_record_uncork.3 gnutls_register_custom_url.3 \ + gnutls_rehandshake.3 gnutls_rnd.3 gnutls_rnd_refresh.3 \ + gnutls_safe_renegotiation_status.3 gnutls_sec_param_get_name.3 \ + gnutls_sec_param_to_pk_bits.3 \ + gnutls_sec_param_to_symmetric_bits.3 gnutls_server_name_get.3 \ + gnutls_server_name_set.3 gnutls_session_channel_binding.3 \ + gnutls_session_enable_compatibility_mode.3 \ + gnutls_session_etm_status.3 \ + gnutls_session_ext_master_secret_status.3 \ + gnutls_session_ext_register.3 gnutls_session_force_valid.3 \ + gnutls_session_get_data.3 gnutls_session_get_data2.3 \ + gnutls_session_get_desc.3 gnutls_session_get_flags.3 \ + gnutls_session_get_id.3 gnutls_session_get_id2.3 \ + gnutls_session_get_keylog_function.3 \ + gnutls_session_get_master_secret.3 gnutls_session_get_ptr.3 \ + gnutls_session_get_random.3 \ + gnutls_session_get_verify_cert_status.3 \ + gnutls_session_is_resumed.3 gnutls_session_key_update.3 \ + gnutls_session_resumption_requested.3 \ + gnutls_session_set_data.3 gnutls_session_set_id.3 \ + gnutls_session_set_keylog_function.3 \ + gnutls_session_set_premaster.3 gnutls_session_set_ptr.3 \ + gnutls_session_set_verify_cert.3 \ + gnutls_session_set_verify_cert2.3 \ + gnutls_session_set_verify_function.3 \ + gnutls_session_set_verify_output_function.3 \ + gnutls_session_supplemental_register.3 \ + gnutls_session_ticket_enable_client.3 \ + gnutls_session_ticket_enable_server.3 \ + gnutls_session_ticket_key_generate.3 \ + gnutls_session_ticket_send.3 gnutls_set_default_priority.3 \ + gnutls_set_default_priority_append.3 \ + gnutls_sign_algorithm_get.3 gnutls_sign_algorithm_get_client.3 \ + gnutls_sign_algorithm_get_requested.3 \ + gnutls_sign_get_hash_algorithm.3 gnutls_sign_get_id.3 \ + gnutls_sign_get_name.3 gnutls_sign_get_oid.3 \ + gnutls_sign_get_pk_algorithm.3 gnutls_sign_is_secure.3 \ + gnutls_sign_is_secure2.3 gnutls_sign_list.3 \ + gnutls_sign_set_secure.3 gnutls_sign_set_secure_for_certs.3 \ + gnutls_sign_supports_pk_algorithm.3 \ + gnutls_srp_allocate_client_credentials.3 \ + gnutls_srp_allocate_server_credentials.3 \ + gnutls_srp_base64_decode.3 gnutls_srp_base64_decode2.3 \ + gnutls_srp_base64_encode.3 gnutls_srp_base64_encode2.3 \ + gnutls_srp_free_client_credentials.3 \ + gnutls_srp_free_server_credentials.3 \ + gnutls_srp_server_get_username.3 \ + gnutls_srp_set_client_credentials.3 \ + gnutls_srp_set_client_credentials_function.3 \ + gnutls_srp_set_prime_bits.3 \ + gnutls_srp_set_server_credentials_file.3 \ + gnutls_srp_set_server_credentials_function.3 \ + gnutls_srp_set_server_fake_salt_seed.3 gnutls_srp_verifier.3 \ + gnutls_srtp_get_keys.3 gnutls_srtp_get_mki.3 \ + gnutls_srtp_get_profile_id.3 gnutls_srtp_get_profile_name.3 \ + gnutls_srtp_get_selected_profile.3 gnutls_srtp_set_mki.3 \ + gnutls_srtp_set_profile.3 gnutls_srtp_set_profile_direct.3 \ + gnutls_store_commitment.3 gnutls_store_pubkey.3 \ + gnutls_strerror.3 gnutls_strerror_name.3 \ + gnutls_subject_alt_names_deinit.3 \ + gnutls_subject_alt_names_get.3 gnutls_subject_alt_names_init.3 \ + gnutls_subject_alt_names_set.3 gnutls_supplemental_get_name.3 \ + gnutls_supplemental_recv.3 gnutls_supplemental_register.3 \ + gnutls_supplemental_send.3 gnutls_system_key_add_x509.3 \ + gnutls_system_key_delete.3 gnutls_system_key_iter_deinit.3 \ + gnutls_system_key_iter_get_info.3 gnutls_system_recv_timeout.3 \ + gnutls_tdb_deinit.3 gnutls_tdb_init.3 \ + gnutls_tdb_set_store_commitment_func.3 \ + gnutls_tdb_set_store_func.3 gnutls_tdb_set_verify_func.3 \ + gnutls_tpm_get_registered.3 gnutls_tpm_key_list_deinit.3 \ + gnutls_tpm_key_list_get_url.3 gnutls_tpm_privkey_delete.3 \ + gnutls_tpm_privkey_generate.3 gnutls_transport_get_int.3 \ + gnutls_transport_get_int2.3 gnutls_transport_get_ptr.3 \ + gnutls_transport_get_ptr2.3 gnutls_transport_is_ktls_enabled.3 \ + gnutls_transport_set_errno.3 \ + gnutls_transport_set_errno_function.3 \ + gnutls_transport_set_fastopen.3 gnutls_transport_set_int.3 \ + gnutls_transport_set_int2.3 gnutls_transport_set_ptr.3 \ + gnutls_transport_set_ptr2.3 \ + gnutls_transport_set_pull_function.3 \ + gnutls_transport_set_pull_timeout_function.3 \ + gnutls_transport_set_push_function.3 \ + gnutls_transport_set_vec_push_function.3 \ + gnutls_url_is_supported.3 gnutls_utf8_password_normalize.3 \ + gnutls_verify_stored_pubkey.3 gnutls_x509_aia_deinit.3 \ + gnutls_x509_aia_get.3 gnutls_x509_aia_init.3 \ + gnutls_x509_aia_set.3 gnutls_x509_aki_deinit.3 \ + gnutls_x509_aki_get_cert_issuer.3 gnutls_x509_aki_get_id.3 \ + gnutls_x509_aki_init.3 gnutls_x509_aki_set_cert_issuer.3 \ + gnutls_x509_aki_set_id.3 gnutls_x509_cidr_to_rfc5280.3 \ + gnutls_x509_crl_check_issuer.3 gnutls_x509_crl_deinit.3 \ + gnutls_x509_crl_dist_points_deinit.3 \ + gnutls_x509_crl_dist_points_get.3 \ + gnutls_x509_crl_dist_points_init.3 \ + gnutls_x509_crl_dist_points_set.3 gnutls_x509_crl_export.3 \ + gnutls_x509_crl_export2.3 \ + gnutls_x509_crl_get_authority_key_gn_serial.3 \ + gnutls_x509_crl_get_authority_key_id.3 \ + gnutls_x509_crl_get_crt_count.3 \ + gnutls_x509_crl_get_crt_serial.3 gnutls_x509_crl_get_dn_oid.3 \ + gnutls_x509_crl_get_extension_data.3 \ + gnutls_x509_crl_get_extension_data2.3 \ + gnutls_x509_crl_get_extension_info.3 \ + gnutls_x509_crl_get_extension_oid.3 \ + gnutls_x509_crl_get_issuer_dn.3 \ + gnutls_x509_crl_get_issuer_dn2.3 \ + gnutls_x509_crl_get_issuer_dn3.3 \ + gnutls_x509_crl_get_issuer_dn_by_oid.3 \ + gnutls_x509_crl_get_next_update.3 gnutls_x509_crl_get_number.3 \ + gnutls_x509_crl_get_raw_issuer_dn.3 \ + gnutls_x509_crl_get_signature.3 \ + gnutls_x509_crl_get_signature_algorithm.3 \ + gnutls_x509_crl_get_signature_oid.3 \ + gnutls_x509_crl_get_this_update.3 \ + gnutls_x509_crl_get_version.3 gnutls_x509_crl_import.3 \ + gnutls_x509_crl_init.3 gnutls_x509_crl_iter_crt_serial.3 \ + gnutls_x509_crl_iter_deinit.3 gnutls_x509_crl_list_import.3 \ + gnutls_x509_crl_list_import2.3 gnutls_x509_crl_print.3 \ + gnutls_x509_crl_privkey_sign.3 \ + gnutls_x509_crl_set_authority_key_id.3 \ + gnutls_x509_crl_set_crt.3 gnutls_x509_crl_set_crt_serial.3 \ + gnutls_x509_crl_set_next_update.3 gnutls_x509_crl_set_number.3 \ + gnutls_x509_crl_set_this_update.3 \ + gnutls_x509_crl_set_version.3 gnutls_x509_crl_sign.3 \ + gnutls_x509_crl_sign2.3 gnutls_x509_crl_verify.3 \ + gnutls_x509_crq_deinit.3 gnutls_x509_crq_export.3 \ + gnutls_x509_crq_export2.3 \ + gnutls_x509_crq_get_attribute_by_oid.3 \ + gnutls_x509_crq_get_attribute_data.3 \ + gnutls_x509_crq_get_attribute_info.3 \ + gnutls_x509_crq_get_basic_constraints.3 \ + gnutls_x509_crq_get_challenge_password.3 \ + gnutls_x509_crq_get_dn.3 gnutls_x509_crq_get_dn2.3 \ + gnutls_x509_crq_get_dn3.3 gnutls_x509_crq_get_dn_by_oid.3 \ + gnutls_x509_crq_get_dn_oid.3 \ + gnutls_x509_crq_get_extension_by_oid.3 \ + gnutls_x509_crq_get_extension_by_oid2.3 \ + gnutls_x509_crq_get_extension_data.3 \ + gnutls_x509_crq_get_extension_data2.3 \ + gnutls_x509_crq_get_extension_info.3 \ + gnutls_x509_crq_get_key_id.3 \ + gnutls_x509_crq_get_key_purpose_oid.3 \ + gnutls_x509_crq_get_key_rsa_raw.3 \ + gnutls_x509_crq_get_key_usage.3 \ + gnutls_x509_crq_get_pk_algorithm.3 \ + gnutls_x509_crq_get_pk_oid.3 \ + gnutls_x509_crq_get_private_key_usage_period.3 \ + gnutls_x509_crq_get_signature_algorithm.3 \ + gnutls_x509_crq_get_signature_oid.3 gnutls_x509_crq_get_spki.3 \ + gnutls_x509_crq_get_subject_alt_name.3 \ + gnutls_x509_crq_get_subject_alt_othername_oid.3 \ + gnutls_x509_crq_get_tlsfeatures.3 \ + gnutls_x509_crq_get_version.3 gnutls_x509_crq_import.3 \ + gnutls_x509_crq_init.3 gnutls_x509_crq_print.3 \ + gnutls_x509_crq_privkey_sign.3 \ + gnutls_x509_crq_set_attribute_by_oid.3 \ + gnutls_x509_crq_set_basic_constraints.3 \ + gnutls_x509_crq_set_challenge_password.3 \ + gnutls_x509_crq_set_dn.3 gnutls_x509_crq_set_dn_by_oid.3 \ + gnutls_x509_crq_set_extension_by_oid.3 \ + gnutls_x509_crq_set_key.3 \ + gnutls_x509_crq_set_key_purpose_oid.3 \ + gnutls_x509_crq_set_key_rsa_raw.3 \ + gnutls_x509_crq_set_key_usage.3 \ + gnutls_x509_crq_set_private_key_usage_period.3 \ + gnutls_x509_crq_set_pubkey.3 gnutls_x509_crq_set_spki.3 \ + gnutls_x509_crq_set_subject_alt_name.3 \ + gnutls_x509_crq_set_subject_alt_othername.3 \ + gnutls_x509_crq_set_tlsfeatures.3 \ + gnutls_x509_crq_set_version.3 gnutls_x509_crq_sign.3 \ + gnutls_x509_crq_sign2.3 gnutls_x509_crq_verify.3 \ + gnutls_x509_crt_check_email.3 gnutls_x509_crt_check_hostname.3 \ + gnutls_x509_crt_check_hostname2.3 gnutls_x509_crt_check_ip.3 \ + gnutls_x509_crt_check_issuer.3 \ + gnutls_x509_crt_check_key_purpose.3 \ + gnutls_x509_crt_check_revocation.3 \ + gnutls_x509_crt_cpy_crl_dist_points.3 gnutls_x509_crt_deinit.3 \ + gnutls_x509_crt_equals.3 gnutls_x509_crt_equals2.3 \ + gnutls_x509_crt_export.3 gnutls_x509_crt_export2.3 \ + gnutls_x509_crt_get_activation_time.3 \ + gnutls_x509_crt_get_authority_info_access.3 \ + gnutls_x509_crt_get_authority_key_gn_serial.3 \ + gnutls_x509_crt_get_authority_key_id.3 \ + gnutls_x509_crt_get_basic_constraints.3 \ + gnutls_x509_crt_get_ca_status.3 \ + gnutls_x509_crt_get_crl_dist_points.3 gnutls_x509_crt_get_dn.3 \ + gnutls_x509_crt_get_dn2.3 gnutls_x509_crt_get_dn3.3 \ + gnutls_x509_crt_get_dn_by_oid.3 gnutls_x509_crt_get_dn_oid.3 \ + gnutls_x509_crt_get_expiration_time.3 \ + gnutls_x509_crt_get_extension_by_oid.3 \ + gnutls_x509_crt_get_extension_by_oid2.3 \ + gnutls_x509_crt_get_extension_data.3 \ + gnutls_x509_crt_get_extension_data2.3 \ + gnutls_x509_crt_get_extension_info.3 \ + gnutls_x509_crt_get_extension_oid.3 \ + gnutls_x509_crt_get_fingerprint.3 \ + gnutls_x509_crt_get_inhibit_anypolicy.3 \ + gnutls_x509_crt_get_issuer.3 \ + gnutls_x509_crt_get_issuer_alt_name.3 \ + gnutls_x509_crt_get_issuer_alt_name2.3 \ + gnutls_x509_crt_get_issuer_alt_othername_oid.3 \ + gnutls_x509_crt_get_issuer_dn.3 \ + gnutls_x509_crt_get_issuer_dn2.3 \ + gnutls_x509_crt_get_issuer_dn3.3 \ + gnutls_x509_crt_get_issuer_dn_by_oid.3 \ + gnutls_x509_crt_get_issuer_dn_oid.3 \ + gnutls_x509_crt_get_issuer_unique_id.3 \ + gnutls_x509_crt_get_key_id.3 \ + gnutls_x509_crt_get_key_purpose_oid.3 \ + gnutls_x509_crt_get_key_usage.3 \ + gnutls_x509_crt_get_name_constraints.3 \ + gnutls_x509_crt_get_pk_algorithm.3 \ + gnutls_x509_crt_get_pk_dsa_raw.3 \ + gnutls_x509_crt_get_pk_ecc_raw.3 \ + gnutls_x509_crt_get_pk_gost_raw.3 gnutls_x509_crt_get_pk_oid.3 \ + gnutls_x509_crt_get_pk_rsa_raw.3 gnutls_x509_crt_get_policy.3 \ + gnutls_x509_crt_get_preferred_hash_algorithm.3 \ + gnutls_x509_crt_get_private_key_usage_period.3 \ + gnutls_x509_crt_get_proxy.3 gnutls_x509_crt_get_raw_dn.3 \ + gnutls_x509_crt_get_raw_issuer_dn.3 \ + gnutls_x509_crt_get_serial.3 gnutls_x509_crt_get_signature.3 \ + gnutls_x509_crt_get_signature_algorithm.3 \ + gnutls_x509_crt_get_signature_oid.3 gnutls_x509_crt_get_spki.3 \ + gnutls_x509_crt_get_subject.3 \ + gnutls_x509_crt_get_subject_alt_name.3 \ + gnutls_x509_crt_get_subject_alt_name2.3 \ + gnutls_x509_crt_get_subject_alt_othername_oid.3 \ + gnutls_x509_crt_get_subject_key_id.3 \ + gnutls_x509_crt_get_subject_unique_id.3 \ + gnutls_x509_crt_get_tlsfeatures.3 \ + gnutls_x509_crt_get_version.3 gnutls_x509_crt_import.3 \ + gnutls_x509_crt_import_pkcs11.3 gnutls_x509_crt_import_url.3 \ + gnutls_x509_crt_init.3 gnutls_x509_crt_list_import.3 \ + gnutls_x509_crt_list_import2.3 \ + gnutls_x509_crt_list_import_pkcs11.3 \ + gnutls_x509_crt_list_import_url.3 \ + gnutls_x509_crt_list_verify.3 gnutls_x509_crt_print.3 \ + gnutls_x509_crt_privkey_sign.3 \ + gnutls_x509_crt_set_activation_time.3 \ + gnutls_x509_crt_set_authority_info_access.3 \ + gnutls_x509_crt_set_authority_key_id.3 \ + gnutls_x509_crt_set_basic_constraints.3 \ + gnutls_x509_crt_set_ca_status.3 \ + gnutls_x509_crt_set_crl_dist_points.3 \ + gnutls_x509_crt_set_crl_dist_points2.3 \ + gnutls_x509_crt_set_crq.3 \ + gnutls_x509_crt_set_crq_extension_by_oid.3 \ + gnutls_x509_crt_set_crq_extensions.3 gnutls_x509_crt_set_dn.3 \ + gnutls_x509_crt_set_dn_by_oid.3 \ + gnutls_x509_crt_set_expiration_time.3 \ + gnutls_x509_crt_set_extension_by_oid.3 \ + gnutls_x509_crt_set_flags.3 \ + gnutls_x509_crt_set_inhibit_anypolicy.3 \ + gnutls_x509_crt_set_issuer_alt_name.3 \ + gnutls_x509_crt_set_issuer_alt_othername.3 \ + gnutls_x509_crt_set_issuer_dn.3 \ + gnutls_x509_crt_set_issuer_dn_by_oid.3 \ + gnutls_x509_crt_set_issuer_unique_id.3 \ + gnutls_x509_crt_set_key.3 \ + gnutls_x509_crt_set_key_purpose_oid.3 \ + gnutls_x509_crt_set_key_usage.3 \ + gnutls_x509_crt_set_name_constraints.3 \ + gnutls_x509_crt_set_pin_function.3 \ + gnutls_x509_crt_set_policy.3 \ + gnutls_x509_crt_set_private_key_usage_period.3 \ + gnutls_x509_crt_set_proxy.3 gnutls_x509_crt_set_proxy_dn.3 \ + gnutls_x509_crt_set_pubkey.3 gnutls_x509_crt_set_serial.3 \ + gnutls_x509_crt_set_spki.3 \ + gnutls_x509_crt_set_subject_alternative_name.3 \ + gnutls_x509_crt_set_subject_alt_name.3 \ + gnutls_x509_crt_set_subject_alt_othername.3 \ + gnutls_x509_crt_set_subject_key_id.3 \ + gnutls_x509_crt_set_subject_unique_id.3 \ + gnutls_x509_crt_set_tlsfeatures.3 \ + gnutls_x509_crt_set_version.3 gnutls_x509_crt_sign.3 \ + gnutls_x509_crt_sign2.3 gnutls_x509_crt_verify.3 \ + gnutls_x509_crt_verify_data2.3 gnutls_x509_ct_sct_get.3 \ + gnutls_x509_ct_sct_get_version.3 gnutls_x509_dn_deinit.3 \ + gnutls_x509_dn_export.3 gnutls_x509_dn_export2.3 \ + gnutls_x509_dn_get_rdn_ava.3 gnutls_x509_dn_get_str.3 \ + gnutls_x509_dn_get_str2.3 gnutls_x509_dn_import.3 \ + gnutls_x509_dn_init.3 gnutls_x509_dn_oid_known.3 \ + gnutls_x509_dn_oid_name.3 gnutls_x509_dn_set_str.3 \ + gnutls_x509_ext_ct_export_scts.3 \ + gnutls_x509_ext_ct_import_scts.3 \ + gnutls_x509_ext_ct_scts_deinit.3 \ + gnutls_x509_ext_ct_scts_init.3 gnutls_x509_ext_deinit.3 \ + gnutls_x509_ext_export_aia.3 \ + gnutls_x509_ext_export_authority_key_id.3 \ + gnutls_x509_ext_export_basic_constraints.3 \ + gnutls_x509_ext_export_crl_dist_points.3 \ + gnutls_x509_ext_export_inhibit_anypolicy.3 \ + gnutls_x509_ext_export_key_purposes.3 \ + gnutls_x509_ext_export_key_usage.3 \ + gnutls_x509_ext_export_name_constraints.3 \ + gnutls_x509_ext_export_policies.3 \ + gnutls_x509_ext_export_private_key_usage_period.3 \ + gnutls_x509_ext_export_proxy.3 \ + gnutls_x509_ext_export_subject_alt_names.3 \ + gnutls_x509_ext_export_subject_key_id.3 \ + gnutls_x509_ext_export_tlsfeatures.3 \ + gnutls_x509_ext_import_aia.3 \ + gnutls_x509_ext_import_authority_key_id.3 \ + gnutls_x509_ext_import_basic_constraints.3 \ + gnutls_x509_ext_import_crl_dist_points.3 \ + gnutls_x509_ext_import_inhibit_anypolicy.3 \ + gnutls_x509_ext_import_key_purposes.3 \ + gnutls_x509_ext_import_key_usage.3 \ + gnutls_x509_ext_import_name_constraints.3 \ + gnutls_x509_ext_import_policies.3 \ + gnutls_x509_ext_import_private_key_usage_period.3 \ + gnutls_x509_ext_import_proxy.3 \ + gnutls_x509_ext_import_subject_alt_names.3 \ + gnutls_x509_ext_import_subject_key_id.3 \ + gnutls_x509_ext_import_tlsfeatures.3 gnutls_x509_ext_print.3 \ + gnutls_x509_key_purpose_deinit.3 gnutls_x509_key_purpose_get.3 \ + gnutls_x509_key_purpose_init.3 gnutls_x509_key_purpose_set.3 \ + gnutls_x509_name_constraints_add_excluded.3 \ + gnutls_x509_name_constraints_add_permitted.3 \ + gnutls_x509_name_constraints_check.3 \ + gnutls_x509_name_constraints_check_crt.3 \ + gnutls_x509_name_constraints_deinit.3 \ + gnutls_x509_name_constraints_get_excluded.3 \ + gnutls_x509_name_constraints_get_permitted.3 \ + gnutls_x509_name_constraints_init.3 \ + gnutls_x509_othername_to_virtual.3 \ + gnutls_x509_policies_deinit.3 gnutls_x509_policies_get.3 \ + gnutls_x509_policies_init.3 gnutls_x509_policies_set.3 \ + gnutls_x509_policy_release.3 gnutls_x509_privkey_cpy.3 \ + gnutls_x509_privkey_deinit.3 gnutls_x509_privkey_export.3 \ + gnutls_x509_privkey_export2.3 \ + gnutls_x509_privkey_export2_pkcs8.3 \ + gnutls_x509_privkey_export_dsa_raw.3 \ + gnutls_x509_privkey_export_ecc_raw.3 \ + gnutls_x509_privkey_export_gost_raw.3 \ + gnutls_x509_privkey_export_pkcs8.3 \ + gnutls_x509_privkey_export_rsa_raw.3 \ + gnutls_x509_privkey_export_rsa_raw2.3 \ + gnutls_x509_privkey_fix.3 gnutls_x509_privkey_generate.3 \ + gnutls_x509_privkey_generate2.3 \ + gnutls_x509_privkey_get_key_id.3 \ + gnutls_x509_privkey_get_pk_algorithm.3 \ + gnutls_x509_privkey_get_pk_algorithm2.3 \ + gnutls_x509_privkey_get_seed.3 gnutls_x509_privkey_get_spki.3 \ + gnutls_x509_privkey_import.3 gnutls_x509_privkey_import2.3 \ + gnutls_x509_privkey_import_dsa_raw.3 \ + gnutls_x509_privkey_import_ecc_raw.3 \ + gnutls_x509_privkey_import_gost_raw.3 \ + gnutls_x509_privkey_import_openssl.3 \ + gnutls_x509_privkey_import_pkcs8.3 \ + gnutls_x509_privkey_import_rsa_raw.3 \ + gnutls_x509_privkey_import_rsa_raw2.3 \ + gnutls_x509_privkey_init.3 gnutls_x509_privkey_sec_param.3 \ + gnutls_x509_privkey_set_flags.3 \ + gnutls_x509_privkey_set_pin_function.3 \ + gnutls_x509_privkey_set_spki.3 gnutls_x509_privkey_sign_data.3 \ + gnutls_x509_privkey_sign_hash.3 \ + gnutls_x509_privkey_verify_params.3 \ + gnutls_x509_privkey_verify_seed.3 gnutls_x509_rdn_get.3 \ + gnutls_x509_rdn_get2.3 gnutls_x509_rdn_get_by_oid.3 \ + gnutls_x509_rdn_get_oid.3 gnutls_x509_spki_deinit.3 \ + gnutls_x509_spki_get_rsa_pss_params.3 gnutls_x509_spki_init.3 \ + gnutls_x509_spki_set_rsa_pss_params.3 \ + gnutls_x509_tlsfeatures_add.3 \ + gnutls_x509_tlsfeatures_check_crt.3 \ + gnutls_x509_tlsfeatures_deinit.3 gnutls_x509_tlsfeatures_get.3 \ + gnutls_x509_tlsfeatures_init.3 \ + gnutls_x509_trust_list_add_cas.3 \ + gnutls_x509_trust_list_add_crls.3 \ + gnutls_x509_trust_list_add_named_crt.3 \ + gnutls_x509_trust_list_add_system_trust.3 \ + gnutls_x509_trust_list_add_trust_dir.3 \ + gnutls_x509_trust_list_add_trust_file.3 \ + gnutls_x509_trust_list_add_trust_mem.3 \ + gnutls_x509_trust_list_deinit.3 \ + gnutls_x509_trust_list_get_issuer.3 \ + gnutls_x509_trust_list_get_issuer_by_dn.3 \ + gnutls_x509_trust_list_get_issuer_by_subject_key_id.3 \ + gnutls_x509_trust_list_get_ptr.3 gnutls_x509_trust_list_init.3 \ + gnutls_x509_trust_list_iter_deinit.3 \ + gnutls_x509_trust_list_iter_get_ca.3 \ + gnutls_x509_trust_list_remove_cas.3 \ + gnutls_x509_trust_list_remove_trust_file.3 \ + gnutls_x509_trust_list_remove_trust_mem.3 \ + gnutls_x509_trust_list_set_getissuer_function.3 \ + gnutls_x509_trust_list_set_ptr.3 \ + gnutls_x509_trust_list_verify_crt.3 \ + gnutls_x509_trust_list_verify_crt2.3 \ + gnutls_x509_trust_list_verify_named_crt.3 +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign doc/manpages/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign doc/manpages/Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__maybe_remake_depfiles)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__maybe_remake_depfiles);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +install-man1: $(man_MANS) + @$(NORMAL_INSTALL) + @list1=''; \ + list2='$(man_MANS)'; \ + test -n "$(man1dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man1dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man1dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.1[a-z]*$$/p'; \ + fi; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man1dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man1dir)" || exit $$?; }; \ + done; } + +uninstall-man1: + @$(NORMAL_UNINSTALL) + @list=''; test -n "$(man1dir)" || exit 0; \ + files=`{ for i in $$list; do echo "$$i"; done; \ + l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + sed -n '/\.1[a-z]*$$/p'; \ + } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ + dir='$(DESTDIR)$(man1dir)'; $(am__uninstall_files_from_dir) +install-man3: $(man_MANS) + @$(NORMAL_INSTALL) + @list1=''; \ + list2='$(man_MANS)'; \ + test -n "$(man3dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man3dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man3dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.3[a-z]*$$/p'; \ + fi; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^3][0-9a-z]*$$,3,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man3dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man3dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man3dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man3dir)" || exit $$?; }; \ + done; } + +uninstall-man3: + @$(NORMAL_UNINSTALL) + @list=''; test -n "$(man3dir)" || exit 0; \ + files=`{ for i in $$list; do echo "$$i"; done; \ + l2='$(man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + sed -n '/\.3[a-z]*$$/p'; \ + } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^3][0-9a-z]*$$,3,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ + dir='$(DESTDIR)$(man3dir)'; $(am__uninstall_files_from_dir) +tags TAGS: + +ctags CTAGS: + +cscope cscopelist: + +distdir: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) distdir-am + +distdir-am: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(MANS) +installdirs: + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man3dir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." + -test -z "$(MAINTAINERCLEANFILES)" || rm -f $(MAINTAINERCLEANFILES) +clean: clean-am + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-man + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: install-man1 install-man3 + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-man + +uninstall-man: uninstall-man1 uninstall-man3 + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + cscopelist-am ctags-am distclean distclean-generic \ + distclean-libtool distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-man1 install-man3 install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am tags-am uninstall \ + uninstall-am uninstall-man uninstall-man1 uninstall-man3 + +.PRECIOUS: Makefile + + +-include $(top_srcdir)/doc/doc.mk + +$(man_MANS): $(top_srcdir)/cligen/cli-docgen.py + +certtool.1: $(top_srcdir)/doc/certtool-see-also.texi $(top_srcdir)/doc/certtool-examples.texi $(top_srcdir)/doc/certtool-files.texi +certtool.1: $(top_srcdir)/src/certtool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/certtool-see-also.texi \ + --include examples=$(top_srcdir)/doc/certtool-examples.texi \ + --include files=$(top_srcdir)/doc/certtool-files.texi \ + $< $@ + +ocsptool.1: $(top_srcdir)/doc/ocsptool-see-also.texi $(top_srcdir)/doc/ocsptool-examples.texi $(top_srcdir)/doc/ocsptool-description.texi +ocsptool.1: $(top_srcdir)/src/ocsptool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/ocsptool-see-also.texi \ + --include examples=$(top_srcdir)/doc/ocsptool-examples.texi \ + --include description=$(top_srcdir)/doc/ocsptool-description.texi \ + $< $@ + +danetool.1: $(top_srcdir)/doc/danetool-see-also.texi $(top_srcdir)/doc/danetool-examples.texi +danetool.1: $(top_srcdir)/src/danetool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/danetool-see-also.texi \ + --include examples=$(top_srcdir)/doc/danetool-examples.texi \ + $< $@ + +gnutls-cli.1: $(top_srcdir)/doc/gnutls-cli-see-also.texi $(top_srcdir)/doc/gnutls-cli-examples.texi +gnutls-cli.1: $(top_srcdir)/src/gnutls-cli-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/gnutls-cli-see-also.texi \ + --include examples=$(top_srcdir)/doc/gnutls-cli-examples.texi \ + $< $@ + +gnutls-serv.1: $(top_srcdir)/doc/gnutls-serv-see-also.texi $(top_srcdir)/doc/gnutls-serv-examples.texi +gnutls-serv.1: $(top_srcdir)/src/gnutls-serv-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/gnutls-serv-see-also.texi \ + --include examples=$(top_srcdir)/doc/gnutls-serv-examples.texi \ + $< $@ + +gnutls-cli-debug.1: $(top_srcdir)/doc/gnutls-cli-debug-see-also.texi $(top_srcdir)/doc/gnutls-cli-debug-examples.texi +gnutls-cli-debug.1: $(top_srcdir)/src/gnutls-cli-debug-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/gnutls-cli-debug-see-also.texi \ + --include examples=$(top_srcdir)/doc/gnutls-cli-debug-examples.texi \ + $< $@ + +srptool.1: $(top_srcdir)/doc/srptool-see-also.texi $(top_srcdir)/doc/srptool-examples.texi +srptool.1: $(top_srcdir)/src/srptool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/srptool-see-also.texi \ + --include examples=$(top_srcdir)/doc/srptool-examples.texi \ + $< $@ + +p11tool.1: $(top_srcdir)/doc/p11tool-see-also.texi $(top_srcdir)/doc/p11tool-examples.texi +p11tool.1: $(top_srcdir)/src/p11tool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/p11tool-see-also.texi \ + --include examples=$(top_srcdir)/doc/p11tool-examples.texi \ + $< $@ + +tpmtool.1: $(top_srcdir)/doc/tpmtool-see-also.texi $(top_srcdir)/doc/tpmtool-examples.texi +tpmtool.1: $(top_srcdir)/src/tpmtool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/tpmtool-see-also.texi \ + --include examples=$(top_srcdir)/doc/tpmtool-examples.texi \ + $< $@ + +psktool.1: $(top_srcdir)/doc/psktool-see-also.texi $(top_srcdir)/doc/psktool-examples.texi +psktool.1: $(top_srcdir)/src/psktool-options.json + $(AM_V_GEN) PYTHONPATH='$(top_srcdir)/cligen' \ + $(PYTHON) $(top_srcdir)/cligen/cli-docgen.py \ + --format man $(CLIGEN_ARGS) \ + --include see-also=$(top_srcdir)/doc/psktool-see-also.texi \ + --include examples=$(top_srcdir)/doc/psktool-examples.texi \ + $< $@ + +$(APIMANS): stamp_mans + +compare-makefile: + @echo "******************************************************************************" + @echo "If the following step fails use 'make files-update'" + @echo "******************************************************************************" + FUNCS=`cat $(HEADER_FILES)| $(top_srcdir)/doc/scripts/getfuncs.pl|sort -d|uniq`; \ + MANS=""; \ + for i in $$FUNCS; do \ + MANS="$$MANS\nAPIMANS += $$i.3"; \ + done; \ + grep -v -e '^APIMANS += ' $(srcdir)/Makefile.am | \ + perl -p -e "s/^APIMANS =/APIMANS =$$MANS/" > tmp-$@; \ + diff -u $(srcdir)/Makefile.am tmp-$@ + rm -f tmp-$@ + +stamp_mans: $(HEADER_FILES) + @for header in $(HEADER_FILES); do \ + echo $(ECHO_N) "Creating man pages for `basename $$header .in`..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $$header`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-site "https://www.gnutls.org" \ + -include "gnutls/`basename $$header .in`" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ + -function $$i \ + $(C_SOURCE_FILES) > $$i.3 && \ + echo $(ECHO_N) "."; \ + done ; \ + echo "" ; \ + done + echo $@ > $@ + +.PHONY: update-makefile + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/doc/manpages/certtool.1 b/doc/manpages/certtool.1 new file mode 100644 index 0000000..864bb45 --- /dev/null +++ b/doc/manpages/certtool.1 @@ -0,0 +1,1105 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH certtool 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]certtool\fP +\- GnuTLS certificate tool +.SH SYNOPSIS +\f\*[B-Font]certtool\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +.sp \n(Ppu +.ne 2 + +All arguments must be options. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +Tool to parse and generate X.509 certificates, requests and private keys. +It can be used interactively or non interactively by +specifying the template command line option. +.sp +The tool accepts files or supported URIs via the --infile option. In case PIN +is required for URI access you can provide it using the environment variables GNUTLS_PIN +and GNUTLS_SO_PIN. +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-V\f[], \f\*[B-Font]\-\-verbose\f[] +More verbose output. +.sp +.TP +.NOP \f\*[B-Font]\-\-infile\f[]=\f\*[I-Font]file\f[] +Input file. +.sp +.TP +.NOP \f\*[B-Font]\-\-outfile\f[]=\f\*[I-Font]str\f[] +Output file. +.sp +.SS "Certificate related options" +.TP +.NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-certificate\-info\f[] +Print information on the given certificate. +.sp +.TP +.NOP \f\*[B-Font]\-\-pubkey\-info\f[] +Print information on a public key. +.sp +The option combined with \-\-load\-request, \-\-load\-pubkey, \-\-load\-privkey and \-\-load\-certificate will extract the public key of the object in question. +.TP +.NOP \f\*[B-Font]\-s\f[], \f\*[B-Font]\-\-generate\-self\-signed\f[] +Generate a self-signed certificate. +.sp +.TP +.NOP \f\*[B-Font]\-c\f[], \f\*[B-Font]\-\-generate\-certificate\f[] +Generate a signed certificate. +.sp +.TP +.NOP \f\*[B-Font]\-\-generate\-proxy\f[] +Generates a proxy certificate. +.sp +.TP +.NOP \f\*[B-Font]\-u\f[], \f\*[B-Font]\-\-update\-certificate\f[] +Update a signed certificate. +.sp +.TP +.NOP \f\*[B-Font]\-\-fingerprint\f[] +Print the fingerprint of the given certificate. +.sp +This is a simple hash of the DER encoding of the certificate. It can be combined with the \-\-hash parameter. However, it is recommended for identification to use the key\-id which depends only on the certificate's key. +.TP +.NOP \f\*[B-Font]\-\-key\-id\f[] +Print the key ID of the given certificate. +.sp +This is a hash of the public key of the given certificate. It identifies the key uniquely, remains the same on a certificate renewal and depends only on signed fields of the certificate. +.TP +.NOP \f\*[B-Font]\-\-certificate\-pubkey\f[] +Print certificate's public key. +.sp +This option is deprecated as a duplicate of \-\-pubkey\-info +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-v1\f[] +Generate an X.509 version 1 certificate (with no extensions). +.sp +.TP +.NOP \f\*[B-Font]\-\-sign\-params\f[]=\f\*[I-Font]str\f[] +Sign a certificate with a specific signature algorithm. +.sp +This option can be combined with \-\-generate\-certificate, to sign the certificate with +a specific signature algorithm variant. The only option supported is 'RSA\-PSS', and should be +specified when the signer does not have a certificate which is marked for RSA\-PSS use only. +.SS "Certificate request related options" +.TP +.NOP \f\*[B-Font]\-\-crq\-info\f[] +Print information on the given certificate request. +.sp +.TP +.NOP \f\*[B-Font]\-q\f[], \f\*[B-Font]\-\-generate\-request\f[] +Generate a PKCS #10 certificate request. +This option must not appear in combination with any of the following options: +infile. +.sp +Will generate a PKCS #10 certificate request. To specify a private key use \-\-load\-privkey. +.TP +.NOP \f\*[B-Font]\-\-no\-crq\-extensions\f[] +Do not use extensions in certificate requests. +.sp +.SS "PKCS#12 file related options" +.TP +.NOP \f\*[B-Font]\-\-p12\-info\f[] +Print information on a PKCS #12 structure. +.sp +This option will dump the contents and print the metadata of the provided PKCS #12 structure. +.TP +.NOP \f\*[B-Font]\-\-p12\-name\f[]=\f\*[I-Font]str\f[] +The PKCS #12 friendly name to use. +.sp +The name to be used for the primary certificate and private key in a PKCS #12 file. +.TP +.NOP \f\*[B-Font]\-\-to\-p12\f[] +Generate a PKCS #12 structure. +.sp +It requires a certificate, a private key and possibly a CA certificate to be specified. +.SS "Private key related options" +.TP +.NOP \f\*[B-Font]\-k\f[], \f\*[B-Font]\-\-key\-info\f[] +Print information on a private key. +.sp +.TP +.NOP \f\*[B-Font]\-\-p8\-info\f[] +Print information on a PKCS #8 structure. +.sp +This option will print information about encrypted PKCS #8 structures. That option does not require the decryption of the structure. +.TP +.NOP \f\*[B-Font]\-\-to\-rsa\f[] +Convert an RSA-PSS key to raw RSA format. +.sp +It requires an RSA\-PSS key as input and will output a raw RSA +key. This command is necessary for compatibility with applications that +cannot read RSA\-PSS keys. +.TP +.NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-generate\-privkey\f[] +Generate a private key. +.sp +When generating RSA\-PSS private keys, the \-\-hash option will +restrict the allowed hash for the key; in the same keys the \-\-salt\-size +option is also acceptable. +.TP +.NOP \f\*[B-Font]\-\-key\-type\f[]=\f\*[I-Font]str\f[] +Specify the key type to use on key generation. +.sp +This option can be combined with \-\-generate\-privkey, to specify +the key type to be generated. Valid options are, 'rsa', 'rsa\-pss', 'dsa', 'ecdsa', 'ed25519, 'ed448', 'x25519', and 'x448'.'. +When combined with certificate generation it can be used to specify an +RSA\-PSS certificate when an RSA key is given. +.TP +.NOP \f\*[B-Font]\-\-bits\f[]=\f\*[I-Font]num\f[] +Specify the number of bits for key generation. +This option takes an integer number as its argument. +.sp +.TP +.NOP \f\*[B-Font]\-\-curve\f[]=\f\*[I-Font]str\f[] +Specify the curve used for EC key generation. +.sp +Supported values are secp192r1, secp224r1, secp256r1, secp384r1 and secp521r1. +.TP +.NOP \f\*[B-Font]\-\-sec\-param\f[]=\f\*[I-Font]security parameter\f[] +Specify the security level [low, legacy, medium, high, ultra]. +.sp +This is alternative to the bits option. +.TP +.NOP \f\*[B-Font]\-\-to\-p8\f[] +Convert a given key to a PKCS #8 structure. +.sp +This needs to be combined with \-\-load\-privkey. +.TP +.NOP \f\*[B-Font]\-8\f[], \f\*[B-Font]\-\-pkcs8\f[] +Use PKCS #8 format for private keys. +.sp +.TP +.NOP \f\*[B-Font]\-\-provable\f[] +Generate a private key or parameters from a seed using a provable method. +.sp +This will use the FIPS PUB186\-4 algorithms (i.e., Shawe\-Taylor) for provable key generation. +When specified the private keys or parameters will be generated from a seed, and can be +later validated with \-\-verify\-provable\-privkey to be correctly generated from the seed. You may +specify \-\-seed or allow GnuTLS to generate one (recommended). This option can be combined with +\-\-generate\-privkey or \-\-generate\-dh\-params. +.sp +That option applies to RSA and DSA keys. On the DSA keys the PQG parameters +are generated using the seed, and on RSA the two primes. +.TP +.NOP \f\*[B-Font]\-\-verify\-provable\-privkey\f[] +Verify a private key generated from a seed using a provable method. +.sp +This will use the FIPS\-186\-4 algorithms for provable key generation. You may specify \-\-seed or use the seed stored in the private key structure. +.TP +.NOP \f\*[B-Font]\-\-seed\f[]=\f\*[I-Font]str\f[] +When generating a private key use the given hex-encoded seed. +.sp +The seed acts as a security parameter for the private key, and +thus a seed size which corresponds to the security level of the private key +should be provided (e.g., 256\-bits seed). +.SS "CRL related options" +.TP +.NOP \f\*[B-Font]\-l\f[], \f\*[B-Font]\-\-crl\-info\f[] +Print information on the given CRL structure. +.sp +.TP +.NOP \f\*[B-Font]\-\-generate\-crl\f[] +Generate a CRL. +.sp +This option generates a Certificate Revocation List. When combined with \-\-load\-crl it would use the loaded CRL as base for the generated (i.e., all revoked certificates in the base will be copied to the new CRL). +To add new certificates to the CRL use \-\-load\-certificate. +.TP +.NOP \f\*[B-Font]\-\-verify\-crl\f[] +Verify a Certificate Revocation List using a trusted list. +This option must appear in combination with the following options: +load-ca-certificate. +.sp +The trusted certificate list must be loaded with \-\-load\-ca\-certificate. +.SS "Certificate verification related options" +.TP +.NOP \f\*[B-Font]\-e\f[], \f\*[B-Font]\-\-verify\-chain\f[] +Verify a PEM encoded certificate chain. +.sp +Verifies the validity of a certificate chain. That is, an ordered set of +certificates where each one is the issuer of the previous, and the first is +the end\-certificate to be validated. In a proper chain the last certificate +is a self signed one. It can be combined with \-\-verify\-purpose or \-\-verify\-hostname. +.TP +.NOP \f\*[B-Font]\-\-verify\f[] +Verify a PEM encoded certificate (chain) against a trusted set. +.sp +The trusted certificate list can be loaded with \-\-load\-ca\-certificate. If no +certificate list is provided, then the system's trusted certificate list is used. Note that +during verification multiple paths may be explored. On a successful verification +the successful path will be the last one. It can be combined with \-\-verify\-purpose or \-\-verify\-hostname. +.TP +.NOP \f\*[B-Font]\-\-verify\-hostname\f[]=\f\*[I-Font]str\f[] +Specify a hostname to be used for certificate chain verification. +.sp +This is to be combined with one of the verify certificate options. +.TP +.NOP \f\*[B-Font]\-\-verify\-email\f[]=\f\*[I-Font]str\f[] +Specify a email to be used for certificate chain verification. +This option must not appear in combination with any of the following options: +verify-hostname. +.sp +This is to be combined with one of the verify certificate options. +.TP +.NOP \f\*[B-Font]\-\-verify\-purpose\f[]=\f\*[I-Font]str\f[] +Specify a purpose OID to be used for certificate chain verification. +.sp +This object identifier restricts the purpose of the certificates to be verified. Example purposes are 1.3.6.1.5.5.7.3.1 (TLS WWW), 1.3.6.1.5.5.7.3.4 (EMAIL) etc. Note that a CA certificate without a purpose set (extended key usage) is valid for any purpose. +.TP +.NOP \f\*[B-Font]\-\-verify\-allow\-broken\f[] +Allow broken algorithms, such as MD5 for verification. +.sp +This can be combined with \-\-p7\-verify, \-\-verify or \-\-verify\-chain. +.TP +.NOP \f\*[B-Font]\-\-verify\-profile\f[]=\f\*[I-Font]str\f[] +Specify a security level profile to be used for verification. +.sp +This option can be used to specify a certificate verification profile. Certificate + verification profiles correspond to the security level. This should be one of + 'none', 'very weak', 'low', 'legacy', 'medium', 'high', 'ultra', + 'future'. Note that by default no profile is applied, unless one is set + as minimum in the gnutls configuration file. +.SS "PKCS#7 structure options" +.TP +.NOP \f\*[B-Font]\-\-p7\-generate\f[] +Generate a PKCS #7 structure. +.sp +This option generates a PKCS #7 certificate container structure. To add certificates in the structure use \-\-load\-certificate and \-\-load\-crl. +.TP +.NOP \f\*[B-Font]\-\-p7\-sign\f[] +Signs using a PKCS #7 structure. +.sp +This option generates a PKCS #7 structure containing a signature for the provided data from infile. The data are stored within the structure. The signer certificate has to be specified using \-\-load\-certificate and \-\-load\-privkey. The input to \-\-load\-certificate can be a list of certificates. In case of a list, the first certificate is used for signing and the other certificates are included in the structure. +.TP +.NOP \f\*[B-Font]\-\-p7\-detached\-sign\f[] +Signs using a detached PKCS #7 structure. +.sp +This option generates a PKCS #7 structure containing a signature for the provided data from infile. The signer certificate has to be specified using \-\-load\-certificate and \-\-load\-privkey. The input to \-\-load\-certificate can be a list of certificates. In case of a list, the first certificate is used for signing and the other certificates are included in the structure. +.TP +.NOP \f\*[B-Font]\-\-p7\-include\-cert\f[], \f\*[B-Font]\-\-no\-p7\-include\-cert\f[] +The signer's certificate will be included in the cert list. +The \fIno\-p7\-include\-cert\fP form will disable the option. +This option is enabled by default. +.sp +This options works with \-\-p7\-sign or \-\-p7\-detached\-sign and will include or exclude the signer's certificate into the generated signature. +.TP +.NOP \f\*[B-Font]\-\-p7\-time\f[], \f\*[B-Font]\-\-no\-p7\-time\f[] +Will include a timestamp in the PKCS #7 structure. +The \fIno\-p7\-time\fP form will disable the option. +.sp +This option will include a timestamp in the generated signature +.TP +.NOP \f\*[B-Font]\-\-p7\-show\-data\f[], \f\*[B-Font]\-\-no\-p7\-show\-data\f[] +Will show the embedded data in the PKCS #7 structure. +The \fIno\-p7\-show\-data\fP form will disable the option. +.sp +This option can be combined with \-\-p7\-verify or \-\-p7\-info and will display the embedded signed data in the PKCS #7 structure. +.TP +.NOP \f\*[B-Font]\-\-p7\-info\f[] +Print information on a PKCS #7 structure. +.sp +.TP +.NOP \f\*[B-Font]\-\-p7\-verify\f[] +Verify the provided PKCS #7 structure. +.sp +This option verifies the signed PKCS #7 structure. The certificate list to use for verification can be specified with \-\-load\-ca\-certificate. When no certificate list is provided, then the system's certificate list is used. Alternatively a direct signer can be provided using \-\-load\-certificate. A key purpose can be enforced with the \-\-verify\-purpose option, and the \-\-load\-data option will utilize detached data. +.TP +.NOP \f\*[B-Font]\-\-smime\-to\-p7\f[] +Convert S/MIME to PKCS #7 structure. +.sp +.SS "Other options" +.TP +.NOP \f\*[B-Font]\-\-generate\-dh\-params\f[] +Generate PKCS #3 encoded Diffie-Hellman parameters. +.sp +The will generate random parameters to be used with +Diffie\-Hellman key exchange. The output parameters will be in PKCS #3 +format. Note that it is recommended to use the \-\-get\-dh\-params option +instead. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-get\-dh\-params\f[] +List the included PKCS #3 encoded Diffie-Hellman parameters. +.sp +Returns stored DH parameters in GnuTLS. Those parameters returned +are defined in RFC7919, and can be considered standard parameters for a TLS +key exchange. This option is provided for old applications which require +DH parameters to be specified; modern GnuTLS applications should not require +them. +.TP +.NOP \f\*[B-Font]\-\-dh\-info\f[] +Print information PKCS #3 encoded Diffie-Hellman parameters. +.sp +.TP +.NOP \f\*[B-Font]\-\-load\-privkey\f[]=\f\*[I-Font]str\f[] +Loads a private key file. +.sp +This can be either a file or a PKCS #11 URL +.TP +.NOP \f\*[B-Font]\-\-load\-pubkey\f[]=\f\*[I-Font]str\f[] +Loads a public key file. +.sp +This can be either a file or a PKCS #11 URL +.TP +.NOP \f\*[B-Font]\-\-load\-request\f[]=\f\*[I-Font]str\f[] +Loads a certificate request file. +.sp +This option can be used with a file +.TP +.NOP \f\*[B-Font]\-\-load\-certificate\f[]=\f\*[I-Font]str\f[] +Loads a certificate file. +.sp +This option can be used with a file +.TP +.NOP \f\*[B-Font]\-\-load\-ca\-privkey\f[]=\f\*[I-Font]str\f[] +Loads the certificate authority's private key file. +.sp +This can be either a file or a PKCS #11 URL +.TP +.NOP \f\*[B-Font]\-\-load\-ca\-certificate\f[]=\f\*[I-Font]str\f[] +Loads the certificate authority's certificate file. +.sp +This can be either a file or a PKCS #11 URL +.TP +.NOP \f\*[B-Font]\-\-load\-crl\f[]=\f\*[I-Font]str\f[] +Loads the provided CRL. +.sp +This option can be used with a file +.TP +.NOP \f\*[B-Font]\-\-load\-data\f[]=\f\*[I-Font]str\f[] +Loads auxiliary data. +.sp +This option can be used with a file +.TP +.NOP \f\*[B-Font]\-\-password\f[]=\f\*[I-Font]str\f[] +Password to use. +.sp +You can use this option to specify the password in the command line instead of reading it from the tty. Note, that the command line arguments are available for view in others in the system. Specifying password as '' is the same as specifying no password. +.TP +.NOP \f\*[B-Font]\-\-null\-password\f[] +Enforce a NULL password. +.sp +This option enforces a NULL password. This is different than the empty or no password in schemas like PKCS #8. +.TP +.NOP \f\*[B-Font]\-\-empty\-password\f[] +Enforce an empty password. +.sp +This option enforces an empty password. This is different than the NULL or no password in schemas like PKCS #8. +.TP +.NOP \f\*[B-Font]\-\-hex\-numbers\f[] +Print big number in an easier format to parse. +.sp +.TP +.NOP \f\*[B-Font]\-\-cprint\f[] +In certain operations it prints the information in C-friendly format. +.sp +In certain operations it prints the information in C\-friendly format, suitable for including into C programs. +.TP +.NOP \f\*[B-Font]\-\-rsa\f[] +Generate RSA key. +.sp +When combined with \-\-generate\-privkey generates an RSA private key. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-dsa\f[] +Generate DSA key. +.sp +When combined with \-\-generate\-privkey generates a DSA private key. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-ecc\f[] +Generate ECC (ECDSA) key. +.sp +When combined with \-\-generate\-privkey generates an elliptic curve private key to be used with ECDSA. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-ecdsa\f[] +This is an alias for the \fI--ecc\fR option. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-hash\f[]=\f\*[I-Font]str\f[] +Hash algorithm to use for signing. +.sp +Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512, SHA3\-224, SHA3\-256, SHA3\-384, SHA3\-512. +.TP +.NOP \f\*[B-Font]\-\-salt\-size\f[]=\f\*[I-Font]num\f[] +Specify the RSA-PSS key default salt size. +This option takes an integer number as its argument. +.sp +Typical keys shouldn't set or restrict this option. +.TP +.NOP \f\*[B-Font]\-\-inder\f[], \f\*[B-Font]\-\-no\-inder\f[] +Use DER format for input certificates, private keys, and DH parameters . +The \fIno\-inder\fP form will disable the option. +.sp +The input files will be assumed to be in DER or RAW format. +Unlike options that in PEM input would allow multiple input data (e.g. multiple +certificates), when reading in DER format a single data structure is read. +.TP +.NOP \f\*[B-Font]\-\-inraw\f[] +This is an alias for the \fI--inder\fR option. +.TP +.NOP \f\*[B-Font]\-\-outder\f[], \f\*[B-Font]\-\-no\-outder\f[] +Use DER format for output certificates, private keys, and DH parameters. +The \fIno\-outder\fP form will disable the option. +.sp +The output will be in DER or RAW format. +.TP +.NOP \f\*[B-Font]\-\-outraw\f[] +This is an alias for the \fI--outder\fR option. +.TP +.NOP \f\*[B-Font]\-\-disable\-quick\-random\f[] +No effect. +.sp +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-template\f[]=\f\*[I-Font]str\f[] +Template file to use for non-interactive operation. +.sp +.TP +.NOP \f\*[B-Font]\-\-stdout\-info\f[] +Print information to stdout instead of stderr. +.sp +.TP +.NOP \f\*[B-Font]\-\-ask\-pass\f[] +Enable interaction for entering password when in batch mode. +.sp +This option will enable interaction to enter password when in batch mode. That is useful when the template option has been specified. +.TP +.NOP \f\*[B-Font]\-\-pkcs\-cipher\f[]=\f\*[I-Font]cipher\f[] +Cipher to use for PKCS #8 and #12 operations. +.sp +Cipher may be one of 3des, 3des\-pkcs12, aes\-128, aes\-192, aes\-256, rc2\-40, arcfour. +.TP +.NOP \f\*[B-Font]\-\-provider\f[]=\f\*[I-Font]str\f[] +Specify the PKCS #11 provider library. +.sp +This will override the default options in /etc/gnutls/pkcs11.conf +.TP +.NOP \f\*[B-Font]\-\-text\f[], \f\*[B-Font]\-\-no\-text\f[] +Output textual information before PEM-encoded certificates, private keys, etc. +The \fIno\-text\fP form will disable the option. +This option is enabled by default. +.sp +Output textual information before PEM\-encoded data +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.SH FILES +.br +\fBCerttool's template file format\fP +.br +A template file can be used to avoid the interactive questions of +certtool. Initially create a file named 'cert.cfg' that contains the information +about the certificate. The template can be used as below: +.sp +.br +.in +4 +.nf +$ certtool \-\-generate\-certificate \-\-load\-privkey key.pem \ + \-\-template cert.cfg \-\-outfile cert.pem \ + \-\-load\-ca\-certificate ca\-cert.pem \-\-load\-ca\-privkey ca\-key.pem +.in -4 +.fi +.sp +An example certtool template file that can be used to generate a certificate +request or a self signed certificate follows. +.sp +.br +.in +4 +.nf +# X.509 Certificate options +# +# DN options +.sp +# The organization of the subject. +organization = "Koko inc." +.sp +# The organizational unit of the subject. +unit = "sleeping dept." +.sp +# The locality of the subject. +# locality = +.sp +# The state of the certificate owner. +state = "Attiki" +.sp +# The country of the subject. Two letter code. +country = GR +.sp +# The common name of the certificate owner. +cn = "Cindy Lauper" +.sp +# A user id of the certificate owner. +#uid = "clauper" +.sp +# Set domain components +#dc = "name" +#dc = "domain" +.sp +# If the supported DN OIDs are not adequate you can set +# any OID here. +# For example set the X.520 Title and the X.520 Pseudonym +# by using OID and string pairs. +#dn_oid = "2.5.4.12 Dr." +#dn_oid = "2.5.4.65 jackal" +.sp +# This is deprecated and should not be used in new +# certificates. +# pkcs9_email = "none@none.org" +.sp +# An alternative way to set the certificate's distinguished name directly +# is with the "dn" option. The attribute names allowed are: +# C (country), street, O (organization), OU (unit), title, CN (common name), +# L (locality), ST (state), placeOfBirth, gender, countryOfCitizenship, +# countryOfResidence, serialNumber, telephoneNumber, surName, initials, +# generationQualifier, givenName, pseudonym, dnQualifier, postalCode, name, +# businessCategory, DC, UID, jurisdictionOfIncorporationLocalityName, +# jurisdictionOfIncorporationStateOrProvinceName, +# jurisdictionOfIncorporationCountryName, XmppAddr, and numeric OIDs. +.sp +#dn = "cn = Nikos,st = New\, Something,C=GR,surName=Mavrogiannopoulos,2.5.4.9=Arkadias" +.sp +# The serial number of the certificate +# The value is in decimal (i.e. 1963) or hex (i.e. 0x07ab). +# Comment the field for a random serial number. +serial = 007 +.sp +# In how many days, counting from today, this certificate will expire. +# Use \-1 if there is no expiration date. +expiration_days = 700 +.sp +# Alternatively you may set concrete dates and time. The GNU date string +# formats are accepted. See: +# https://www.gnu.org/software/tar/manual/html_node/Date\-input\-formats.html +.sp +#activation_date = "2004\-02\-29 16:21:42" +#expiration_date = "2025\-02\-29 16:24:41" +.sp +# X.509 v3 extensions +.sp +# A dnsname in case of a WWW server. +#dns_name = "www.none.org" +#dns_name = "www.morethanone.org" +.sp +# An othername defined by an OID and a hex encoded string +#other_name = "1.3.6.1.5.2.2 302ca00d1b0b56414e5245494e2e4f5247a11b3019a006020400000002a10f300d1b047269636b1b0561646d696e" +#other_name_utf8 = "1.2.4.5.6 A UTF8 string" +#other_name_octet = "1.2.4.5.6 A string that will be encoded as ASN.1 octet string" +.sp +# Allows writing an XmppAddr Identifier +#xmpp_name = juliet@im.example.com +.sp +# Names used in PKINIT +#krb5_principal = user@REALM.COM +#krb5_principal = HTTP/user@REALM.COM +.sp +# A subject alternative name URI +#uri = "https://www.example.com" +.sp +# An IP address in case of a server. +#ip_address = "192.168.1.1" +.sp +# An email in case of a person +email = "none@none.org" +.sp +# TLS feature (rfc7633) extension. That can is used to indicate mandatory TLS +# extension features to be provided by the server. In practice this is used +# to require the Status Request (extid: 5) extension from the server. That is, +# to require the server holding this certificate to provide a stapled OCSP response. +# You can have multiple lines for multiple TLS features. +.sp +# To ask for OCSP status request use: +#tls_feature = 5 +.sp +# Challenge password used in certificate requests +challenge_password = 123456 +.sp +# Password when encrypting a private key +#password = secret +.sp +# An URL that has CRLs (certificate revocation lists) +# available. Needed in CA certificates. +#crl_dist_points = "https://www.getcrl.crl/getcrl/" +.sp +# Whether this is a CA certificate or not +#ca +.sp +# Subject Unique ID (in hex) +#subject_unique_id = 00153224 +.sp +# Issuer Unique ID (in hex) +#issuer_unique_id = 00153225 +.sp +#### Key usage +.sp +# The following key usage flags are used by CAs and end certificates +.sp +# Whether this certificate will be used to sign data (needed +# in TLS DHE ciphersuites). This is the digitalSignature flag +# in RFC5280 terminology. +signing_key +.sp +# Whether this certificate will be used to encrypt data (needed +# in TLS RSA ciphersuites). Note that it is preferred to use different +# keys for encryption and signing. This is the keyEncipherment flag +# in RFC5280 terminology. +encryption_key +.sp +# Whether this key will be used to sign other certificates. The +# keyCertSign flag in RFC5280 terminology. +#cert_signing_key +.sp +# Whether this key will be used to sign CRLs. The +# cRLSign flag in RFC5280 terminology. +#crl_signing_key +.sp +# The keyAgreement flag of RFC5280. Its purpose is loosely +# defined. Not use it unless required by a protocol. +#key_agreement +.sp +# The dataEncipherment flag of RFC5280. Its purpose is loosely +# defined. Not use it unless required by a protocol. +#data_encipherment +.sp +# The nonRepudiation flag of RFC5280. Its purpose is loosely +# defined. Not use it unless required by a protocol. +#non_repudiation +.sp +#### Extended key usage (key purposes) +.sp +# The following extensions are used in an end certificate +# to clarify its purpose. Some CAs also use it to indicate +# the types of certificates they are purposed to sign. +.sp +.sp +# Whether this certificate will be used for a TLS client; +# this sets the id\-kp\-clientAuth (1.3.6.1.5.5.7.3.2) of +# extended key usage. +#tls_www_client +.sp +# Whether this certificate will be used for a TLS server; +# this sets the id\-kp\-serverAuth (1.3.6.1.5.5.7.3.1) of +# extended key usage. +#tls_www_server +.sp +# Whether this key will be used to sign code. This sets the +# id\-kp\-codeSigning (1.3.6.1.5.5.7.3.3) of extended key usage +# extension. +#code_signing_key +.sp +# Whether this key will be used to sign OCSP data. This sets the +# id\-kp\-OCSPSigning (1.3.6.1.5.5.7.3.9) of extended key usage extension. +#ocsp_signing_key +.sp +# Whether this key will be used for time stamping. This sets the +# id\-kp\-timeStamping (1.3.6.1.5.5.7.3.8) of extended key usage extension. +#time_stamping_key +.sp +# Whether this key will be used for email protection. This sets the +# id\-kp\-emailProtection (1.3.6.1.5.5.7.3.4) of extended key usage extension. +#email_protection_key +.sp +# Whether this key will be used for IPsec IKE operations (1.3.6.1.5.5.7.3.17). +#ipsec_ike_key +.sp +## adding custom key purpose OIDs +.sp +# for microsoft smart card logon +# key_purpose_oid = 1.3.6.1.4.1.311.20.2.2 +.sp +# for email protection +# key_purpose_oid = 1.3.6.1.5.5.7.3.4 +.sp +# for any purpose (must not be used in intermediate CA certificates) +# key_purpose_oid = 2.5.29.37.0 +.sp +### end of key purpose OIDs +.sp +### Adding arbitrary extensions +# This requires to provide the extension OIDs, as well as the extension data in +# hex format. The following two options are available since GnuTLS 3.5.3. +#add_extension = "1.2.3.4 0x0AAB01ACFE" +.sp +# As above but encode the data as an octet string +#add_extension = "1.2.3.4 octet_string(0x0AAB01ACFE)" +.sp +# For portability critical extensions shouldn't be set to certificates. +#add_critical_extension = "5.6.7.8 0x1AAB01ACFE" +.sp +# When generating a certificate from a certificate +# request, then honor the extensions stored in the request +# and store them in the real certificate. +#honor_crq_extensions +.sp +# Alternatively only specific extensions can be copied. +#honor_crq_ext = 2.5.29.17 +#honor_crq_ext = 2.5.29.15 +.sp +# Path length constraint. Sets the maximum number of +# certificates that can be used to certify this certificate. +# (i.e. the certificate chain length) +#path_len = \-1 +#path_len = 2 +.sp +# OCSP URI +# ocsp_uri = https://my.ocsp.server/ocsp +.sp +# CA issuers URI +# ca_issuers_uri = https://my.ca.issuer +.sp +# Certificate policies +#policy1 = 1.3.6.1.4.1.5484.1.10.99.1.0 +#policy1_txt = "This is a long policy to summarize" +#policy1_url = https://www.example.com/a\-policy\-to\-read +.sp +#policy2 = 1.3.6.1.4.1.5484.1.10.99.1.1 +#policy2_txt = "This is a short policy" +#policy2_url = https://www.example.com/another\-policy\-to\-read +.sp +# The number of additional certificates that may appear in a +# path before the anyPolicy is no longer acceptable. +#inhibit_anypolicy_skip_certs 1 +.sp +# Name constraints +.sp +# DNS +#nc_permit_dns = example.com +#nc_exclude_dns = test.example.com +.sp +# EMAIL +#nc_permit_email = "nmav@ex.net" +.sp +# Exclude subdomains of example.com +#nc_exclude_email = .example.com +.sp +# Exclude all e\-mail addresses of example.com +#nc_exclude_email = example.com +.sp +# IP +#nc_permit_ip = 192.168.0.0/16 +#nc_exclude_ip = 192.168.5.0/24 +#nc_permit_ip = fc0a:eef2:e7e7:a56e::/64 +.sp +.sp +# Options for proxy certificates +#proxy_policy_language = 1.3.6.1.5.5.7.21.1 +.sp +.sp +# Options for generating a CRL +.sp +# The number of days the next CRL update will be due. +# next CRL update will be in 43 days +#crl_next_update = 43 +.sp +# this is the 5th CRL by this CA +# The value is in decimal (i.e. 1963) or hex (i.e. 0x07ab). +# Comment the field for a time\-based number. +# Time\-based CRL numbers generated in GnuTLS 3.6.3 and later +# are significantly larger than those generated in previous +# versions. Since CRL numbers need to be monotonic, you need +# to specify the CRL number here manually if you intend to +# downgrade to an earlier version than 3.6.3 after publishing +# the CRL as it is not possible to specify CRL numbers greater +# than 2**63\-2 using hex notation in those versions. +#crl_number = 5 +.sp +# Specify the update dates more precisely. +#crl_this_update_date = "2004\-02\-29 16:21:42" +#crl_next_update_date = "2025\-02\-29 16:24:41" +.sp +# The date that the certificates will be made seen as +# being revoked. +#crl_revocation_date = "2025\-02\-29 16:24:41" +.sp +.in -4 +.fi +.sp +.SH EXAMPLES +.br +\fBGenerating private keys\fP +.br +To create an RSA private key, run: +.br +.in +4 +.nf +$ certtool \-\-generate\-privkey \-\-outfile key.pem \-\-rsa +.in -4 +.fi +.sp +To create a DSA or elliptic curves (ECDSA) private key use the +above command combined with 'dsa' or 'ecc' options. +.sp +.br +\fBGenerating certificate requests\fP +.br +To create a certificate request (needed when the certificate is issued by +another party), run: +.br +.in +4 +.nf +certtool \-\-generate\-request \-\-load\-privkey key.pem \ + \-\-outfile request.pem +.in -4 +.fi +.sp +If the private key is stored in a smart card you can generate +a request by specifying the private key object URL. +.br +.in +4 +.nf +$ ./certtool \-\-generate\-request \-\-load\-privkey "pkcs11:..." \ + \-\-load\-pubkey "pkcs11:..." \-\-outfile request.pem +.in -4 +.fi +.sp +.sp +.br +\fBGenerating a self\-signed certificate\fP +.br +To create a self signed certificate, use the command: +.br +.in +4 +.nf +$ certtool \-\-generate\-privkey \-\-outfile ca\-key.pem +$ certtool \-\-generate\-self\-signed \-\-load\-privkey ca\-key.pem \ + \-\-outfile ca\-cert.pem +.in -4 +.fi +.sp +Note that a self\-signed certificate usually belongs to a certificate +authority, that signs other certificates. +.sp +.br +\fBGenerating a certificate\fP +.br +To generate a certificate using the previous request, use the command: +.br +.in +4 +.nf +$ certtool \-\-generate\-certificate \-\-load\-request request.pem \ + \-\-outfile cert.pem \-\-load\-ca\-certificate ca\-cert.pem \ + \-\-load\-ca\-privkey ca\-key.pem +.in -4 +.fi +.sp +To generate a certificate using the private key only, use the command: +.br +.in +4 +.nf +$ certtool \-\-generate\-certificate \-\-load\-privkey key.pem \ + \-\-outfile cert.pem \-\-load\-ca\-certificate ca\-cert.pem \ + \-\-load\-ca\-privkey ca\-key.pem +.in -4 +.fi +.sp +.br +\fBCertificate information\fP +.br +To view the certificate information, use: +.br +.in +4 +.nf +$ certtool \-\-certificate\-info \-\-infile cert.pem +.in -4 +.fi +.sp +.br +\fBChanging the certificate format\fP +.br +To convert the certificate from PEM to DER format, use: +.br +.in +4 +.nf +$ certtool \-\-certificate\-info \-\-infile cert.pem \-\-outder \-\-outfile cert.der +.in -4 +.fi +.sp +.br +\fBPKCS #12 structure generation\fP +.br +To generate a PKCS #12 structure using the previous key and certificate, +use the command: +.br +.in +4 +.nf +$ certtool \-\-load\-certificate cert.pem \-\-load\-privkey key.pem \ + \-\-to\-p12 \-\-outder \-\-outfile key.p12 +.in -4 +.fi +.sp +Some tools (reportedly web browsers) have problems with that file +because it does not contain the CA certificate for the certificate. +To work around that problem in the tool, you can use the +\-\-load\-ca\-certificate parameter as follows: +.sp +.br +.in +4 +.nf +$ certtool \-\-load\-ca\-certificate ca.pem \ + \-\-load\-certificate cert.pem \-\-load\-privkey key.pem \ + \-\-to\-p12 \-\-outder \-\-outfile key.p12 +.in -4 +.fi +.sp +.br +\fBObtaining Diffie\-Hellman parameters\fP +.br +To obtain the RFC7919 parameters for Diffie\-Hellman key exchange, use the command: +.br +.in +4 +.nf +$ certtool \-\-get\-dh\-params \-\-outfile dh.pem \-\-sec\-param medium +.in -4 +.fi +.sp +.br +\fBVerifying a certificate\fP +.br +To verify a certificate in a file against the system's CA trust store +use the following command: +.br +.in +4 +.nf +$ certtool \-\-verify \-\-infile cert.pem +.in -4 +.fi +.sp +It is also possible to simulate hostname verification with the following +options: +.br +.in +4 +.nf +$ certtool \-\-verify \-\-verify\-hostname www.example.com \-\-infile cert.pem +.in -4 +.fi +.sp +.sp +.br +\fBProxy certificate generation\fP +.br +Proxy certificate can be used to delegate your credential to a +temporary, typically short\-lived, certificate. To create one from the +previously created certificate, first create a temporary key and then +generate a proxy certificate for it, using the commands: +.sp +.br +.in +4 +.nf +$ certtool \-\-generate\-privkey > proxy\-key.pem +$ certtool \-\-generate\-proxy \-\-load\-ca\-privkey key.pem \ + \-\-load\-privkey proxy\-key.pem \-\-load\-certificate cert.pem \ + \-\-outfile proxy\-cert.pem +.in -4 +.fi +.sp +.br +\fBCertificate revocation list generation\fP +.br +To create an empty Certificate Revocation List (CRL) do: +.sp +.br +.in +4 +.nf +$ certtool \-\-generate\-crl \-\-load\-ca\-privkey x509\-ca\-key.pem \ + \-\-load\-ca\-certificate x509\-ca.pem +.in -4 +.fi +.sp +To create a CRL that contains some revoked certificates, place the +certificates in a file and use \fB\-\-load\-certificate\fP as follows: +.sp +.br +.in +4 +.nf +$ certtool \-\-generate\-crl \-\-load\-ca\-privkey x509\-ca\-key.pem \ + \-\-load\-ca\-certificate x509\-ca.pem \-\-load\-certificate revoked\-certs.pem +.in -4 +.fi +.sp +To verify a Certificate Revocation List (CRL) do: +.sp +.br +.in +4 +.nf +$ certtool \-\-verify\-crl \-\-load\-ca\-certificate x509\-ca.pem < crl.pem +.in -4 +.fi +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +p11tool (1), psktool (1), srptool (1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org diff --git a/doc/manpages/dane_cert_type_name.3 b/doc/manpages/dane_cert_type_name.3 new file mode 100644 index 0000000..8ff3e71 --- /dev/null +++ b/doc/manpages/dane_cert_type_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_cert_type_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_cert_type_name \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "const char * dane_cert_type_name(dane_cert_type_t " type ");" +.SH ARGUMENTS +.IP "dane_cert_type_t type" 12 +is a DANE match type +.SH "DESCRIPTION" +Convert a \fBdane_cert_type_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified +type, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_cert_usage_name.3 b/doc/manpages/dane_cert_usage_name.3 new file mode 100644 index 0000000..4d5aed3 --- /dev/null +++ b/doc/manpages/dane_cert_usage_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_cert_usage_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_cert_usage_name \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "const char * dane_cert_usage_name(dane_cert_usage_t " usage ");" +.SH ARGUMENTS +.IP "dane_cert_usage_t usage" 12 +is a DANE certificate usage +.SH "DESCRIPTION" +Convert a \fBdane_cert_usage_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified +type, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_match_type_name.3 b/doc/manpages/dane_match_type_name.3 new file mode 100644 index 0000000..692be08 --- /dev/null +++ b/doc/manpages/dane_match_type_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_match_type_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_match_type_name \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "const char * dane_match_type_name(dane_match_type_t " type ");" +.SH ARGUMENTS +.IP "dane_match_type_t type" 12 +is a DANE match type +.SH "DESCRIPTION" +Convert a \fBdane_match_type_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified +type, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_query_data.3 b/doc/manpages/dane_query_data.3 new file mode 100644 index 0000000..6ba1ce4 --- /dev/null +++ b/doc/manpages/dane_query_data.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_query_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_query_data \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_query_data(dane_query_t " q ", unsigned int " idx ", unsigned int * " usage ", unsigned int * " type ", unsigned int * " match ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "dane_query_t q" 12 +The query result structure +.IP "unsigned int idx" 12 +The index of the query response. +.IP "unsigned int * usage" 12 +The certificate usage (see \fBdane_cert_usage_t\fP) +.IP "unsigned int * type" 12 +The certificate type (see \fBdane_cert_type_t\fP) +.IP "unsigned int * match" 12 +The DANE matching type (see \fBdane_match_type_t\fP) +.IP "gnutls_datum_t * data" 12 +The DANE data. +.SH "DESCRIPTION" +This function will provide the DANE data from the query +response. +.SH "RETURNS" +On success, \fBDANE_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_query_deinit.3 b/doc/manpages/dane_query_deinit.3 new file mode 100644 index 0000000..910d4a2 --- /dev/null +++ b/doc/manpages/dane_query_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_query_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_query_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "void dane_query_deinit(dane_query_t " q ");" +.SH ARGUMENTS +.IP "dane_query_t q" 12 +The structure to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a DANE query result structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_query_entries.3 b/doc/manpages/dane_query_entries.3 new file mode 100644 index 0000000..af39770 --- /dev/null +++ b/doc/manpages/dane_query_entries.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_query_entries" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_query_entries \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "unsigned int dane_query_entries(dane_query_t " q ");" +.SH ARGUMENTS +.IP "dane_query_t q" 12 +The query result structure +.SH "DESCRIPTION" +This function will return the number of entries in a query. +.SH "RETURNS" +The number of entries. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_query_status.3 b/doc/manpages/dane_query_status.3 new file mode 100644 index 0000000..9c9a59b --- /dev/null +++ b/doc/manpages/dane_query_status.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_query_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_query_status \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "dane_query_status_t dane_query_status(dane_query_t " q ");" +.SH ARGUMENTS +.IP "dane_query_t q" 12 +The query result structure +.SH "DESCRIPTION" +This function will return the status of the query response. +See \fBdane_query_status_t\fP for the possible types. +.SH "RETURNS" +The status type. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_query_tlsa.3 b/doc/manpages/dane_query_tlsa.3 new file mode 100644 index 0000000..444304a --- /dev/null +++ b/doc/manpages/dane_query_tlsa.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_query_tlsa" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_query_tlsa \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_query_tlsa(dane_state_t " s ", dane_query_t * " r ", const char * " host ", const char * " proto ", unsigned int " port ");" +.SH ARGUMENTS +.IP "dane_state_t s" 12 +The DANE state structure +.IP "dane_query_t * r" 12 +A structure to place the result +.IP "const char * host" 12 +The host name to resolve. +.IP "const char * proto" 12 +The protocol type (tcp, udp, etc.) +.IP "unsigned int port" 12 +The service port number (eg. 443). +.SH "DESCRIPTION" +This function will query the DNS server for the TLSA (DANE) +data for the given host. +.SH "RETURNS" +On success, \fBDANE_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_query_to_raw_tlsa.3 b/doc/manpages/dane_query_to_raw_tlsa.3 new file mode 100644 index 0000000..77dca78 --- /dev/null +++ b/doc/manpages/dane_query_to_raw_tlsa.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_query_to_raw_tlsa" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_query_to_raw_tlsa \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_query_to_raw_tlsa(dane_query_t " q ", unsigned int * " data_entries ", char *** " dane_data ", int ** " dane_data_len ", int * " secure ", int * " bogus ");" +.SH ARGUMENTS +.IP "dane_query_t q" 12 +The query result structure +.IP "unsigned int * data_entries" 12 +Pointer set to the number of entries in the query +.IP "char *** dane_data" 12 +Pointer to contain an array of DNS rdata items, terminated with a NULL pointer; +caller must guarantee that the referenced data remains +valid until \fBdane_query_deinit()\fP is called. +.IP "int ** dane_data_len" 12 +Pointer to contain the length n bytes of the dane_data items +.IP "int * secure" 12 +Pointer set true if the result is validated securely, false if +validation failed or the domain queried has no security info +.IP "int * bogus" 12 +Pointer set true if the result was not secure due to a security failure +.SH "DESCRIPTION" +This function will provide the DANE data from the query +response. + +The pointers dane_data and dane_data_len are allocated with \fBgnutls_malloc()\fP +to contain the data from the query result structure (individual + \fIdane_data\fP items simply point to the original data and are not allocated separately). +The returned \fIdane_data\fP are only valid during the lifetime of \fIq\fP . +.SH "RETURNS" +On success, \fBDANE_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_raw_tlsa.3 b/doc/manpages/dane_raw_tlsa.3 new file mode 100644 index 0000000..d8406d5 --- /dev/null +++ b/doc/manpages/dane_raw_tlsa.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_raw_tlsa" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_raw_tlsa \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_raw_tlsa(dane_state_t " s ", dane_query_t * " r ", char *const * " dane_data ", const int * " dane_data_len ", int " secure ", int " bogus ");" +.SH ARGUMENTS +.IP "dane_state_t s" 12 +The DANE state structure +.IP "dane_query_t * r" 12 +A structure to place the result +.IP "char *const * dane_data" 12 +array of DNS rdata items, terminated with a NULL pointer; +caller must guarantee that the referenced data remains +valid until \fBdane_query_deinit()\fP is called. +.IP "const int * dane_data_len" 12 +the length n bytes of the dane_data items +.IP "int secure" 12 +true if the result is validated securely, false if +validation failed or the domain queried has no security info +.IP "int bogus" 12 +if the result was not secure (secure = 0) due to a security failure, +and the result is due to a security failure, bogus is true. +.SH "DESCRIPTION" +This function will fill in the TLSA (DANE) structure from +the given raw DNS record data. The \fIdane_data\fP must be valid +during the lifetime of the query. +.SH "RETURNS" +On success, \fBDANE_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_state_deinit.3 b/doc/manpages/dane_state_deinit.3 new file mode 100644 index 0000000..18451ce --- /dev/null +++ b/doc/manpages/dane_state_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_state_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_state_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "void dane_state_deinit(dane_state_t " s ");" +.SH ARGUMENTS +.IP "dane_state_t s" 12 +The structure to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a DANE query structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_state_init.3 b/doc/manpages/dane_state_init.3 new file mode 100644 index 0000000..9aedb98 --- /dev/null +++ b/doc/manpages/dane_state_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_state_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_state_init \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_state_init(dane_state_t * " s ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "dane_state_t * s" 12 +The structure to be initialized +.IP "unsigned int flags" 12 +flags from the \fBdane_state_flags\fP enumeration +.SH "DESCRIPTION" +This function will initialize the backend resolver. It is +intended to be used in scenarios where multiple resolvings +occur, to optimize against multiple re\-initializations. +.SH "RETURNS" +On success, \fBDANE_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_state_set_dlv_file.3 b/doc/manpages/dane_state_set_dlv_file.3 new file mode 100644 index 0000000..1869ea1 --- /dev/null +++ b/doc/manpages/dane_state_set_dlv_file.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_state_set_dlv_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_state_set_dlv_file \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_state_set_dlv_file(dane_state_t " s ", const char * " file ");" +.SH ARGUMENTS +.IP "dane_state_t s" 12 +The structure to be deinitialized +.IP "const char * file" 12 +The file holding the DLV keys. +.SH "DESCRIPTION" +This function will set a file with trusted keys +for DLV (DNSSEC Lookaside Validation). +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_strerror.3 b/doc/manpages/dane_strerror.3 new file mode 100644 index 0000000..11a5de1 --- /dev/null +++ b/doc/manpages/dane_strerror.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_strerror" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_strerror \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "const char * dane_strerror(int " error ");" +.SH ARGUMENTS +.IP "int error" 12 +is a DANE error code, a negative error code +.SH "DESCRIPTION" +This function is similar to strerror. The difference is that it +accepts an error number returned by a gnutls function; In case of +an unknown error a descriptive string is sent instead of \fBNULL\fP. + +Error codes are always a negative error code. +.SH "RETURNS" +A string explaining the DANE error message. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_verification_status_print.3 b/doc/manpages/dane_verification_status_print.3 new file mode 100644 index 0000000..947e56f --- /dev/null +++ b/doc/manpages/dane_verification_status_print.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_verification_status_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_verification_status_print \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_verification_status_print(unsigned int " status ", gnutls_datum_t * " out ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "unsigned int status" 12 +The status flags to be printed +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with (0) terminated string. +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will pretty print the status of a verification +process \-\- eg. the one obtained by \fBdane_verify_crt()\fP. + +The output \fIout\fP needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_verify_crt.3 b/doc/manpages/dane_verify_crt.3 new file mode 100644 index 0000000..91f7521 --- /dev/null +++ b/doc/manpages/dane_verify_crt.3 @@ -0,0 +1,72 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_verify_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_verify_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_verify_crt(dane_state_t " s ", const gnutls_datum_t * " chain ", unsigned " chain_size ", gnutls_certificate_type_t " chain_type ", const char * " hostname ", const char * " proto ", unsigned int " port ", unsigned int " sflags ", unsigned int " vflags ", unsigned int * " verify ");" +.SH ARGUMENTS +.IP "dane_state_t s" 12 +A DANE state structure (may be NULL) +.IP "const gnutls_datum_t * chain" 12 +A certificate chain +.IP "unsigned chain_size" 12 +The size of the chain +.IP "gnutls_certificate_type_t chain_type" 12 +The type of the certificate chain +.IP "const char * hostname" 12 +The hostname associated with the chain +.IP "const char * proto" 12 +The protocol of the service connecting (e.g. tcp) +.IP "unsigned int port" 12 +The port of the service connecting (e.g. 443) +.IP "unsigned int sflags" 12 +Flags for the initialization of \fIs\fP (if NULL) +.IP "unsigned int vflags" 12 +Verification flags; an OR'ed list of \fBdane_verify_flags_t\fP. +.IP "unsigned int * verify" 12 +An OR'ed list of \fBdane_verify_status_t\fP. +.SH "DESCRIPTION" +This function will verify the given certificate chain against the +CA constrains and/or the certificate available via DANE. +If no information via DANE can be obtained the flag \fBDANE_VERIFY_NO_DANE_INFO\fP +is set. If a DNSSEC signature is not available for the DANE +record then the verify flag \fBDANE_VERIFY_NO_DNSSEC_DATA\fP is set. + +Due to the many possible options of DANE, there is no single threat +model countered. When notifying the user about DANE verification results +it may be better to mention: DANE verification did not reject the certificate, +rather than mentioning a successful DANE verication. + +Note that this function is designed to be run in addition to +PKIX \- certificate chain \- verification. To be run independently +the \fBDANE_VFLAG_ONLY_CHECK_EE_USAGE\fP flag should be specified; +then the function will check whether the key of the peer matches the +key advertized in the DANE entry. +.SH "RETURNS" +a negative error code on error and \fBDANE_E_SUCCESS\fP (0) +when the DANE entries were successfully parsed, irrespective of +whether they were verified (see \fIverify\fP for that information). If +no usable entries were encountered \fBDANE_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_verify_crt_raw.3 b/doc/manpages/dane_verify_crt_raw.3 new file mode 100644 index 0000000..849ce27 --- /dev/null +++ b/doc/manpages/dane_verify_crt_raw.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_verify_crt_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_verify_crt_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_verify_crt_raw(dane_state_t " s ", const gnutls_datum_t * " chain ", unsigned " chain_size ", gnutls_certificate_type_t " chain_type ", dane_query_t " r ", unsigned int " sflags ", unsigned int " vflags ", unsigned int * " verify ");" +.SH ARGUMENTS +.IP "dane_state_t s" 12 +A DANE state structure (may be NULL) +.IP "const gnutls_datum_t * chain" 12 +A certificate chain +.IP "unsigned chain_size" 12 +The size of the chain +.IP "gnutls_certificate_type_t chain_type" 12 +The type of the certificate chain +.IP "dane_query_t r" 12 +DANE data to check against +.IP "unsigned int sflags" 12 +Flags for the initialization of \fIs\fP (if NULL) +.IP "unsigned int vflags" 12 +Verification flags; an OR'ed list of \fBdane_verify_flags_t\fP. +.IP "unsigned int * verify" 12 +An OR'ed list of \fBdane_verify_status_t\fP. +.SH "DESCRIPTION" +This is the low\-level function of \fBdane_verify_crt()\fP. See the +high level function for documentation. + +This function does not perform any resolving, it utilizes +cached entries from \fIr\fP . +.SH "RETURNS" +a negative error code on error and \fBDANE_E_SUCCESS\fP (0) +when the DANE entries were successfully parsed, irrespective of +whether they were verified (see \fIverify\fP for that information). If +no usable entries were encountered \fBDANE_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/dane_verify_session_crt.3 b/doc/manpages/dane_verify_session_crt.3 new file mode 100644 index 0000000..e0b0c14 --- /dev/null +++ b/doc/manpages/dane_verify_session_crt.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "dane_verify_session_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +dane_verify_session_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/dane.h> +.sp +.BI "int dane_verify_session_crt(dane_state_t " s ", gnutls_session_t " session ", const char * " hostname ", const char * " proto ", unsigned int " port ", unsigned int " sflags ", unsigned int " vflags ", unsigned int * " verify ");" +.SH ARGUMENTS +.IP "dane_state_t s" 12 +A DANE state structure (may be NULL) +.IP "gnutls_session_t session" 12 +A gnutls session +.IP "const char * hostname" 12 +The hostname associated with the chain +.IP "const char * proto" 12 +The protocol of the service connecting (e.g. tcp) +.IP "unsigned int port" 12 +The port of the service connecting (e.g. 443) +.IP "unsigned int sflags" 12 +Flags for the initialization of \fIs\fP (if NULL) +.IP "unsigned int vflags" 12 +Verification flags; an OR'ed list of \fBdane_verify_flags_t\fP. +.IP "unsigned int * verify" 12 +An OR'ed list of \fBdane_verify_status_t\fP. +.SH "DESCRIPTION" +This function will verify session's certificate chain against the +CA constrains and/or the certificate available via DANE. +See \fBdane_verify_crt()\fP for more information. + +This will not verify the chain for validity; unless the DANE +verification is restricted to end certificates, this must be +be performed separately using \fBgnutls_certificate_verify_peers3()\fP. +.SH "RETURNS" +a negative error code on error and \fBDANE_E_SUCCESS\fP (0) +when the DANE entries were successfully parsed, irrespective of +whether they were verified (see \fIverify\fP for that information). If +no usable entries were encountered \fBDANE_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/danetool.1 b/doc/manpages/danetool.1 new file mode 100644 index 0000000..933b5bf --- /dev/null +++ b/doc/manpages/danetool.1 @@ -0,0 +1,266 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH danetool 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]danetool\fP +\- GnuTLS DANE tool +.SH SYNOPSIS +\f\*[B-Font]danetool\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +.sp \n(Ppu +.ne 2 + +All arguments must be options. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +Tool to generate and check DNS resource records for the DANE protocol. +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-V\f[], \f\*[B-Font]\-\-verbose\f[] +More verbose output. +.sp +.TP +.NOP \f\*[B-Font]\-\-outfile\f[]=\f\*[I-Font]str\f[] +Output file. +.sp +.TP +.NOP \f\*[B-Font]\-\-load\-pubkey\f[]=\f\*[I-Font]str\f[] +Loads a public key file. +.sp +This can be either a file or a PKCS #11 URL +.TP +.NOP \f\*[B-Font]\-\-load\-certificate\f[]=\f\*[I-Font]str\f[] +Loads a certificate file. +.sp +This can be either a file or a PKCS #11 URL +.TP +.NOP \f\*[B-Font]\-\-dlv\f[]=\f\*[I-Font]str\f[] +Sets a DLV file. +.sp +This sets a DLV file to be used for DNSSEC verification. +.TP +.NOP \f\*[B-Font]\-\-hash\f[]=\f\*[I-Font]str\f[] +Hash algorithm to use for signing. +.sp +Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512. +.TP +.NOP \f\*[B-Font]\-\-check\f[]=\f\*[I-Font]str\f[] +Check a host's DANE TLSA entry. +.sp +Obtains the DANE TLSA entry from the given hostname and prints information. Note that the actual certificate of the host can be provided using \-\-load\-certificate, otherwise danetool will connect to the server to obtain it. The exit code on verification success will be zero. +.TP +.NOP \f\*[B-Font]\-\-check\-ee\f[] +Check only the end-entity's certificate. +.sp +Checks the end\-entity's certificate only. Trust anchors or CAs are not considered. +.TP +.NOP \f\*[B-Font]\-\-check\-ca\f[] +Check only the CA's certificate. +.sp +Checks the trust anchor's and CA's certificate only. End\-entities are not considered. +.TP +.NOP \f\*[B-Font]\-\-tlsa\-rr\f[] +Print the DANE RR data on a certificate or public key. +This option must appear in combination with the following options: +host. +.sp +This command prints the DANE RR data needed to enable DANE on a DNS server. +.TP +.NOP \f\*[B-Font]\-\-host\f[]=\f\*[I-Font]hostname\f[] +Specify the hostname to be used in the DANE RR. +.sp +This command sets the hostname for the DANE RR. +.TP +.NOP \f\*[B-Font]\-\-proto\f[]=\f\*[I-Font]protocol\f[] +The protocol set for DANE data (tcp, udp etc.). +.sp +This command specifies the protocol for the service set in the DANE data. +.TP +.NOP \f\*[B-Font]\-\-port\f[]=\f\*[I-Font]str\f[] +The port or service to connect to, for DANE data. +.sp +.TP +.NOP \f\*[B-Font]\-\-app\-proto\f[] +This is an alias for the \fI--starttls-proto\fR option. +.TP +.NOP \f\*[B-Font]\-\-starttls\-proto\f[]=\f\*[I-Font]str\f[] +The application protocol to be used to obtain the server's certificate (https, ftp, smtp, imap, ldap, xmpp, lmtp, pop3, nntp, sieve, postgres). +.sp +When the server's certificate isn't provided danetool will connect to the server to obtain the certificate. In that case it is required to know the protocol to talk with the server prior to initiating the TLS handshake. +.TP +.NOP \f\*[B-Font]\-\-ca\f[] +Whether the provided certificate or public key is a Certificate Authority. +.sp +Marks the DANE RR as a CA certificate if specified. +.TP +.NOP \f\*[B-Font]\-\-x509\f[] +Use the hash of the X.509 certificate, rather than the public key. +.sp +This option forces the generated record to contain the hash of the full X.509 certificate. By default only the hash of the public key is used. +.TP +.NOP \f\*[B-Font]\-\-local\f[] +This is an alias for the \fI--domain\fR option. +.TP +.NOP \f\*[B-Font]\-\-domain\f[], \f\*[B-Font]\-\-no\-domain\f[] +The provided certificate or public key is issued by the local domain. +The \fIno\-domain\fP form will disable the option. +This option is enabled by default. +.sp +DANE distinguishes certificates and public keys offered via the DNSSEC to trusted and local entities. This flag indicates that this is a domain\-issued certificate, meaning that there could be no CA involved. +.TP +.NOP \f\*[B-Font]\-\-local\-dns\f[], \f\*[B-Font]\-\-no\-local\-dns\f[] +Use the local DNS server for DNSSEC resolving. +The \fIno\-local\-dns\fP form will disable the option. +.sp +This option will use the local DNS server for DNSSEC. +This is disabled by default due to many servers not allowing DNSSEC. +.TP +.NOP \f\*[B-Font]\-\-insecure\f[] +Do not verify any DNSSEC signature. +.sp +Ignores any DNSSEC signature verification results. +.TP +.NOP \f\*[B-Font]\-\-inder\f[], \f\*[B-Font]\-\-no\-inder\f[] +Use DER format for input certificates and private keys. +The \fIno\-inder\fP form will disable the option. +.sp +The input files will be assumed to be in DER or RAW format. +Unlike options that in PEM input would allow multiple input data (e.g. multiple +certificates), when reading in DER format a single data structure is read. +.TP +.NOP \f\*[B-Font]\-\-inraw\f[] +This is an alias for the \fI--inder\fR option. +.TP +.NOP \f\*[B-Font]\-\-print\-raw\f[], \f\*[B-Font]\-\-no\-print\-raw\f[] +Print the received DANE data in raw format. +The \fIno\-print\-raw\fP form will disable the option. +.sp +This option will print the received DANE data. +.TP +.NOP \f\*[B-Font]\-\-quiet\f[] +Suppress several informational messages. +.sp +In that case on the exit code can be used as an indication of verification success +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.sp +.SH EXAMPLES +.br +\fBDANE TLSA RR generation\fP +.br +.sp +To create a DANE TLSA resource record for a certificate (or public key) +that was issued localy and may or may not be signed by a CA use the following command. +.br +.in +4 +.nf +$ danetool \-\-tlsa\-rr \-\-host www.example.com \-\-load\-certificate cert.pem +.in -4 +.fi +.sp +To create a DANE TLSA resource record for a CA signed certificate, which will +be marked as such use the following command. +.br +.in +4 +.nf +$ danetool \-\-tlsa\-rr \-\-host www.example.com \-\-load\-certificate cert.pem \ + \-\-no\-domain +.in -4 +.fi +.sp +The former is useful to add in your DNS entry even if your certificate is signed +by a CA. That way even users who do not trust your CA will be able to verify your +certificate using DANE. +.sp +In order to create a record for the CA signer of your certificate use the following. +.br +.in +4 +.nf +$ danetool \-\-tlsa\-rr \-\-host www.example.com \-\-load\-certificate cert.pem \ + \-\-ca \-\-no\-domain +.in -4 +.fi +.sp +To read a server's DANE TLSA entry, use: +.br +.in +4 +.nf +$ danetool \-\-check www.example.com \-\-proto tcp \-\-port 443 +.in -4 +.fi +.sp +To verify an HTTPS server's DANE TLSA entry, use: +.br +.in +4 +.nf +$ danetool \-\-check www.example.com \-\-proto tcp \-\-port 443 \-\-load\-certificate chain.pem +.in -4 +.fi +.sp +To verify an SMTP server's DANE TLSA entry, use: +.br +.in +4 +.nf +$ danetool \-\-check www.example.com \-\-proto tcp \-\-starttls\-proto=smtp \-\-load\-certificate chain.pem +.in -4 +.fi +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +certtool (1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org diff --git a/doc/manpages/gnutls-cli-debug.1 b/doc/manpages/gnutls-cli-debug.1 new file mode 100644 index 0000000..a6c3f20 --- /dev/null +++ b/doc/manpages/gnutls-cli-debug.1 @@ -0,0 +1,174 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH gnutls-cli-debug 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]gnutls-cli-debug\fP +\- GnuTLS debug client +.SH SYNOPSIS +\f\*[B-Font]gnutls-cli-debug\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +[hostname] +.sp \n(Ppu +.ne 2 + +Operands and options may be intermixed. They will be reordered. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +TLS debug client. It sets up multiple TLS connections to +a server and queries its capabilities. It was created to assist in debugging +GnuTLS, but it might be useful to extract a TLS server's capabilities. +It connects to a TLS server, performs tests and print the server's +capabilities. If called with the `-V' parameter more checks will be performed. +Can be used to check for servers with special needs or bugs. +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-V\f[], \f\*[B-Font]\-\-verbose\f[] +More verbose output. +.sp +.TP +.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-port\f[]=\f\*[I-Font]num\f[] +The port to connect to. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 65536 +.fi +.in -4 +.sp +.TP +.NOP \f\*[B-Font]\-\-app\-proto\f[] +This is an alias for the \fI--starttls-proto\fR option. +.TP +.NOP \f\*[B-Font]\-\-starttls\-proto\f[]=\f\*[I-Font]str\f[] +The application protocol to be used to obtain the server's certificate (https, ftp, smtp, imap, ldap, xmpp, lmtp, pop3, nntp, sieve, postgres). +.sp +Specify the application layer protocol for STARTTLS. If the protocol is supported, gnutls\-cli will proceed to the TLS negotiation. +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.sp +.SH EXAMPLES +.br +.in +4 +.nf +$ gnutls\-cli\-debug localhost +GnuTLS debug client 3.5.0 +Checking localhost:443 + for SSL 3.0 (RFC6101) support... yes + whether we need to disable TLS 1.2... no + whether we need to disable TLS 1.1... no + whether we need to disable TLS 1.0... no + whether %NO_EXTENSIONS is required... no + whether %COMPAT is required... no + for TLS 1.0 (RFC2246) support... yes + for TLS 1.1 (RFC4346) support... yes + for TLS 1.2 (RFC5246) support... yes + fallback from TLS 1.6 to... TLS1.2 + for RFC7507 inappropriate fallback... yes + for HTTPS server name... Local + for certificate chain order... sorted + for safe renegotiation (RFC5746) support... yes + for Safe renegotiation support (SCSV)... no + for encrypt\-then\-MAC (RFC7366) support... no + for ext master secret (RFC7627) support... no + for heartbeat (RFC6520) support... no + for version rollback bug in RSA PMS... dunno + for version rollback bug in Client Hello... no + whether the server ignores the RSA PMS version... yes +whether small records (512 bytes) are tolerated on handshake... yes + whether cipher suites not in SSL 3.0 spec are accepted... yes +whether a bogus TLS record version in the client hello is accepted... yes + whether the server understands TLS closure alerts... partially + whether the server supports session resumption... yes + for anonymous authentication support... no + for ephemeral Diffie\-Hellman support... no + for ephemeral EC Diffie\-Hellman support... yes + ephemeral EC Diffie\-Hellman group info... SECP256R1 + for AES\-128\-GCM cipher (RFC5288) support... yes + for AES\-128\-CCM cipher (RFC6655) support... no + for AES\-128\-CCM\-8 cipher (RFC6655) support... no + for AES\-128\-CBC cipher (RFC3268) support... yes + for CAMELLIA\-128\-GCM cipher (RFC6367) support... no + for CAMELLIA\-128\-CBC cipher (RFC5932) support... no + for 3DES\-CBC cipher (RFC2246) support... yes + for ARCFOUR 128 cipher (RFC2246) support... yes + for MD5 MAC support... yes + for SHA1 MAC support... yes + for SHA256 MAC support... yes + for ZLIB compression support... no + for max record size (RFC6066) support... no + for OCSP status response (RFC6066) support... no + for OpenPGP authentication (RFC6091) support... no +.in -4 +.fi +.sp +You could also use the client to debug services with starttls capability. +.br +.in +4 +.nf +$ gnutls\-cli\-debug \-\-starttls\-proto smtp \-\-port 25 localhost +.in -4 +.fi +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +gnutls\-cli(1), gnutls\-serv(1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org diff --git a/doc/manpages/gnutls-cli.1 b/doc/manpages/gnutls-cli.1 new file mode 100644 index 0000000..1a96804 --- /dev/null +++ b/doc/manpages/gnutls-cli.1 @@ -0,0 +1,580 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH gnutls-cli 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]gnutls-cli\fP +\- GnuTLS client +.SH SYNOPSIS +\f\*[B-Font]gnutls-cli\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +[hostname] +.sp \n(Ppu +.ne 2 + +Operands and options may be intermixed. They will be reordered. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +Simple client program to set up a TLS connection to some other computer. +It sets up a TLS connection and forwards data from the standard input to the secured socket and vice versa. +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-V\f[], \f\*[B-Font]\-\-verbose\f[] +More verbose output. +.sp +.TP +.NOP \f\*[B-Font]\-\-tofu\f[], \f\*[B-Font]\-\-no\-tofu\f[] +Enable trust on first use authentication. +The \fIno\-tofu\fP form will disable the option. +.sp +This option will, in addition to certificate authentication, perform authentication +based on previously seen public keys, a model similar to SSH authentication. Note that when tofu +is specified (PKI) and DANE authentication will become advisory to assist the public key acceptance +process. +.TP +.NOP \f\*[B-Font]\-\-strict\-tofu\f[], \f\*[B-Font]\-\-no\-strict\-tofu\f[] +Fail to connect if a certificate is unknown or a known certificate has changed. +The \fIno\-strict\-tofu\fP form will disable the option. +.sp +This option will perform authentication as with option \-\-tofu; however, no questions shall be asked whatsoever, neither to accept an unknown certificate nor a changed one. +.TP +.NOP \f\*[B-Font]\-\-dane\f[], \f\*[B-Font]\-\-no\-dane\f[] +Enable DANE certificate verification (DNSSEC). +The \fIno\-dane\fP form will disable the option. +.sp +This option will, in addition to certificate authentication using +the trusted CAs, verify the server certificates using on the DANE information +available via DNSSEC. +.TP +.NOP \f\*[B-Font]\-\-local\-dns\f[], \f\*[B-Font]\-\-no\-local\-dns\f[] +Use the local DNS server for DNSSEC resolving. +The \fIno\-local\-dns\fP form will disable the option. +.sp +This option will use the local DNS server for DNSSEC. +This is disabled by default due to many servers not allowing DNSSEC. +.TP +.NOP \f\*[B-Font]\-\-ca\-verification\f[], \f\*[B-Font]\-\-no\-ca\-verification\f[] +Enable CA certificate verification. +The \fIno\-ca\-verification\fP form will disable the option. +This option is enabled by default. +.sp +This option can be used to enable or disable CA certificate verification. It is to be used with the \-\-dane or \-\-tofu options. +.TP +.NOP \f\*[B-Font]\-\-ocsp\f[], \f\*[B-Font]\-\-no\-ocsp\f[] +Enable OCSP certificate verification. +The \fIno\-ocsp\fP form will disable the option. +.sp +This option will enable verification of the peer's certificate using ocsp +.TP +.NOP \f\*[B-Font]\-r\f[], \f\*[B-Font]\-\-resume\f[] +Establish a session and resume. +.sp +Connect, establish a session, reconnect and resume. +.TP +.NOP \f\*[B-Font]\-\-earlydata\f[]=\f\*[I-Font]str\f[] +Send early data on resumption from the specified file. +.sp +.TP +.NOP \f\*[B-Font]\-e\f[], \f\*[B-Font]\-\-rehandshake\f[] +Establish a session and rehandshake. +.sp +Connect, establish a session and rehandshake immediately. +.TP +.NOP \f\*[B-Font]\-\-sni\-hostname\f[]=\f\*[I-Font]str\f[] +Server's hostname for server name indication extension. +.sp +Set explicitly the server name used in the TLS server name indication extension. That is useful when testing with servers setup on different DNS name than the intended. If not specified, the provided hostname is used. Even with this option server certificate verification still uses the hostname passed on the main commandline. Use \-\-verify\-hostname to change this. +.TP +.NOP \f\*[B-Font]\-\-verify\-hostname\f[]=\f\*[I-Font]str\f[] +Server's hostname to use for validation. +.sp +Set explicitly the server name to be used when validating the server's certificate. +.TP +.NOP \f\*[B-Font]\-s\f[], \f\*[B-Font]\-\-starttls\f[] +Connect, establish a plain session and start TLS. +.sp +The TLS session will be initiated when EOF or a SIGALRM is received. +.TP +.NOP \f\*[B-Font]\-\-app\-proto\f[] +This is an alias for the \fI--starttls-proto\fR option. +.TP +.NOP \f\*[B-Font]\-\-starttls\-proto\f[]=\f\*[I-Font]str\f[] +The application protocol to be used to obtain the server's certificate (https, ftp, smtp, imap, ldap, xmpp, lmtp, pop3, nntp, sieve, postgres). +This option must not appear in combination with any of the following options: +starttls. +.sp +Specify the application layer protocol for STARTTLS. If the protocol is supported, gnutls\-cli will proceed to the TLS negotiation. +.TP +.NOP \f\*[B-Font]\-u\f[], \f\*[B-Font]\-\-udp\f[] +Use DTLS (datagram TLS) over UDP. +.sp +.TP +.NOP \f\*[B-Font]\-\-mtu\f[]=\f\*[I-Font]num\f[] +Set MTU for datagram TLS. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 17000 +.fi +.in -4 +.sp +.TP +.NOP \f\*[B-Font]\-\-crlf\f[] +Send CR LF instead of LF. +.sp +.TP +.NOP \f\*[B-Font]\-\-fastopen\f[] +Enable TCP Fast Open. +.sp +.TP +.NOP \f\*[B-Font]\-\-x509fmtder\f[] +Use DER format for certificates to read from. +.sp +.TP +.NOP \f\*[B-Font]\-\-print\-cert\f[] +Print peer's certificate in PEM format. +.sp +.TP +.NOP \f\*[B-Font]\-\-save\-cert\f[]=\f\*[I-Font]str\f[] +Save the peer's certificate chain in the specified file in PEM format. +.sp +.TP +.NOP \f\*[B-Font]\-\-save\-ocsp\f[]=\f\*[I-Font]str\f[] +Save the peer's OCSP status response in the provided file. +This option must not appear in combination with any of the following options: +save-ocsp-multi. +.sp +.TP +.NOP \f\*[B-Font]\-\-save\-ocsp\-multi\f[]=\f\*[I-Font]str\f[] +Save all OCSP responses provided by the peer in this file. +This option must not appear in combination with any of the following options: +save-ocsp. +.sp +The file will contain a list of PEM encoded OCSP status responses if any were provided by the peer, starting with the one for the peer's server certificate. +.TP +.NOP \f\*[B-Font]\-\-save\-server\-trace\f[]=\f\*[I-Font]str\f[] +Save the server-side TLS message trace in the provided file. +.sp +.TP +.NOP \f\*[B-Font]\-\-save\-client\-trace\f[]=\f\*[I-Font]str\f[] +Save the client-side TLS message trace in the provided file. +.sp +.TP +.NOP \f\*[B-Font]\-\-dh\-bits\f[]=\f\*[I-Font]num\f[] +The minimum number of bits allowed for DH. +This option takes an integer number as its argument. +.sp +This option sets the minimum number of bits allowed for a Diffie\-Hellman key exchange. You may want to lower the default value if the peer sends a weak prime and you get an connection error with unacceptable prime. +.TP +.NOP \f\*[B-Font]\-\-priority\f[]=\f\*[I-Font]str\f[] +Priorities string. +.sp +TLS algorithms and protocols to enable. You can +use predefined sets of ciphersuites such as PERFORMANCE, +NORMAL, PFS, SECURE128, SECURE256. The default is NORMAL. +.sp +Check the GnuTLS manual on section \(lqPriority strings\(rq for more +information on the allowed keywords +.TP +.NOP \f\*[B-Font]\-\-x509cafile\f[]=\f\*[I-Font]str\f[] +Certificate file or PKCS #11 URL to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-x509crlfile\f[]=\f\*[I-Font]file\f[] +CRL file to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-x509keyfile\f[]=\f\*[I-Font]str\f[] +X.509 key file or PKCS #11 URL to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-x509certfile\f[]=\f\*[I-Font]str\f[] +X.509 Certificate file or PKCS #11 URL to use. +This option must appear in combination with the following options: +x509keyfile. +.sp +.TP +.NOP \f\*[B-Font]\-\-rawpkkeyfile\f[]=\f\*[I-Font]str\f[] +Private key file (PKCS #8 or PKCS #12) or PKCS #11 URL to use. +.sp +In order to instruct the application to negotiate raw public keys one +must enable the respective certificate types via the priority strings (i.e. CTYPE\-CLI\-* +and CTYPE\-SRV\-* flags). +.sp +Check the GnuTLS manual on section \(lqPriority strings\(rq for more +information on how to set certificate types. +.TP +.NOP \f\*[B-Font]\-\-rawpkfile\f[]=\f\*[I-Font]str\f[] +Raw public-key file to use. +This option must appear in combination with the following options: +rawpkkeyfile. +.sp +In order to instruct the application to negotiate raw public keys one +must enable the respective certificate types via the priority strings (i.e. CTYPE\-CLI\-* +and CTYPE\-SRV\-* flags). +.sp +Check the GnuTLS manual on section \(lqPriority strings\(rq for more +information on how to set certificate types. +.TP +.NOP \f\*[B-Font]\-\-srpusername\f[]=\f\*[I-Font]str\f[] +SRP username to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-srppasswd\f[]=\f\*[I-Font]str\f[] +SRP password to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-pskusername\f[]=\f\*[I-Font]str\f[] +PSK username to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-pskkey\f[]=\f\*[I-Font]str\f[] +PSK key (in hex) to use. +.sp +.TP +.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]str\f[], \f\*[B-Font]\-\-port\f[]=\f\*[I-Font]str\f[] +The port or service to connect to. +.sp +.TP +.NOP \f\*[B-Font]\-\-insecure\f[] +Don't abort program if server certificate can't be validated. +.sp +.TP +.NOP \f\*[B-Font]\-\-verify\-allow\-broken\f[] +Allow broken algorithms, such as MD5 for certificate verification. +.sp +.TP +.NOP \f\*[B-Font]\-\-ranges\f[] +Use length-hiding padding to prevent traffic analysis. +.sp +When possible (e.g., when using CBC ciphersuites), use length\-hiding padding to prevent traffic analysis. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-benchmark\-ciphers\f[] +Benchmark individual ciphers. +.sp +By default the benchmarked ciphers will utilize any capabilities of the local CPU to improve performance. To test against the raw software implementation set the environment variable GNUTLS_CPUID_OVERRIDE to 0x1. +.TP +.NOP \f\*[B-Font]\-\-benchmark\-tls\-kx\f[] +Benchmark TLS key exchange methods. +.sp +.TP +.NOP \f\*[B-Font]\-\-benchmark\-tls\-ciphers\f[] +Benchmark TLS ciphers. +.sp +By default the benchmarked ciphers will utilize any capabilities of the local CPU to improve performance. To test against the raw software implementation set the environment variable GNUTLS_CPUID_OVERRIDE to 0x1. +.TP +.NOP \f\*[B-Font]\-l\f[], \f\*[B-Font]\-\-list\f[] +Print a list of the supported algorithms and modes. +This option must not appear in combination with any of the following options: +port. +.sp +Print a list of the supported algorithms and modes. If a priority string is given then only the enabled ciphersuites are shown. +.TP +.NOP \f\*[B-Font]\-\-priority\-list\f[] +Print a list of the supported priority strings. +.sp +Print a list of the supported priority strings. The ciphersuites corresponding to each priority string can be examined using \-l \-p. +.TP +.NOP \f\*[B-Font]\-\-noticket\f[] +Don't allow session tickets. +.sp +Disable the request of receiving of session tickets under TLS1.2 or earlier +.TP +.NOP \f\*[B-Font]\-\-srtp\-profiles\f[]=\f\*[I-Font]str\f[] +Offer SRTP profiles. +.sp +.TP +.NOP \f\*[B-Font]\-\-alpn\f[]=\f\*[I-Font]str\f[] +Application layer protocol. +This option may appear an unlimited number of times. +.sp +This option will set and enable the Application Layer Protocol Negotiation (ALPN) in the TLS protocol. +.TP +.NOP \f\*[B-Font]\-\-compress\-cert\f[]=\f\*[I-Font]str\f[] +Compress certificate. +This option may appear an unlimited number of times. +.sp +This option sets a supported compression method for certificate compression. +.TP +.NOP \f\*[B-Font]\-b\f[], \f\*[B-Font]\-\-heartbeat\f[] +Activate heartbeat support. +.sp +.TP +.NOP \f\*[B-Font]\-\-recordsize\f[]=\f\*[I-Font]num\f[] +The maximum record size to advertise. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 4096 +.fi +.in -4 +.sp +.TP +.NOP \f\*[B-Font]\-\-disable\-sni\f[] +Do not send a Server Name Indication (SNI). +.sp +.TP +.NOP \f\*[B-Font]\-\-disable\-extensions\f[] +Disable all the TLS extensions. +.sp +This option disables all TLS extensions. Deprecated option. Use the priority string. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-single\-key\-share\f[] +Send a single key share under TLS1.3. +.sp +This option switches the default mode of sending multiple +key shares, to send a single one (the top one). +.TP +.NOP \f\*[B-Font]\-\-post\-handshake\-auth\f[] +Enable post-handshake authentication under TLS1.3. +.sp +This option enables post\-handshake authentication when under TLS1.3. +.TP +.NOP \f\*[B-Font]\-\-inline\-commands\f[] +Inline commands of the form ^<cmd>^. +.sp +Enable inline commands of the form ^<cmd>^. The inline commands are expected to be in a line by themselves. The available commands are: resume, rekey1 (local rekey), rekey (rekey on both peers) and renegotiate. +.TP +.NOP \f\*[B-Font]\-\-inline\-commands\-prefix\f[]=\f\*[I-Font]str\f[] +Change the default delimiter for inline commands. +.sp +Change the default delimiter (^) used for inline commands. The delimiter is expected to be a single US\-ASCII character (octets 0 \- 127). This option is only relevant if inline commands are enabled via the inline\-commands option +.TP +.NOP \f\*[B-Font]\-\-provider\f[]=\f\*[I-Font]file\f[] +Specify the PKCS #11 provider library. +.sp +This will override the default options in /etc/gnutls/pkcs11.conf +.TP +.NOP \f\*[B-Font]\-\-fips140\-mode\f[] +Reports the status of the FIPS140-2 mode in gnutls library. +.sp +.TP +.NOP \f\*[B-Font]\-\-list\-config\f[] +Reports the configuration of the library. +.sp +.TP +.NOP \f\*[B-Font]\-\-logfile\f[]=\f\*[I-Font]str\f[] +Redirect informational messages to a specific file. +.sp +Redirect informational messages to a specific file. The file may be /dev/null also to make the gnutls client quiet to use it in piped server connections where only the server communication may appear on stdout. +.TP +.NOP \f\*[B-Font]\-\-keymatexport\f[]=\f\*[I-Font]str\f[] +Label used for exporting keying material. +.sp +.TP +.NOP \f\*[B-Font]\-\-keymatexportsize\f[]=\f\*[I-Font]num\f[] +Size of the exported keying material. +This option takes an integer number as its argument. +.sp +.TP +.NOP \f\*[B-Font]\-\-waitresumption\f[] +Block waiting for the resumption data under TLS1.3. +.sp +This option makes the client to block waiting for the resumption data under TLS1.3. The option has effect only when \-\-resume is provided. +.TP +.NOP \f\*[B-Font]\-\-ca\-auto\-retrieve\f[], \f\*[B-Font]\-\-no\-ca\-auto\-retrieve\f[] +Enable automatic retrieval of missing CA certificates. +The \fIno\-ca\-auto\-retrieve\fP form will disable the option. +.sp +This option enables the client to automatically retrieve the missing intermediate CA certificates in the certificate chain, based on the Authority Information Access (AIA) extension. +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.sp +.SH EXAMPLES +.br +\fBConnecting using PSK authentication\fP +.br +To connect to a server using PSK authentication, you need to enable the choice of PSK by using a cipher priority parameter such as in the example below. +.br +.in +4 +.nf +$ ./gnutls\-cli \-p 5556 localhost \-\-pskusername psk_identity \ + \-\-pskkey 88f3824b3e5659f52d00e959bacab954b6540344 \ + \-\-priority NORMAL:\-KX\-ALL:+ECDHE\-PSK:+DHE\-PSK:+PSK +Resolving 'localhost'... +Connecting to '127.0.0.1:5556'... +\- PSK authentication. +\- Version: TLS1.1 +\- Key Exchange: PSK +\- Cipher: AES\-128\-CBC +\- MAC: SHA1 +\- Compression: NULL +\- Handshake was completed + +\- Simple Client Mode: +.in -4 +.fi +By keeping the \-\-pskusername parameter and removing the \-\-pskkey parameter, it will query only for the password during the handshake. +.sp +.br +\fBConnecting using raw public\-key authentication\fP +.br +To connect to a server using raw public\-key authentication, you need to enable the option to negotiate raw public\-keys via the priority strings such as in the example below. +.br +.in +4 +.nf +$ ./gnutls\-cli \-p 5556 localhost \-\-priority NORMAL:\-CTYPE\-CLI\-ALL:+CTYPE\-CLI\-RAWPK \ + \-\-rawpkkeyfile cli.key.pem \ + \-\-rawpkfile cli.rawpk.pem +Processed 1 client raw public key pair... +Resolving 'localhost'... +Connecting to '127.0.0.1:5556'... +\- Successfully sent 1 certificate(s) to server. +\- Server has requested a certificate. +\- Certificate type: X.509 +\- Got a certificate list of 1 certificates. +\- Certificate[0] info: + \- skipped +\- Description: (TLS1.3\-Raw Public Key\-X.509)\-(ECDHE\-SECP256R1)\-(RSA\-PSS\-RSAE\-SHA256)\-(AES\-256\-GCM) +\- Options: +\- Handshake was completed + +\- Simple Client Mode: +.in -4 +.fi +.sp +.br +\fBConnecting to STARTTLS services\fP +.br +.sp +You could also use the client to connect to services with starttls capability. +.br +.in +4 +.nf +$ gnutls\-cli \-\-starttls\-proto smtp \-\-port 25 localhost +.in -4 +.fi +.sp +.br +\fBListing ciphersuites in a priority string\fP +.br +To list the ciphersuites in a priority string: +.br +.in +4 +.nf +$ ./gnutls\-cli \-\-priority SECURE192 \-l +Cipher suites for SECURE192 +TLS_ECDHE_ECDSA_AES_256_CBC_SHA384 0xc0, 0x24 TLS1.2 +TLS_ECDHE_ECDSA_AES_256_GCM_SHA384 0xc0, 0x2e TLS1.2 +TLS_ECDHE_RSA_AES_256_GCM_SHA384 0xc0, 0x30 TLS1.2 +TLS_DHE_RSA_AES_256_CBC_SHA256 0x00, 0x6b TLS1.2 +TLS_DHE_DSS_AES_256_CBC_SHA256 0x00, 0x6a TLS1.2 +TLS_RSA_AES_256_CBC_SHA256 0x00, 0x3d TLS1.2 +.sp +Certificate types: CTYPE\-X.509 +Protocols: VERS\-TLS1.2, VERS\-TLS1.1, VERS\-TLS1.0, VERS\-SSL3.0, VERS\-DTLS1.0 +Compression: COMP\-NULL +Elliptic curves: CURVE\-SECP384R1, CURVE\-SECP521R1 +PK\-signatures: SIGN\-RSA\-SHA384, SIGN\-ECDSA\-SHA384, SIGN\-RSA\-SHA512, SIGN\-ECDSA\-SHA512 +.in -4 +.fi +.sp +.br +\fBConnecting using a PKCS #11 token\fP +.br +To connect to a server using a certificate and a private key present in a PKCS #11 token you +need to substitute the PKCS 11 URLs in the x509certfile and x509keyfile parameters. +.sp +Those can be found using "p11tool \-\-list\-tokens" and then listing all the objects in the +needed token, and using the appropriate. +.br +.in +4 +.nf +$ p11tool \-\-list\-tokens +.sp +Token 0: + URL: pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test + Label: Test + Manufacturer: EnterSafe + Model: PKCS15 + Serial: 1234 +.sp +$ p11tool \-\-login \-\-list\-certs "pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test" +.sp +Object 0: + URL: pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test;object=client;type=cert + Type: X.509 Certificate + Label: client + ID: 2a:97:0d:58:d1:51:3c:23:07:ae:4e:0d:72:26:03:7d:99:06:02:6a +.sp +$ MYCERT="pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test;object=client;type=cert" +$ MYKEY="pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test;object=client;type=private" +$ export MYCERT MYKEY +.sp +$ gnutls\-cli www.example.com \-\-x509keyfile $MYKEY \-\-x509certfile $MYCERT +.in -4 +.fi +Notice that the private key only differs from the certificate in the type. +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +gnutls\-cli\-debug(1), gnutls\-serv(1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org diff --git a/doc/manpages/gnutls-serv.1 b/doc/manpages/gnutls-serv.1 new file mode 100644 index 0000000..75c6807 --- /dev/null +++ b/doc/manpages/gnutls-serv.1 @@ -0,0 +1,561 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH gnutls-serv 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]gnutls-serv\fP +\- GnuTLS server +.SH SYNOPSIS +\f\*[B-Font]gnutls-serv\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +.sp \n(Ppu +.ne 2 + +All arguments must be options. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +Server program that listens to incoming TLS connections. +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-\-sni\-hostname\f[]=\f\*[I-Font]str\f[] +Server's hostname for server name extension. +.sp +Server name of type host_name that the server will recognise as its own. If the server receives client hello with different name, it will send a warning\-level unrecognized_name alert. +.TP +.NOP \f\*[B-Font]\-\-sni\-hostname\-fatal\f[] +Send fatal alert on sni-hostname mismatch. +.sp +.TP +.NOP \f\*[B-Font]\-\-alpn\f[]=\f\*[I-Font]str\f[] +Specify ALPN protocol to be enabled by the server. +This option may appear an unlimited number of times. +.sp +Specify the (textual) ALPN protocol for the server to use. +.TP +.NOP \f\*[B-Font]\-\-alpn\-fatal\f[] +Send fatal alert on non-matching ALPN name. +.sp +.TP +.NOP \f\*[B-Font]\-\-noticket\f[] +Don't accept session tickets. +.sp +.TP +.NOP \f\*[B-Font]\-\-earlydata\f[] +Accept early data. +.sp +.TP +.NOP \f\*[B-Font]\-\-maxearlydata\f[]=\f\*[I-Font]num\f[] +The maximum early data size to accept. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 1 through 2147483648 +.fi +.in -4 +.sp +.TP +.NOP \f\*[B-Font]\-\-nocookie\f[] +Don't require cookie on DTLS sessions. +.sp +.TP +.NOP \f\*[B-Font]\-g\f[], \f\*[B-Font]\-\-generate\f[] +Generate Diffie-Hellman parameters. +.sp +.TP +.NOP \f\*[B-Font]\-q\f[], \f\*[B-Font]\-\-quiet\f[] +Suppress some messages. +.sp +.TP +.NOP \f\*[B-Font]\-\-nodb\f[] +Do not use a resumption database. +.sp +.TP +.NOP \f\*[B-Font]\-\-http\f[] +Act as an HTTP server. +.sp +.TP +.NOP \f\*[B-Font]\-\-echo\f[] +Act as an Echo server. +.sp +.TP +.NOP \f\*[B-Font]\-\-crlf\f[] +Do not replace CRLF by LF in Echo server mode. +.sp +.TP +.NOP \f\*[B-Font]\-u\f[], \f\*[B-Font]\-\-udp\f[] +Use DTLS (datagram TLS) over UDP. +.sp +.TP +.NOP \f\*[B-Font]\-\-mtu\f[]=\f\*[I-Font]num\f[] +Set MTU for datagram TLS. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 17000 +.fi +.in -4 +.sp +.TP +.NOP \f\*[B-Font]\-\-srtp\-profiles\f[]=\f\*[I-Font]str\f[] +Offer SRTP profiles. +.sp +.TP +.NOP \f\*[B-Font]\-a\f[], \f\*[B-Font]\-\-disable\-client\-cert\f[] +Do not request a client certificate. +This option must not appear in combination with any of the following options: +require-client-cert. +.sp +.TP +.NOP \f\*[B-Font]\-r\f[], \f\*[B-Font]\-\-require\-client\-cert\f[] +Require a client certificate. +.sp +This option before 3.6.0 used to imply \-\-verify\-client\-cert. +Since 3.6.0 it will no longer verify the certificate by default. +.TP +.NOP \f\*[B-Font]\-\-verify\-client\-cert\f[] +If a client certificate is sent then verify it. +.sp +Do not require, but if a client certificate is sent then verify it and close the connection if invalid. +.TP +.NOP \f\*[B-Font]\-\-compress\-cert\f[]=\f\*[I-Font]str\f[] +Compress certificate. +This option may appear an unlimited number of times. +.sp +This option sets a supported compression method for certificate compression. +.TP +.NOP \f\*[B-Font]\-b\f[], \f\*[B-Font]\-\-heartbeat\f[] +Activate heartbeat support. +.sp +Regularly ping client via heartbeat extension messages +.TP +.NOP \f\*[B-Font]\-\-x509fmtder\f[] +Use DER format for certificates to read from. +.sp +.TP +.NOP \f\*[B-Font]\-\-priority\f[]=\f\*[I-Font]str\f[] +Priorities string. +.sp +TLS algorithms and protocols to enable. You can +use predefined sets of ciphersuites such as PERFORMANCE, +NORMAL, SECURE128, SECURE256. The default is NORMAL. +.sp +Check the GnuTLS manual on section \(lqPriority strings\(rq for more +information on allowed keywords +.TP +.NOP \f\*[B-Font]\-\-dhparams\f[]=\f\*[I-Font]file\f[] +DH params file to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-x509cafile\f[]=\f\*[I-Font]str\f[] +Certificate file or PKCS #11 URL to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-x509crlfile\f[]=\f\*[I-Font]file\f[] +CRL file to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-pgpkeyfile\f[]=\f\*[I-Font]file\f[] +PGP Key file to use. +.sp +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-x509keyfile\f[]=\f\*[I-Font]str\f[] +X.509 key file or PKCS #11 URL to use. +This option may appear an unlimited number of times. +.sp +Specify the private key file or URI to use; it must correspond to +the certificate specified in \-\-x509certfile. Multiple keys and certificates +can be specified with this option and in that case each occurrence of keyfile +must be followed by the corresponding x509certfile or vice\-versa. +.TP +.NOP \f\*[B-Font]\-\-x509certfile\f[]=\f\*[I-Font]str\f[] +X.509 Certificate file or PKCS #11 URL to use. +This option may appear an unlimited number of times. +.sp +Specify the certificate file or URI to use; it must correspond to +the key specified in \-\-x509keyfile. Multiple keys and certificates +can be specified with this option and in that case each occurrence of keyfile +must be followed by the corresponding x509certfile or vice\-versa. +.TP +.NOP \f\*[B-Font]\-\-x509dsakeyfile\f[] +This is an alias for the \fI--x509keyfile\fR option. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-x509dsacertfile\f[] +This is an alias for the \fI--x509certfile\fR option. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-x509ecckeyfile\f[] +This is an alias for the \fI--x509keyfile\fR option. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-x509ecccertfile\f[] +This is an alias for the \fI--x509certfile\fR option. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-rawpkkeyfile\f[]=\f\*[I-Font]str\f[] +Private key file (PKCS #8 or PKCS #12) or PKCS #11 URL to use. +This option may appear an unlimited number of times. +.sp +Specify the private key file or URI to use; it must correspond to +the raw public\-key specified in \-\-rawpkfile. Multiple key pairs +can be specified with this option and in that case each occurrence of keyfile +must be followed by the corresponding rawpkfile or vice\-versa. +.sp +In order to instruct the application to negotiate raw public keys one +must enable the respective certificate types via the priority strings (i.e. CTYPE\-CLI\-* +and CTYPE\-SRV\-* flags). +.sp +Check the GnuTLS manual on section \(lqPriority strings\(rq for more +information on how to set certificate types. +.TP +.NOP \f\*[B-Font]\-\-rawpkfile\f[]=\f\*[I-Font]str\f[] +Raw public-key file to use. +This option may appear an unlimited number of times. +This option must appear in combination with the following options: +rawpkkeyfile. +.sp +Specify the raw public\-key file to use; it must correspond to +the private key specified in \-\-rawpkkeyfile. Multiple key pairs +can be specified with this option and in that case each occurrence of keyfile +must be followed by the corresponding rawpkfile or vice\-versa. +.sp +In order to instruct the application to negotiate raw public keys one +must enable the respective certificate types via the priority strings (i.e. CTYPE\-CLI\-* +and CTYPE\-SRV\-* flags). +.sp +Check the GnuTLS manual on section \(lqPriority strings\(rq for more +information on how to set certificate types. +.TP +.NOP \f\*[B-Font]\-\-srppasswd\f[]=\f\*[I-Font]file\f[] +SRP password file to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-srppasswdconf\f[]=\f\*[I-Font]file\f[] +SRP password configuration file to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-pskpasswd\f[]=\f\*[I-Font]file\f[] +PSK password file to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-pskhint\f[]=\f\*[I-Font]str\f[] +PSK identity hint to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-ocsp\-response\f[]=\f\*[I-Font]str\f[] +The OCSP response to send to client. +This option may appear an unlimited number of times. +.sp +If the client requested an OCSP response, return data from this file to the client. +.TP +.NOP \f\*[B-Font]\-\-ignore\-ocsp\-response\-errors\f[] +Ignore any errors when setting the OCSP response. +.sp +That option instructs gnutls to not attempt to match the provided OCSP responses with the certificates. +.TP +.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-port\f[]=\f\*[I-Font]num\f[] +The port to connect to. +This option takes an integer number as its argument. +.sp +.TP +.NOP \f\*[B-Font]\-l\f[], \f\*[B-Font]\-\-list\f[] +Print a list of the supported algorithms and modes. +.sp +Print a list of the supported algorithms and modes. If a priority string is given then only the enabled ciphersuites are shown. +.TP +.NOP \f\*[B-Font]\-\-provider\f[]=\f\*[I-Font]file\f[] +Specify the PKCS #11 provider library. +.sp +This will override the default options in /etc/gnutls/pkcs11.conf +.TP +.NOP \f\*[B-Font]\-\-keymatexport\f[]=\f\*[I-Font]str\f[] +Label used for exporting keying material. +.sp +.TP +.NOP \f\*[B-Font]\-\-keymatexportsize\f[]=\f\*[I-Font]num\f[] +Size of the exported keying material. +This option takes an integer number as its argument. +.sp +.TP +.NOP \f\*[B-Font]\-\-recordsize\f[]=\f\*[I-Font]num\f[] +The maximum record size to advertise. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 16384 +.fi +.in -4 +.sp +.TP +.NOP \f\*[B-Font]\-\-httpdata\f[]=\f\*[I-Font]file\f[] +The data used as HTTP response. +.sp +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.sp +.SH EXAMPLES +Running your own TLS server based on GnuTLS can be useful when +debugging clients and/or GnuTLS itself. This section describes how to +use \fBgnutls\-serv\fP as a simple HTTPS server. +.sp +The most basic server can be started as: +.sp +.br +.in +4 +.nf +gnutls\-serv \-\-http \-\-priority "NORMAL:+ANON\-ECDH:+ANON\-DH" +.in -4 +.fi +.sp +It will only support anonymous ciphersuites, which many TLS clients +refuse to use. +.sp +The next step is to add support for X.509. First we generate a CA: +.sp +.br +.in +4 +.nf +$ certtool \-\-generate\-privkey > x509\-ca\-key.pem +$ echo 'cn = GnuTLS test CA' > ca.tmpl +$ echo 'ca' >> ca.tmpl +$ echo 'cert_signing_key' >> ca.tmpl +$ certtool \-\-generate\-self\-signed \-\-load\-privkey x509\-ca\-key.pem \ + \-\-template ca.tmpl \-\-outfile x509\-ca.pem +.in -4 +.fi +.sp +Then generate a server certificate. Remember to change the dns_name +value to the name of your server host, or skip that command to avoid +the field. +.sp +.br +.in +4 +.nf +$ certtool \-\-generate\-privkey > x509\-server\-key.pem +$ echo 'organization = GnuTLS test server' > server.tmpl +$ echo 'cn = test.gnutls.org' >> server.tmpl +$ echo 'tls_www_server' >> server.tmpl +$ echo 'encryption_key' >> server.tmpl +$ echo 'signing_key' >> server.tmpl +$ echo 'dns_name = test.gnutls.org' >> server.tmpl +$ certtool \-\-generate\-certificate \-\-load\-privkey x509\-server\-key.pem \ + \-\-load\-ca\-certificate x509\-ca.pem \-\-load\-ca\-privkey x509\-ca\-key.pem \ + \-\-template server.tmpl \-\-outfile x509\-server.pem +.in -4 +.fi +.sp +For use in the client, you may want to generate a client certificate +as well. +.sp +.br +.in +4 +.nf +$ certtool \-\-generate\-privkey > x509\-client\-key.pem +$ echo 'cn = GnuTLS test client' > client.tmpl +$ echo 'tls_www_client' >> client.tmpl +$ echo 'encryption_key' >> client.tmpl +$ echo 'signing_key' >> client.tmpl +$ certtool \-\-generate\-certificate \-\-load\-privkey x509\-client\-key.pem \ + \-\-load\-ca\-certificate x509\-ca.pem \-\-load\-ca\-privkey x509\-ca\-key.pem \ + \-\-template client.tmpl \-\-outfile x509\-client.pem +.in -4 +.fi +.sp +To be able to import the client key/certificate into some +applications, you will need to convert them into a PKCS#12 structure. +This also encrypts the security sensitive key with a password. +.sp +.br +.in +4 +.nf +$ certtool \-\-to\-p12 \-\-load\-ca\-certificate x509\-ca.pem \ + \-\-load\-privkey x509\-client\-key.pem \-\-load\-certificate x509\-client.pem \ + \-\-outder \-\-outfile x509\-client.p12 +.in -4 +.fi +.sp +For icing, we'll create a proxy certificate for the client too. +.sp +.br +.in +4 +.nf +$ certtool \-\-generate\-privkey > x509\-proxy\-key.pem +$ echo 'cn = GnuTLS test client proxy' > proxy.tmpl +$ certtool \-\-generate\-proxy \-\-load\-privkey x509\-proxy\-key.pem \ + \-\-load\-ca\-certificate x509\-client.pem \-\-load\-ca\-privkey x509\-client\-key.pem \ + \-\-load\-certificate x509\-client.pem \-\-template proxy.tmpl \ + \-\-outfile x509\-proxy.pem +.in -4 +.fi +.sp +Then start the server again: +.sp +.br +.in +4 +.nf +$ gnutls\-serv \-\-http \ + \-\-x509cafile x509\-ca.pem \ + \-\-x509keyfile x509\-server\-key.pem \ + \-\-x509certfile x509\-server.pem +.in -4 +.fi +.sp +Try connecting to the server using your web browser. Note that the +server listens to port 5556 by default. +.sp +While you are at it, to allow connections using ECDSA, you can also +create a ECDSA key and certificate for the server. These credentials +will be used in the final example below. +.sp +.br +.in +4 +.nf +$ certtool \-\-generate\-privkey \-\-ecdsa > x509\-server\-key\-ecc.pem +$ certtool \-\-generate\-certificate \-\-load\-privkey x509\-server\-key\-ecc.pem \ + \-\-load\-ca\-certificate x509\-ca.pem \-\-load\-ca\-privkey x509\-ca\-key.pem \ + \-\-template server.tmpl \-\-outfile x509\-server\-ecc.pem +.in -4 +.fi +.sp +.sp +The next step is to add support for SRP authentication. This requires +an SRP password file created with \fBsrptool\fP. +To start the server with SRP support: +.sp +.br +.in +4 +.nf +gnutls\-serv \-\-http \-\-priority NORMAL:+SRP\-RSA:+SRP \ + \-\-srppasswdconf srp\-tpasswd.conf \ + \-\-srppasswd srp\-passwd.txt +.in -4 +.fi +.sp +Let's also start a server with support for PSK. This would require +a password file created with \fBpsktool\fP. +.sp +.br +.in +4 +.nf +gnutls\-serv \-\-http \-\-priority NORMAL:+ECDHE\-PSK:+PSK \ + \-\-pskpasswd psk\-passwd.txt +.in -4 +.fi +.sp +If you want a server with support for raw public\-keys we can also add these +credentials. Note however that there is no identity information linked to these +keys as is the case with regular x509 certificates. Authentication must be done +via different means. Also we need to explicitly enable raw public\-key certificates +via the priority strings. +.sp +.br +.in +4 +.nf +gnutls\-serv \-\-http \-\-priority NORMAL:+CTYPE\-CLI\-RAWPK:+CTYPE\-SRV\-RAWPK \ + \-\-rawpkfile srv.rawpk.pem \ + \-\-rawpkkeyfile srv.key.pem +.in -4 +.fi +.sp +.sp +Finally, we start the server with all the earlier parameters and you +get this command: +.sp +.br +.in +4 +.nf +gnutls\-serv \-\-http \-\-priority NORMAL:+PSK:+SRP:+CTYPE\-CLI\-RAWPK:+CTYPE\-SRV\-RAWPK \ + \-\-x509cafile x509\-ca.pem \ + \-\-x509keyfile x509\-server\-key.pem \ + \-\-x509certfile x509\-server.pem \ + \-\-x509keyfile x509\-server\-key\-ecc.pem \ + \-\-x509certfile x509\-server\-ecc.pem \ + \-\-srppasswdconf srp\-tpasswd.conf \ + \-\-srppasswd srp\-passwd.txt \ + \-\-pskpasswd psk\-passwd.txt \ + \-\-rawpkfile srv.rawpk.pem \ + \-\-rawpkkeyfile srv.key.pem +.in -4 +.fi +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +gnutls\-cli\-debug(1), gnutls\-cli(1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org diff --git a/doc/manpages/gnutls_aead_cipher_decrypt.3 b/doc/manpages/gnutls_aead_cipher_decrypt.3 new file mode 100644 index 0000000..a50b819 --- /dev/null +++ b/doc/manpages/gnutls_aead_cipher_decrypt.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_aead_cipher_decrypt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_aead_cipher_decrypt \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_aead_cipher_decrypt(gnutls_aead_cipher_hd_t " handle ", const void * " nonce ", size_t " nonce_len ", const void * " auth ", size_t " auth_len ", size_t " tag_size ", const void * " ctext ", size_t " ctext_len ", void * " ptext ", size_t * " ptext_len ");" +.SH ARGUMENTS +.IP "gnutls_aead_cipher_hd_t handle" 12 +is a \fBgnutls_aead_cipher_hd_t\fP type. +.IP "const void * nonce" 12 +the nonce to set +.IP "size_t nonce_len" 12 +The length of the nonce +.IP "const void * auth" 12 +additional data to be authenticated +.IP "size_t auth_len" 12 +The length of the data +.IP "size_t tag_size" 12 +The size of the tag to use (use zero for the default) +.IP "const void * ctext" 12 +the data to decrypt (including the authentication tag) +.IP "size_t ctext_len" 12 +the length of data to decrypt (includes tag size) +.IP "void * ptext" 12 +the decrypted data +.IP "size_t * ptext_len" 12 +the length of decrypted data (initially must hold the maximum available size) +.SH "DESCRIPTION" +This function will decrypt the given data using the algorithm +specified by the context. This function must be provided the complete +data to be decrypted, including the authentication tag. On several +AEAD ciphers, the authentication tag is appended to the ciphertext, +though this is not a general rule. This function will fail if +the tag verification fails. +.SH "RETURNS" +Zero or a negative error code on verification failure or other error. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_aead_cipher_decryptv2.3 b/doc/manpages/gnutls_aead_cipher_decryptv2.3 new file mode 100644 index 0000000..98af844 --- /dev/null +++ b/doc/manpages/gnutls_aead_cipher_decryptv2.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_aead_cipher_decryptv2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_aead_cipher_decryptv2 \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_aead_cipher_decryptv2(gnutls_aead_cipher_hd_t " handle ", const void * " nonce ", size_t " nonce_len ", const giovec_t * " auth_iov ", int " auth_iovcnt ", const giovec_t * " iov ", int " iovcnt ", void * " tag ", size_t " tag_size ");" +.SH ARGUMENTS +.IP "gnutls_aead_cipher_hd_t handle" 12 +is a \fBgnutls_aead_cipher_hd_t\fP type. +.IP "const void * nonce" 12 +the nonce to set +.IP "size_t nonce_len" 12 +The length of the nonce +.IP "const giovec_t * auth_iov" 12 +additional data to be authenticated +.IP "int auth_iovcnt" 12 +The number of buffers in \fIauth_iov\fP +.IP "const giovec_t * iov" 12 +the data to decrypt +.IP "int iovcnt" 12 +The number of buffers in \fIiov\fP +.IP "void * tag" 12 +The authentication tag +.IP "size_t tag_size" 12 +The size of the tag to use (use zero for the default) +.SH "DESCRIPTION" +This is similar to \fBgnutls_aead_cipher_decrypt()\fP, but it performs +in\-place encryption on the provided data buffers. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.6.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_aead_cipher_deinit.3 b/doc/manpages/gnutls_aead_cipher_deinit.3 new file mode 100644 index 0000000..af6f99b --- /dev/null +++ b/doc/manpages/gnutls_aead_cipher_deinit.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_aead_cipher_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_aead_cipher_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "void gnutls_aead_cipher_deinit(gnutls_aead_cipher_hd_t " handle ");" +.SH ARGUMENTS +.IP "gnutls_aead_cipher_hd_t handle" 12 +is a \fBgnutls_aead_cipher_hd_t\fP type. +.SH "DESCRIPTION" +This function will deinitialize all resources occupied by the given +authenticated\-encryption context. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_aead_cipher_encrypt.3 b/doc/manpages/gnutls_aead_cipher_encrypt.3 new file mode 100644 index 0000000..4ac68e8 --- /dev/null +++ b/doc/manpages/gnutls_aead_cipher_encrypt.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_aead_cipher_encrypt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_aead_cipher_encrypt \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_aead_cipher_encrypt(gnutls_aead_cipher_hd_t " handle ", const void * " nonce ", size_t " nonce_len ", const void * " auth ", size_t " auth_len ", size_t " tag_size ", const void * " ptext ", size_t " ptext_len ", void * " ctext ", size_t * " ctext_len ");" +.SH ARGUMENTS +.IP "gnutls_aead_cipher_hd_t handle" 12 +is a \fBgnutls_aead_cipher_hd_t\fP type. +.IP "const void * nonce" 12 +the nonce to set +.IP "size_t nonce_len" 12 +The length of the nonce +.IP "const void * auth" 12 +additional data to be authenticated +.IP "size_t auth_len" 12 +The length of the data +.IP "size_t tag_size" 12 +The size of the tag to use (use zero for the default) +.IP "const void * ptext" 12 +the data to encrypt +.IP "size_t ptext_len" 12 +The length of data to encrypt +.IP "void * ctext" 12 +the encrypted data including authentication tag +.IP "size_t * ctext_len" 12 +the length of encrypted data (initially must hold the maximum available size, including space for tag) +.SH "DESCRIPTION" +This function will encrypt the given data using the algorithm +specified by the context. The output data will contain the +authentication tag. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_aead_cipher_encryptv.3 b/doc/manpages/gnutls_aead_cipher_encryptv.3 new file mode 100644 index 0000000..60f99a3 --- /dev/null +++ b/doc/manpages/gnutls_aead_cipher_encryptv.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_aead_cipher_encryptv" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_aead_cipher_encryptv \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_aead_cipher_encryptv(gnutls_aead_cipher_hd_t " handle ", const void * " nonce ", size_t " nonce_len ", const giovec_t * " auth_iov ", int " auth_iovcnt ", size_t " tag_size ", const giovec_t * " iov ", int " iovcnt ", void * " ctext ", size_t * " ctext_len ");" +.SH ARGUMENTS +.IP "gnutls_aead_cipher_hd_t handle" 12 +is a \fBgnutls_aead_cipher_hd_t\fP type. +.IP "const void * nonce" 12 +the nonce to set +.IP "size_t nonce_len" 12 +The length of the nonce +.IP "const giovec_t * auth_iov" 12 +additional data to be authenticated +.IP "int auth_iovcnt" 12 +The number of buffers in \fIauth_iov\fP +.IP "size_t tag_size" 12 +The size of the tag to use (use zero for the default) +.IP "const giovec_t * iov" 12 +the data to be encrypted +.IP "int iovcnt" 12 +The number of buffers in \fIiov\fP +.IP "void * ctext" 12 +the encrypted data including authentication tag +.IP "size_t * ctext_len" 12 +the length of encrypted data (initially must hold the maximum available size, including space for tag) +.SH "DESCRIPTION" +This function will encrypt the provided data buffers using the algorithm +specified by the context. The output data will contain the +authentication tag. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_aead_cipher_encryptv2.3 b/doc/manpages/gnutls_aead_cipher_encryptv2.3 new file mode 100644 index 0000000..3596d2f --- /dev/null +++ b/doc/manpages/gnutls_aead_cipher_encryptv2.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_aead_cipher_encryptv2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_aead_cipher_encryptv2 \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_aead_cipher_encryptv2(gnutls_aead_cipher_hd_t " handle ", const void * " nonce ", size_t " nonce_len ", const giovec_t * " auth_iov ", int " auth_iovcnt ", const giovec_t * " iov ", int " iovcnt ", void * " tag ", size_t * " tag_size ");" +.SH ARGUMENTS +.IP "gnutls_aead_cipher_hd_t handle" 12 +is a \fBgnutls_aead_cipher_hd_t\fP type. +.IP "const void * nonce" 12 +the nonce to set +.IP "size_t nonce_len" 12 +The length of the nonce +.IP "const giovec_t * auth_iov" 12 +additional data to be authenticated +.IP "int auth_iovcnt" 12 +The number of buffers in \fIauth_iov\fP +.IP "const giovec_t * iov" 12 +the data to be encrypted +.IP "int iovcnt" 12 +The number of buffers in \fIiov\fP +.IP "void * tag" 12 +The authentication tag +.IP "size_t * tag_size" 12 +The size of the tag to use (use zero for the default) +.SH "DESCRIPTION" +This is similar to \fBgnutls_aead_cipher_encrypt()\fP, but it performs +in\-place encryption on the provided data buffers. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.6.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_aead_cipher_init.3 b/doc/manpages/gnutls_aead_cipher_init.3 new file mode 100644 index 0000000..b6db140 --- /dev/null +++ b/doc/manpages/gnutls_aead_cipher_init.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_aead_cipher_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_aead_cipher_init \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_aead_cipher_init(gnutls_aead_cipher_hd_t * " handle ", gnutls_cipher_algorithm_t " cipher ", const gnutls_datum_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_aead_cipher_hd_t * handle" 12 +is a \fBgnutls_aead_cipher_hd_t\fP type. +.IP "gnutls_cipher_algorithm_t cipher" 12 +the authenticated\-encryption algorithm to use +.IP "const gnutls_datum_t * key" 12 +The key to be used for encryption +.SH "DESCRIPTION" +This function will initialize an context that can be used for +encryption/decryption of data. This will effectively use the +current crypto backend in use by gnutls or the cryptographic +accelerator in use. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_aead_cipher_set_key.3 b/doc/manpages/gnutls_aead_cipher_set_key.3 new file mode 100644 index 0000000..e5f56eb --- /dev/null +++ b/doc/manpages/gnutls_aead_cipher_set_key.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_aead_cipher_set_key" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_aead_cipher_set_key \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_aead_cipher_set_key(gnutls_aead_cipher_hd_t " handle ", const gnutls_datum_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_aead_cipher_hd_t handle" 12 +is a \fBgnutls_aead_cipher_hd_t\fP type. +.IP "const gnutls_datum_t * key" 12 +The key to be used for encryption +.SH "DESCRIPTION" +This function will set a new key without re\-initializing the +context. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.7.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_alert_get.3 b/doc/manpages/gnutls_alert_get.3 new file mode 100644 index 0000000..30e8c6d --- /dev/null +++ b/doc/manpages/gnutls_alert_get.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_alert_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_alert_description_t gnutls_alert_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function will return the last alert number received. This +function should be called when \fBGNUTLS_E_WARNING_ALERT_RECEIVED\fP or +\fBGNUTLS_E_FATAL_ALERT_RECEIVED\fP errors are returned by a gnutls +function. The peer may send alerts if he encounters an error. +If no alert has been received the returned value is undefined. +.SH "RETURNS" +the last alert received, a +\fBgnutls_alert_description_t\fP value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_alert_get_name.3 b/doc/manpages/gnutls_alert_get_name.3 new file mode 100644 index 0000000..fcfc33a --- /dev/null +++ b/doc/manpages/gnutls_alert_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_alert_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_alert_get_name(gnutls_alert_description_t " alert ");" +.SH ARGUMENTS +.IP "gnutls_alert_description_t alert" 12 +is an alert number. +.SH "DESCRIPTION" +This function will return a string that describes the given alert +number, or \fBNULL\fP. See \fBgnutls_alert_get()\fP. +.SH "RETURNS" +string corresponding to \fBgnutls_alert_description_t\fP value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_alert_get_strname.3 b/doc/manpages/gnutls_alert_get_strname.3 new file mode 100644 index 0000000..247bcc8 --- /dev/null +++ b/doc/manpages/gnutls_alert_get_strname.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_get_strname" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_alert_get_strname \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_alert_get_strname(gnutls_alert_description_t " alert ");" +.SH ARGUMENTS +.IP "gnutls_alert_description_t alert" 12 +is an alert number. +.SH "DESCRIPTION" +This function will return a string of the name of the alert. +.SH "RETURNS" +string corresponding to \fBgnutls_alert_description_t\fP value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_alert_send.3 b/doc/manpages/gnutls_alert_send.3 new file mode 100644 index 0000000..c0424d4 --- /dev/null +++ b/doc/manpages/gnutls_alert_send.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_send" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_alert_send \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_alert_send(gnutls_session_t " session ", gnutls_alert_level_t " level ", gnutls_alert_description_t " desc ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_alert_level_t level" 12 +is the level of the alert +.IP "gnutls_alert_description_t desc" 12 +is the alert description +.SH "DESCRIPTION" +This function will send an alert to the peer in order to inform +him of something important (eg. his Certificate could not be verified). +If the alert level is Fatal then the peer is expected to close the +connection, otherwise he may ignore the alert and continue. + +The error code of the underlying record send function will be +returned, so you may also receive \fBGNUTLS_E_INTERRUPTED\fP or +\fBGNUTLS_E_AGAIN\fP as well. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_alert_send_appropriate.3 b/doc/manpages/gnutls_alert_send_appropriate.3 new file mode 100644 index 0000000..3aa03c2 --- /dev/null +++ b/doc/manpages/gnutls_alert_send_appropriate.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_send_appropriate" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_alert_send_appropriate \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_alert_send_appropriate(gnutls_session_t " session ", int " err ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "int err" 12 +is an error code returned by another GnuTLS function +.SH "DESCRIPTION" +Sends an alert to the peer depending on the error code returned by +a gnutls function. This function will call \fBgnutls_error_to_alert()\fP +to determine the appropriate alert to send. + +This function may also return \fBGNUTLS_E_AGAIN\fP, or +\fBGNUTLS_E_INTERRUPTED\fP. + +This function historically was always sending an alert to the +peer, even if \fIerr\fP was inappropriate to respond with an alert +(e.g., \fBGNUTLS_E_SUCCESS\fP). Since 3.6.6 this function returns +success without transmitting any data on error codes that +should not result to an alert. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_alert_set_read_function.3 b/doc/manpages/gnutls_alert_set_read_function.3 new file mode 100644 index 0000000..742ba7a --- /dev/null +++ b/doc/manpages/gnutls_alert_set_read_function.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_set_read_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_alert_set_read_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_alert_set_read_function(gnutls_session_t " session ", gnutls_alert_read_func " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is \fBgnutls_session_t\fP type +.IP "gnutls_alert_read_func func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback to be called when an alert +message is being sent. +.SH "SINCE" +3.7.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_alpn_get_selected_protocol.3 b/doc/manpages/gnutls_alpn_get_selected_protocol.3 new file mode 100644 index 0000000..c4afdb5 --- /dev/null +++ b/doc/manpages/gnutls_alpn_get_selected_protocol.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alpn_get_selected_protocol" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_alpn_get_selected_protocol \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_alpn_get_selected_protocol(gnutls_session_t " session ", gnutls_datum_t * " protocol ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_datum_t * protocol" 12 +will hold the protocol name +.SH "DESCRIPTION" +This function allows you to get the negotiated protocol name. The +returned protocol should be treated as opaque, constant value and +only valid during the session life. + +The selected protocol is the first supported by the list sent +by the client. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. + +Since 3.2.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_alpn_set_protocols.3 b/doc/manpages/gnutls_alpn_set_protocols.3 new file mode 100644 index 0000000..f29ad11 --- /dev/null +++ b/doc/manpages/gnutls_alpn_set_protocols.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alpn_set_protocols" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_alpn_set_protocols \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_alpn_set_protocols(gnutls_session_t " session ", const gnutls_datum_t * " protocols ", unsigned " protocols_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const gnutls_datum_t * protocols" 12 +is the protocol names to add. +.IP "unsigned protocols_size" 12 +the number of protocols to add. +.IP "unsigned int flags" 12 +zero or a sequence of \fBgnutls_alpn_flags_t\fP +.SH "DESCRIPTION" +This function is to be used by both clients and servers, to declare +the supported ALPN protocols, which are used during negotiation with peer. + +See \fBgnutls_alpn_flags_t\fP description for the documentation of available +flags. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. + +Since 3.2.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anon_allocate_client_credentials.3 b/doc/manpages/gnutls_anon_allocate_client_credentials.3 new file mode 100644 index 0000000..13f6718 --- /dev/null +++ b/doc/manpages/gnutls_anon_allocate_client_credentials.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_allocate_client_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anon_allocate_client_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_anon_allocate_client_credentials(gnutls_anon_client_credentials_t * " sc ");" +.SH ARGUMENTS +.IP "gnutls_anon_client_credentials_t * sc" 12 +is a pointer to a \fBgnutls_anon_client_credentials_t\fP type. +.SH "DESCRIPTION" +Allocate a gnutls_anon_client_credentials_t structure. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anon_allocate_server_credentials.3 b/doc/manpages/gnutls_anon_allocate_server_credentials.3 new file mode 100644 index 0000000..2d8a301 --- /dev/null +++ b/doc/manpages/gnutls_anon_allocate_server_credentials.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_allocate_server_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anon_allocate_server_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_anon_allocate_server_credentials(gnutls_anon_server_credentials_t * " sc ");" +.SH ARGUMENTS +.IP "gnutls_anon_server_credentials_t * sc" 12 +is a pointer to a \fBgnutls_anon_server_credentials_t\fP type. +.SH "DESCRIPTION" +Allocate a gnutls_anon_server_credentials_t structure. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anon_free_client_credentials.3 b/doc/manpages/gnutls_anon_free_client_credentials.3 new file mode 100644 index 0000000..54e1a58 --- /dev/null +++ b/doc/manpages/gnutls_anon_free_client_credentials.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_free_client_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anon_free_client_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anon_free_client_credentials(gnutls_anon_client_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_anon_client_credentials_t sc" 12 +is a \fBgnutls_anon_client_credentials_t\fP type. +.SH "DESCRIPTION" +Free a gnutls_anon_client_credentials_t structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anon_free_server_credentials.3 b/doc/manpages/gnutls_anon_free_server_credentials.3 new file mode 100644 index 0000000..7b94ab3 --- /dev/null +++ b/doc/manpages/gnutls_anon_free_server_credentials.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_free_server_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anon_free_server_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anon_free_server_credentials(gnutls_anon_server_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_anon_server_credentials_t sc" 12 +is a \fBgnutls_anon_server_credentials_t\fP type. +.SH "DESCRIPTION" +Free a gnutls_anon_server_credentials_t structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anon_set_params_function.3 b/doc/manpages/gnutls_anon_set_params_function.3 new file mode 100644 index 0000000..8e21536 --- /dev/null +++ b/doc/manpages/gnutls_anon_set_params_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_set_params_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anon_set_params_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anon_set_params_function(gnutls_anon_server_credentials_t " res ", gnutls_params_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_anon_server_credentials_t res" 12 +is a gnutls_anon_server_credentials_t type +.IP "gnutls_params_function * func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback in order for the server to get +the Diffie\-Hellman or RSA parameters for anonymous authentication. +The callback should return \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anon_set_server_dh_params.3 b/doc/manpages/gnutls_anon_set_server_dh_params.3 new file mode 100644 index 0000000..c75ad0d --- /dev/null +++ b/doc/manpages/gnutls_anon_set_server_dh_params.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_set_server_dh_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anon_set_server_dh_params \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anon_set_server_dh_params(gnutls_anon_server_credentials_t " res ", gnutls_dh_params_t " dh_params ");" +.SH ARGUMENTS +.IP "gnutls_anon_server_credentials_t res" 12 +is a gnutls_anon_server_credentials_t type +.IP "gnutls_dh_params_t dh_params" 12 +The Diffie\-Hellman parameters. +.SH "DESCRIPTION" +This function will set the Diffie\-Hellman parameters for an +anonymous server to use. These parameters will be used in +Anonymous Diffie\-Hellman cipher suites. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anon_set_server_known_dh_params.3 b/doc/manpages/gnutls_anon_set_server_known_dh_params.3 new file mode 100644 index 0000000..69ad432 --- /dev/null +++ b/doc/manpages/gnutls_anon_set_server_known_dh_params.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_set_server_known_dh_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anon_set_server_known_dh_params \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_anon_set_server_known_dh_params(gnutls_anon_server_credentials_t " res ", gnutls_sec_param_t " sec_param ");" +.SH ARGUMENTS +.IP "gnutls_anon_server_credentials_t res" 12 +is a gnutls_anon_server_credentials_t type +.IP "gnutls_sec_param_t sec_param" 12 +is an option of the \fBgnutls_sec_param_t\fP enumeration +.SH "DESCRIPTION" +This function will set the Diffie\-Hellman parameters for an +anonymous server to use. These parameters will be used in +Anonymous Diffie\-Hellman cipher suites and will be selected from +the FFDHE set of RFC7919 according to the security level provided. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anon_set_server_params_function.3 b/doc/manpages/gnutls_anon_set_server_params_function.3 new file mode 100644 index 0000000..32aaff3 --- /dev/null +++ b/doc/manpages/gnutls_anon_set_server_params_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_set_server_params_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anon_set_server_params_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anon_set_server_params_function(gnutls_anon_server_credentials_t " res ", gnutls_params_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_anon_server_credentials_t res" 12 +is a gnutls_certificate_credentials_t type +.IP "gnutls_params_function * func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback in order for the server to get +the Diffie\-Hellman parameters for anonymous authentication. The +callback should return \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anti_replay_deinit.3 b/doc/manpages/gnutls_anti_replay_deinit.3 new file mode 100644 index 0000000..46272fe --- /dev/null +++ b/doc/manpages/gnutls_anti_replay_deinit.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anti_replay_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anti_replay_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anti_replay_deinit(gnutls_anti_replay_t " anti_replay ");" +.SH ARGUMENTS +.IP "gnutls_anti_replay_t anti_replay" 12 +is a \fBgnutls_anti_replay\fP type +.SH "DESCRIPTION" +This function will deinitialize all resources occupied by the given +anti\-replay context. +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anti_replay_enable.3 b/doc/manpages/gnutls_anti_replay_enable.3 new file mode 100644 index 0000000..e29700f --- /dev/null +++ b/doc/manpages/gnutls_anti_replay_enable.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anti_replay_enable" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anti_replay_enable \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anti_replay_enable(gnutls_session_t " session ", gnutls_anti_replay_t " anti_replay ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_anti_replay_t anti_replay" 12 +is a \fBgnutls_anti_replay_t\fP type. +.SH "DESCRIPTION" +Request that the server should use anti\-replay mechanism. +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anti_replay_init.3 b/doc/manpages/gnutls_anti_replay_init.3 new file mode 100644 index 0000000..bc8fdf7 --- /dev/null +++ b/doc/manpages/gnutls_anti_replay_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anti_replay_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anti_replay_init \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_anti_replay_init(gnutls_anti_replay_t * " anti_replay ");" +.SH ARGUMENTS +.IP "gnutls_anti_replay_t * anti_replay" 12 +is a pointer to \fBgnutls_anti_replay_t\fP type +.SH "DESCRIPTION" +This function will allocate and initialize the \fIanti_replay\fP context +to be usable for detect replay attacks. The context can then be +attached to a \fIgnutls_session_t\fP with +\fBgnutls_anti_replay_enable()\fP. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anti_replay_set_add_function.3 b/doc/manpages/gnutls_anti_replay_set_add_function.3 new file mode 100644 index 0000000..3f70ecf --- /dev/null +++ b/doc/manpages/gnutls_anti_replay_set_add_function.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anti_replay_set_add_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anti_replay_set_add_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anti_replay_set_add_function(gnutls_anti_replay_t " anti_replay ", gnutls_db_add_func " add_func ");" +.SH ARGUMENTS +.IP "gnutls_anti_replay_t anti_replay" 12 +is a \fBgnutls_anti_replay_t\fP type. +.IP "gnutls_db_add_func add_func" 12 +is the function. +.SH "DESCRIPTION" +Sets the function that will be used to store an entry if it is not +already present in the resumed sessions database. This function returns 0 +if the entry is successfully stored, and a negative error code +otherwise. In particular, if the entry is found in the database, +it returns \fBGNUTLS_E_DB_ENTRY_EXISTS\fP. + +The arguments to the \fIadd_func\fP are: +\- \fBptr\fP: the pointer set with \fBgnutls_anti_replay_set_ptr()\fP +\- \fBexp_time\fP: the expiration time of the entry +\- \fBkey\fP: a pointer to the key +\- \fBdata\fP: a pointer to data to store + +The data set by this function can be examined using +\fBgnutls_db_check_entry_expire_time()\fP and \fBgnutls_db_check_entry_time()\fP. +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anti_replay_set_ptr.3 b/doc/manpages/gnutls_anti_replay_set_ptr.3 new file mode 100644 index 0000000..ba00461 --- /dev/null +++ b/doc/manpages/gnutls_anti_replay_set_ptr.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anti_replay_set_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anti_replay_set_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anti_replay_set_ptr(gnutls_anti_replay_t " anti_replay ", void * " ptr ");" +.SH ARGUMENTS +.IP "gnutls_anti_replay_t anti_replay" 12 +is a \fBgnutls_anti_replay_t\fP type. +.IP "void * ptr" 12 +is the pointer +.SH "DESCRIPTION" +Sets the pointer that will be provided to db add function +as the first argument. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_anti_replay_set_window.3 b/doc/manpages/gnutls_anti_replay_set_window.3 new file mode 100644 index 0000000..e96058a --- /dev/null +++ b/doc/manpages/gnutls_anti_replay_set_window.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anti_replay_set_window" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_anti_replay_set_window \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_anti_replay_set_window(gnutls_anti_replay_t " anti_replay ", unsigned int " window ");" +.SH ARGUMENTS +.IP "gnutls_anti_replay_t anti_replay" 12 +is a \fBgnutls_anti_replay_t\fP type. +.IP "unsigned int window" 12 +is the time window recording ClientHello, in milliseconds +.SH "DESCRIPTION" +Sets the time window used for ClientHello recording. In order to +protect against replay attacks, the server records ClientHello +messages within this time period from the last update, and +considers it a replay when a ClientHello outside of the period; if +a ClientHello arrives within this period, the server checks the +database and detects duplicates. + +For the details of the algorithm, see RFC 8446, section 8.2. +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_auth_client_get_type.3 b/doc/manpages/gnutls_auth_client_get_type.3 new file mode 100644 index 0000000..33f8b58 --- /dev/null +++ b/doc/manpages/gnutls_auth_client_get_type.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_auth_client_get_type" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_auth_client_get_type \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_credentials_type_t gnutls_auth_client_get_type(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Returns the type of credentials that were used for client authentication. +The returned information is to be used to distinguish the function used +to access authentication data. + +Note that on resumed sessions, this function returns the schema +used in the original session authentication. +.SH "RETURNS" +The type of credentials for the client authentication +schema, a \fBgnutls_credentials_type_t\fP type. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_auth_get_type.3 b/doc/manpages/gnutls_auth_get_type.3 new file mode 100644 index 0000000..ba9cc54 --- /dev/null +++ b/doc/manpages/gnutls_auth_get_type.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_auth_get_type" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_auth_get_type \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_credentials_type_t gnutls_auth_get_type(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Returns type of credentials for the current authentication schema. +The returned information is to be used to distinguish the function used +to access authentication data. + +Eg. for CERTIFICATE ciphersuites (key exchange algorithms: +\fBGNUTLS_KX_RSA\fP, \fBGNUTLS_KX_DHE_RSA\fP), the same function are to be +used to access the authentication data. + +Note that on resumed sessions, this function returns the schema +used in the original session authentication. +.SH "RETURNS" +The type of credentials for the current authentication +schema, a \fBgnutls_credentials_type_t\fP type. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_auth_server_get_type.3 b/doc/manpages/gnutls_auth_server_get_type.3 new file mode 100644 index 0000000..a69c77e --- /dev/null +++ b/doc/manpages/gnutls_auth_server_get_type.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_auth_server_get_type" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_auth_server_get_type \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_credentials_type_t gnutls_auth_server_get_type(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Returns the type of credentials that were used for server authentication. +The returned information is to be used to distinguish the function used +to access authentication data. + +Note that on resumed sessions, this function returns the schema +used in the original session authentication. +.SH "RETURNS" +The type of credentials for the server authentication +schema, a \fBgnutls_credentials_type_t\fP type. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_base64_decode2.3 b/doc/manpages/gnutls_base64_decode2.3 new file mode 100644 index 0000000..87707b3 --- /dev/null +++ b/doc/manpages/gnutls_base64_decode2.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_base64_decode2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_base64_decode2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_base64_decode2(const gnutls_datum_t * " base64 ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * base64" 12 +contains the encoded data +.IP "gnutls_datum_t * result" 12 +the location of decoded data +.SH "DESCRIPTION" +This function will decode the given base64 encoded data. The decoded data +will be allocated, and stored into result. + +You should use \fBgnutls_free()\fP to free the returned data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_base64_encode2.3 b/doc/manpages/gnutls_base64_encode2.3 new file mode 100644 index 0000000..b13996d --- /dev/null +++ b/doc/manpages/gnutls_base64_encode2.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_base64_encode2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_base64_encode2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_base64_encode2(const gnutls_datum_t * " data ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * data" 12 +contains the raw data +.IP "gnutls_datum_t * result" 12 +will hold the newly allocated encoded data +.SH "DESCRIPTION" +This function will convert the given data to printable data, using +the base64 encoding. This function will allocate the required +memory to hold the encoded data. + +You should use \fBgnutls_free()\fP to free the returned data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_buffer_append_data.3 b/doc/manpages/gnutls_buffer_append_data.3 new file mode 100644 index 0000000..d08a975 --- /dev/null +++ b/doc/manpages/gnutls_buffer_append_data.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_buffer_append_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_buffer_append_data \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_buffer_append_data(gnutls_buffer_t " dest ", const void * " data ", size_t " data_size ");" +.SH ARGUMENTS +.IP "gnutls_buffer_t dest" 12 +the buffer to append to +.IP "const void * data" 12 +the data +.IP "size_t data_size" 12 +the size of \fIdata\fP +.SH "DESCRIPTION" +Appends the provided \fIdata\fP to the destination buffer. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_bye.3 b/doc/manpages/gnutls_bye.3 new file mode 100644 index 0000000..02363fa --- /dev/null +++ b/doc/manpages/gnutls_bye.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_bye" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_bye \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_bye(gnutls_session_t " session ", gnutls_close_request_t " how ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_close_request_t how" 12 +is an integer +.SH "DESCRIPTION" +Terminates the current TLS/SSL connection. The connection should +have been initiated using \fBgnutls_handshake()\fP. \fIhow\fP should be one +of \fBGNUTLS_SHUT_RDWR\fP, \fBGNUTLS_SHUT_WR\fP. + +In case of \fBGNUTLS_SHUT_RDWR\fP the TLS session gets +terminated and further receives and sends will be disallowed. If +the return value is zero you may continue using the underlying +transport layer. \fBGNUTLS_SHUT_RDWR\fP sends an alert containing a close +request and waits for the peer to reply with the same message. + +In case of \fBGNUTLS_SHUT_WR\fP the TLS session gets terminated +and further sends will be disallowed. In order to reuse the +connection you should wait for an EOF from the peer. +\fBGNUTLS_SHUT_WR\fP sends an alert containing a close request. + +Note that not all implementations will properly terminate a TLS +connection. Some of them, usually for performance reasons, will +terminate only the underlying transport layer, and thus not +distinguishing between a malicious party prematurely terminating +the connection and normal termination. + +This function may also return \fBGNUTLS_E_AGAIN\fP or +\fBGNUTLS_E_INTERRUPTED\fP; cf. \fBgnutls_record_get_direction()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code, see +function documentation for entire semantics. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_activation_time_peers.3 b/doc/manpages/gnutls_certificate_activation_time_peers.3 new file mode 100644 index 0000000..86624bd --- /dev/null +++ b/doc/manpages/gnutls_certificate_activation_time_peers.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_activation_time_peers" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_activation_time_peers \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "time_t gnutls_certificate_activation_time_peers(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +This function will return the peer's certificate activation time. +.SH "RETURNS" +(time_t)\-1 on error. +.SH "DEPRECATED" +\fBgnutls_certificate_verify_peers2()\fP now verifies activation times. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_allocate_credentials.3 b/doc/manpages/gnutls_certificate_allocate_credentials.3 new file mode 100644 index 0000000..3e09ae5 --- /dev/null +++ b/doc/manpages/gnutls_certificate_allocate_credentials.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_allocate_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_allocate_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_allocate_credentials(gnutls_certificate_credentials_t * " res ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t * res" 12 +is a pointer to a \fBgnutls_certificate_credentials_t\fP type. +.SH "DESCRIPTION" +Allocate a gnutls_certificate_credentials_t structure. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_client_get_request_status.3 b/doc/manpages/gnutls_certificate_client_get_request_status.3 new file mode 100644 index 0000000..2e495b4 --- /dev/null +++ b/doc/manpages/gnutls_certificate_client_get_request_status.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_client_get_request_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_client_get_request_status \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_certificate_client_get_request_status(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +Get whether client certificate was requested on the last +handshake or not. +.SH "RETURNS" +0 if the peer (server) did not request client +authentication or 1 otherwise. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_expiration_time_peers.3 b/doc/manpages/gnutls_certificate_expiration_time_peers.3 new file mode 100644 index 0000000..6edf6c0 --- /dev/null +++ b/doc/manpages/gnutls_certificate_expiration_time_peers.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_expiration_time_peers" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_expiration_time_peers \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "time_t gnutls_certificate_expiration_time_peers(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +This function will return the peer's certificate expiration time. +.SH "RETURNS" +(time_t)\-1 on error. +.SH "DEPRECATED" +\fBgnutls_certificate_verify_peers2()\fP now verifies expiration times. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_free_ca_names.3 b/doc/manpages/gnutls_certificate_free_ca_names.3 new file mode 100644 index 0000000..c9c7919 --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_ca_names.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_ca_names" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_ca_names \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_free_ca_names(gnutls_certificate_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.SH "DESCRIPTION" +This function will delete all the CA name in the given +credentials. Clients may call this to save some memory since in +client side the CA names are not used. Servers might want to use +this function if a large list of trusted CAs is present and +sending the names of it would just consume bandwidth without providing +information to client. + +CA names are used by servers to advertise the CAs they support to +clients. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_free_cas.3 b/doc/manpages/gnutls_certificate_free_cas.3 new file mode 100644 index 0000000..8733153 --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_cas.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_cas" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_cas \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_free_cas(gnutls_certificate_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.SH "DESCRIPTION" +This function was operational on very early versions of gnutls. +Due to internal refactorings and the fact that this was hardly ever +used, it is currently a no\-op. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_free_credentials.3 b/doc/manpages/gnutls_certificate_free_credentials.3 new file mode 100644 index 0000000..a0a56ce --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_credentials.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_free_credentials(gnutls_certificate_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.SH "DESCRIPTION" +Free a gnutls_certificate_credentials_t structure. + +This function does not free any temporary parameters associated +with this structure (ie RSA and DH parameters are not freed by this +function). +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_free_crls.3 b/doc/manpages/gnutls_certificate_free_crls.3 new file mode 100644 index 0000000..5dfcdac --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_crls.3 @@ -0,0 +1,34 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_crls" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_crls \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_free_crls(gnutls_certificate_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.SH "DESCRIPTION" +This function will delete all the CRLs associated +with the given credentials. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_free_keys.3 b/doc/manpages/gnutls_certificate_free_keys.3 new file mode 100644 index 0000000..b6b52ed --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_keys.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_keys" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_keys \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_free_keys(gnutls_certificate_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.SH "DESCRIPTION" +This function will delete all the keys and the certificates associated +with the given credentials. This function must not be called when a +TLS negotiation that uses the credentials is in progress. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_crt_raw.3 b/doc/manpages/gnutls_certificate_get_crt_raw.3 new file mode 100644 index 0000000..fcbae02 --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_crt_raw.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_crt_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_crt_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_get_crt_raw(gnutls_certificate_credentials_t " sc ", unsigned " idx1 ", unsigned " idx2 ", gnutls_datum_t * " cert ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "unsigned idx1" 12 +the index of the certificate chain if multiple are present +.IP "unsigned idx2" 12 +the index of the certificate in the chain. Zero gives the server's certificate. +.IP "gnutls_datum_t * cert" 12 +Will hold the DER encoded certificate. +.SH "DESCRIPTION" +This function will return the DER encoded certificate of the +server or any other certificate on its certificate chain (based on \fIidx2\fP ). +The returned data should be treated as constant and only accessible during the lifetime +of \fIsc\fP . The \fIidx1\fP matches the value \fBgnutls_certificate_set_x509_key()\fP and friends +functions. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. In case the indexes are out of bounds \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +is returned. +.SH "SINCE" +3.2.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_issuer.3 b/doc/manpages/gnutls_certificate_get_issuer.3 new file mode 100644 index 0000000..7e94d1f --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_issuer.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_issuer" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_issuer \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_get_issuer(gnutls_certificate_credentials_t " sc ", gnutls_x509_crt_t " cert ", gnutls_x509_crt_t * " issuer ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_x509_crt_t cert" 12 +is the certificate to find issuer for +.IP "gnutls_x509_crt_t * issuer" 12 +Will hold the issuer if any. Should be treated as constant. +.IP "unsigned int flags" 12 +Use zero or \fBGNUTLS_TL_GET_COPY\fP +.SH "DESCRIPTION" +This function will return the issuer of a given certificate. +If the flag \fBGNUTLS_TL_GET_COPY\fP is specified a copy of the issuer +will be returned which must be freed using \fBgnutls_x509_crt_deinit()\fP. +In that case the provided \fIissuer\fP must not be initialized. + +As with \fBgnutls_x509_trust_list_get_issuer()\fP this function requires +the \fBGNUTLS_TL_GET_COPY\fP flag in order to operate with PKCS\fB11\fP trust +lists in a thread\-safe way. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_ocsp_expiration.3 b/doc/manpages/gnutls_certificate_get_ocsp_expiration.3 new file mode 100644 index 0000000..ebf929b --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_ocsp_expiration.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_ocsp_expiration" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_ocsp_expiration \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "time_t gnutls_certificate_get_ocsp_expiration(gnutls_certificate_credentials_t " sc ", unsigned " idx ", int " oidx ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a credentials structure. +.IP "unsigned idx" 12 +is a certificate chain index as returned by \fBgnutls_certificate_set_key()\fP and friends +.IP "int oidx" 12 +is an OCSP response index +.IP "unsigned flags" 12 +should be zero +.SH "DESCRIPTION" +This function returns the validity of the loaded OCSP responses, +to provide information on when to reload/refresh them. + +Note that the credentials structure should be read\-only when in +use, thus when reloading, either the credentials structure must not +be in use by any sessions, or a new credentials structure should be +allocated for new sessions. + +When \fIoidx\fP is (\-1) then the minimum refresh time for all responses +is returned. Otherwise the index specifies the response corresponding +to the \fIodix\fP certificate in the certificate chain. +.SH "RETURNS" +On success, the expiration time of the OCSP response. Otherwise +(time_t)(\-1) on error, or (time_t)\-2 on out of bounds. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_ours.3 b/doc/manpages/gnutls_certificate_get_ours.3 new file mode 100644 index 0000000..8b326f1 --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_ours.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_ours" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_ours \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_datum_t * gnutls_certificate_get_ours(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +Gets the certificate as sent to the peer in the last handshake. +The certificate is in raw (DER) format. No certificate +list is being returned. Only the first certificate. + +This function returns the certificate that was sent in the current +handshake. In subsequent resumed sessions this function will return +\fBNULL\fP. That differs from \fBgnutls_certificate_get_peers()\fP which always +returns the peer's certificate used in the original session. +.SH "RETURNS" +a pointer to a \fBgnutls_datum_t\fP containing our +certificate, or \fBNULL\fP in case of an error or if no certificate +was used. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_peers.3 b/doc/manpages/gnutls_certificate_get_peers.3 new file mode 100644 index 0000000..15acfff --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_peers.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_peers" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_peers \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_datum_t * gnutls_certificate_get_peers(gnutls_session_t " session ", unsigned int * " list_size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "unsigned int * list_size" 12 +is the length of the certificate list (may be \fBNULL\fP) +.SH "DESCRIPTION" +Get the peer's raw certificate (chain) as sent by the peer. These +certificates are in raw format (DER encoded for X.509). In case of +a X.509 then a certificate list may be present. The list +is provided as sent by the server; the server must send as first +certificate in the list its own certificate, following the +issuer's certificate, then the issuer's issuer etc. However, there +are servers which violate this principle and thus on certain +occasions this may be an unsorted list. + +In resumed sessions, this function will return the peer's certificate +list as used in the first/original session. +.SH "RETURNS" +a pointer to a \fBgnutls_datum_t\fP containing the peer's +certificates, or \fBNULL\fP in case of an error or if no certificate +was used. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_peers_subkey_id.3 b/doc/manpages/gnutls_certificate_get_peers_subkey_id.3 new file mode 100644 index 0000000..148c64a --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_peers_subkey_id.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_peers_subkey_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_peers_subkey_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_get_peers_subkey_id(gnutls_session_t " session ", gnutls_datum_t * " id ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "gnutls_datum_t * id" 12 +will contain the ID +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_trust_list.3 b/doc/manpages/gnutls_certificate_get_trust_list.3 new file mode 100644 index 0000000..d5252b4 --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_trust_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_trust_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_trust_list \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_certificate_get_trust_list(gnutls_certificate_credentials_t " res ", gnutls_x509_trust_list_t * " tlist ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_x509_trust_list_t * tlist" 12 +Location where to store the trust list. +.SH "DESCRIPTION" +Obtains the list of trusted certificates stored in \fIres\fP and writes a +pointer to it to the location \fItlist\fP . The pointer will point to memory +internal to \fIres\fP , and must not be deinitialized. It will be automatically +deallocated when the \fIres\fP structure is deinitialized. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_verify_flags.3 b/doc/manpages/gnutls_certificate_get_verify_flags.3 new file mode 100644 index 0000000..a0abac9 --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_verify_flags.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_verify_flags" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_verify_flags \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned int gnutls_certificate_get_verify_flags(gnutls_certificate_credentials_t " res ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a gnutls_certificate_credentials_t type +.SH "DESCRIPTION" +Returns the verification flags set with +\fBgnutls_certificate_set_verify_flags()\fP. +.SH "RETURNS" +The certificate verification flags used by \fIres\fP . +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_x509_crt.3 b/doc/manpages/gnutls_certificate_get_x509_crt.3 new file mode 100644 index 0000000..ed3992f --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_x509_crt.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_x509_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_x509_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_get_x509_crt(gnutls_certificate_credentials_t " res ", unsigned " index ", gnutls_x509_crt_t ** " crt_list ", unsigned * " crt_list_size ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "unsigned index" 12 +The index of the certificate list to obtain. +.IP "gnutls_x509_crt_t ** crt_list" 12 +Where to store the certificate list. +.IP "unsigned * crt_list_size" 12 +Will hold the number of certificates. +.SH "DESCRIPTION" +Obtains a X.509 certificate list that has been stored in \fIres\fP with one of +\fBgnutls_certificate_set_x509_key()\fP, \fBgnutls_certificate_set_key()\fP, +\fBgnutls_certificate_set_x509_key_file()\fP, +\fBgnutls_certificate_set_x509_key_file2()\fP, +\fBgnutls_certificate_set_x509_key_mem()\fP, or +\fBgnutls_certificate_set_x509_key_mem2()\fP. Each certificate in the returned +certificate list must be deallocated with \fBgnutls_x509_crt_deinit()\fP, and the +list itself must be freed with \fBgnutls_free()\fP. + +The \fIindex\fP matches the return value of \fBgnutls_certificate_set_x509_key()\fP and friends +functions, when the \fBGNUTLS_CERTIFICATE_API_V2\fP flag is set. + +If there is no certificate with the given index, +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. If the certificate +with the given index is not a X.509 certificate, \fBGNUTLS_E_INVALID_REQUEST\fP +is returned. The returned certificates must be deinitialized after +use, and the \fIcrt_list\fP pointer must be freed using \fBgnutls_free()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_get_x509_key.3 b/doc/manpages/gnutls_certificate_get_x509_key.3 new file mode 100644 index 0000000..a96e880 --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_x509_key.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_x509_key" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_x509_key \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_get_x509_key(gnutls_certificate_credentials_t " res ", unsigned " index ", gnutls_x509_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "unsigned index" 12 +The index of the key to obtain. +.IP "gnutls_x509_privkey_t * key" 12 +Location to store the key. +.SH "DESCRIPTION" +Obtains a X.509 private key that has been stored in \fIres\fP with one of +\fBgnutls_certificate_set_x509_key()\fP, \fBgnutls_certificate_set_key()\fP, +\fBgnutls_certificate_set_x509_key_file()\fP, +\fBgnutls_certificate_set_x509_key_file2()\fP, +\fBgnutls_certificate_set_x509_key_mem()\fP, or +\fBgnutls_certificate_set_x509_key_mem2()\fP. The returned key must be deallocated +with \fBgnutls_x509_privkey_deinit()\fP when no longer needed. + +The \fIindex\fP matches the return value of \fBgnutls_certificate_set_x509_key()\fP and friends +functions, when the \fBGNUTLS_CERTIFICATE_API_V2\fP flag is set. + +If there is no key with the given index, +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. If the key with the +given index is not a X.509 key, \fBGNUTLS_E_INVALID_REQUEST\fP is returned. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_send_x509_rdn_sequence.3 b/doc/manpages/gnutls_certificate_send_x509_rdn_sequence.3 new file mode 100644 index 0000000..1f67b9c --- /dev/null +++ b/doc/manpages/gnutls_certificate_send_x509_rdn_sequence.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_send_x509_rdn_sequence" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_send_x509_rdn_sequence \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_send_x509_rdn_sequence(gnutls_session_t " session ", int " status ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +a \fBgnutls_session_t\fP type. +.IP "int status" 12 +is 0 or 1 +.SH "DESCRIPTION" +If status is non zero, this function will order gnutls not to send +the rdnSequence in the certificate request message. That is the +server will not advertise its trusted CAs to the peer. If status +is zero then the default behaviour will take effect, which is to +advertise the server's trusted CAs. + +This function has no effect in clients, and in authentication +methods other than certificate with X.509 certificates. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_server_set_request.3 b/doc/manpages/gnutls_certificate_server_set_request.3 new file mode 100644 index 0000000..c9659ee --- /dev/null +++ b/doc/manpages/gnutls_certificate_server_set_request.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_server_set_request" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_server_set_request \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_server_set_request(gnutls_session_t " session ", gnutls_certificate_request_t " req ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_certificate_request_t req" 12 +is one of GNUTLS_CERT_REQUEST, GNUTLS_CERT_REQUIRE, GNUTLS_CERT_IGNORE +.SH "DESCRIPTION" +This function specifies if we (in case of a server) are going to +send a certificate request message to the client. If \fIreq\fP is +GNUTLS_CERT_REQUIRE then the server will return the \fBGNUTLS_E_NO_CERTIFICATE_FOUND\fP +error if the peer does not provide a certificate. If you do not call this +function then the client will not be asked to send a certificate. Invoking +the function with \fIreq\fP GNUTLS_CERT_IGNORE has the same effect. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_dh_params.3 b/doc/manpages/gnutls_certificate_set_dh_params.3 new file mode 100644 index 0000000..0dd4900 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_dh_params.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_dh_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_dh_params \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_set_dh_params(gnutls_certificate_credentials_t " res ", gnutls_dh_params_t " dh_params ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a gnutls_certificate_credentials_t type +.IP "gnutls_dh_params_t dh_params" 12 +the Diffie\-Hellman parameters. +.SH "DESCRIPTION" +This function will set the Diffie\-Hellman parameters for a +certificate server to use. These parameters will be used in +Ephemeral Diffie\-Hellman cipher suites. Note that only a pointer +to the parameters are stored in the certificate handle, so you +must not deallocate the parameters before the certificate is deallocated. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_flags.3 b/doc/manpages/gnutls_certificate_set_flags.3 new file mode 100644 index 0000000..5ae2c1c --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_flags.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_flags" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_flags \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_set_flags(gnutls_certificate_credentials_t " res ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a gnutls_certificate_credentials_t type +.IP "unsigned int flags" 12 +are the flags of \fBgnutls_certificate_flags\fP type +.SH "DESCRIPTION" +This function will set flags to tweak the operation of +the credentials structure. See the \fBgnutls_certificate_flags\fP enumerations +for more information on the available flags. +.SH "SINCE" +3.4.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_key.3 b/doc/manpages/gnutls_certificate_set_key.3 new file mode 100644 index 0000000..b0770fd --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_key.3 @@ -0,0 +1,66 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_key" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_key \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_certificate_set_key(gnutls_certificate_credentials_t " res ", const char ** " names ", int " names_size ", gnutls_pcert_st * " pcert_list ", int " pcert_list_size ", gnutls_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const char ** names" 12 +is an array of DNS names belonging to the public\-key (NULL if none) +.IP "int names_size" 12 +holds the size of the names list +.IP "gnutls_pcert_st * pcert_list" 12 +contains a certificate list (chain) or raw public\-key +.IP "int pcert_list_size" 12 +holds the size of the certificate list +.IP "gnutls_privkey_t key" 12 +is a \fBgnutls_privkey_t\fP key corresponding to the first public\-key in pcert_list +.SH "DESCRIPTION" +This function sets a public/private key pair in the +gnutls_certificate_credentials_t type. The given public key may be encapsulated +in a certificate or can be given as a raw key. This function may be +called more than once, in case multiple key pairs exist for +the server. For clients that want to send more than their own end\- +entity certificate (e.g., also an intermediate CA cert), the full +certificate chain must be provided in \fIpcert_list\fP . + +Note that the \fIkey\fP will become part of the credentials structure and must +not be deallocated. It will be automatically deallocated when the \fIres\fP structure +is deinitialized. + +If this function fails, the \fIres\fP structure is at an undefined state and it must +not be reused to load other keys or certificates. + +Note that, this function by default returns zero on success and a negative value on error. +Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP is set using \fBgnutls_certificate_set_flags()\fP +it returns an index (greater or equal to zero). That index can be used for other functions to refer to the added key\-pair. + +Since GnuTLS 3.6.6 this function also handles raw public keys. +.SH "RETURNS" +On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior). +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_known_dh_params.3 b/doc/manpages/gnutls_certificate_set_known_dh_params.3 new file mode 100644 index 0000000..0cc7960 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_known_dh_params.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_known_dh_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_known_dh_params \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_known_dh_params(gnutls_certificate_credentials_t " res ", gnutls_sec_param_t " sec_param ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a gnutls_certificate_credentials_t type +.IP "gnutls_sec_param_t sec_param" 12 +is an option of the \fBgnutls_sec_param_t\fP enumeration +.SH "DESCRIPTION" +This function will set the Diffie\-Hellman parameters for a +certificate server to use. These parameters will be used in +Ephemeral Diffie\-Hellman cipher suites and will be selected from +the FFDHE set of RFC7919 according to the security level provided. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_ocsp_status_request_file.3 b/doc/manpages/gnutls_certificate_set_ocsp_status_request_file.3 new file mode 100644 index 0000000..6d05552 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_ocsp_status_request_file.3 @@ -0,0 +1,63 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_ocsp_status_request_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_ocsp_status_request_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_ocsp_status_request_file(gnutls_certificate_credentials_t " sc ", const char * " response_file ", unsigned " idx ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a credentials structure. +.IP "const char * response_file" 12 +a filename of the OCSP response +.IP "unsigned idx" 12 +is a certificate index as returned by \fBgnutls_certificate_set_key()\fP and friends +.SH "DESCRIPTION" +This function loads the provided OCSP response. It will be +sent to the client if requests an OCSP certificate status for +the certificate chain specified by \fIidx\fP . +.SH "NOTE" +the ability to set multiple OCSP responses per credential +structure via the index \fIidx\fP was added in version 3.5.6. To keep +backwards compatibility, it requires using \fBgnutls_certificate_set_flags()\fP +with the \fBGNUTLS_CERTIFICATE_API_V2\fP flag to make the set certificate +functions return an index usable by this function. + +This function can be called multiple times since GnuTLS 3.6.3 +when multiple responses which apply to the chain are available. +If the response provided does not match any certificates present +in the chain, the code \fBGNUTLS_E_OCSP_MISMATCH_WITH_CERTS\fP is returned. +To revert to the previous behavior set the flag \fBGNUTLS_CERTIFICATE_SKIP_OCSP_RESPONSE_CHECK\fP +in the certificate credentials structure. In that case, only the +end\-certificate's OCSP response can be set. +If the response is already expired at the time of loading the code +\fBGNUTLS_E_EXPIRED\fP is returned. + +To revert to the previous behavior of this function which does not return +any errors, set the flag \fBGNUTLS_CERTIFICATE_SKIP_OCSP_RESPONSE_CHECK\fP +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_ocsp_status_request_file2.3 b/doc/manpages/gnutls_certificate_set_ocsp_status_request_file2.3 new file mode 100644 index 0000000..0df19c8 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_ocsp_status_request_file2.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_ocsp_status_request_file2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_ocsp_status_request_file2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_ocsp_status_request_file2(gnutls_certificate_credentials_t " sc ", const char * " response_file ", unsigned " idx ", gnutls_x509_crt_fmt_t " fmt ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a credentials structure. +.IP "const char * response_file" 12 +a filename of the OCSP response +.IP "unsigned idx" 12 +is a certificate index as returned by \fBgnutls_certificate_set_key()\fP and friends +.IP "gnutls_x509_crt_fmt_t fmt" 12 +is PEM or DER +.SH "DESCRIPTION" +This function loads the OCSP responses to be sent to the +peer for the certificate chain specified by \fIidx\fP . When \fIfmt\fP is +set to PEM, multiple responses can be loaded. + +This function must be called after setting any certificates, and +cannot be used for certificates that are provided via a callback \-\- +that is when \fBgnutls_certificate_set_retrieve_function()\fP is used. In +that case consider using \fBgnutls_certificate_set_retrieve_function3()\fP. + +This function can be called multiple times when multiple responses +applicable to the certificate chain are available. +If the response provided does not match any certificates present +in the chain, the code \fBGNUTLS_E_OCSP_MISMATCH_WITH_CERTS\fP is returned. +If the response is already expired at the time of loading the code +\fBGNUTLS_E_EXPIRED\fP is returned. +.SH "RETURNS" +On success, the number of loaded responses is returned, +otherwise a negative error code. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_ocsp_status_request_function.3 b/doc/manpages/gnutls_certificate_set_ocsp_status_request_function.3 new file mode 100644 index 0000000..a00042b --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_ocsp_status_request_function.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_ocsp_status_request_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_ocsp_status_request_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_set_ocsp_status_request_function(gnutls_certificate_credentials_t " sc ", gnutls_status_request_ocsp_func " ocsp_func ", void * " ptr ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_status_request_ocsp_func ocsp_func" 12 +function pointer to OCSP status request callback. +.IP "void * ptr" 12 +opaque pointer passed to callback function +.SH "DESCRIPTION" +This function is to be used by server to register a callback to +handle OCSP status requests from the client. The callback will be +invoked if the client supplied a status\-request OCSP extension. +The callback function prototype is: + +typedef int (*gnutls_status_request_ocsp_func) +(gnutls_session_t session, void *ptr, gnutls_datum_t *ocsp_response); + +The callback will be invoked if the client requests an OCSP certificate +status. The callback may return \fBGNUTLS_E_NO_CERTIFICATE_STATUS\fP, if +there is no recent OCSP response. If the callback returns \fBGNUTLS_E_SUCCESS\fP, +it is expected to have the \fIocsp_response\fP field set with a valid (DER\-encoded) +OCSP response. The response must be a value allocated using \fBgnutls_malloc()\fP, +and will be deinitialized by the caller. + +It is possible to set a specific callback for each provided certificate +using \fBgnutls_certificate_set_ocsp_status_request_function2()\fP. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_ocsp_status_request_function2.3 b/doc/manpages/gnutls_certificate_set_ocsp_status_request_function2.3 new file mode 100644 index 0000000..614c4e0 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_ocsp_status_request_function2.3 @@ -0,0 +1,65 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_ocsp_status_request_function2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_ocsp_status_request_function2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_ocsp_status_request_function2(gnutls_certificate_credentials_t " sc ", unsigned " idx ", gnutls_status_request_ocsp_func " ocsp_func ", void * " ptr ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "unsigned idx" 12 +is a certificate index as returned by \fBgnutls_certificate_set_key()\fP and friends +.IP "gnutls_status_request_ocsp_func ocsp_func" 12 +function pointer to OCSP status request callback. +.IP "void * ptr" 12 +opaque pointer passed to callback function +.SH "DESCRIPTION" +This function is to be used by server to register a callback to +provide OCSP status requests that correspond to the indexed certificate chain +from the client. The callback will be invoked if the client supplied a +status\-request OCSP extension. + +The callback function prototype is: + +typedef int (*gnutls_status_request_ocsp_func) +(gnutls_session_t session, void *ptr, gnutls_datum_t *ocsp_response); + +The callback will be invoked if the client requests an OCSP certificate +status. The callback may return \fBGNUTLS_E_NO_CERTIFICATE_STATUS\fP, if +there is no recent OCSP response. If the callback returns \fBGNUTLS_E_SUCCESS\fP, +it is expected to have the \fIocsp_response\fP field set with a valid (DER\-encoded) +OCSP response. The response must be a value allocated using \fBgnutls_malloc()\fP, +and will be deinitialized by the caller. +.SH "NOTE" +the ability to set multiple OCSP responses per credential +structure via the index \fIidx\fP was added in version 3.5.6. To keep +backwards compatibility, it requires using \fBgnutls_certificate_set_flags()\fP +with the \fBGNUTLS_CERTIFICATE_API_V2\fP flag to make the set certificate +functions return an index usable by this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "SINCE" +3.5.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_ocsp_status_request_mem.3 b/doc/manpages/gnutls_certificate_set_ocsp_status_request_mem.3 new file mode 100644 index 0000000..ac4b25d --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_ocsp_status_request_mem.3 @@ -0,0 +1,63 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_ocsp_status_request_mem" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_ocsp_status_request_mem \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_ocsp_status_request_mem(gnutls_certificate_credentials_t " sc ", const gnutls_datum_t * " resp_data ", unsigned " idx ", gnutls_x509_crt_fmt_t " fmt ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t sc" 12 +is a credentials structure. +.IP "const gnutls_datum_t * resp_data" 12 +a memory buffer holding an OCSP response +.IP "unsigned idx" 12 +is a certificate index as returned by \fBgnutls_certificate_set_key()\fP and friends +.IP "gnutls_x509_crt_fmt_t fmt" 12 +is PEM or DER +.SH "DESCRIPTION" +This function sets the OCSP responses to be sent to the +peer for the certificate chain specified by \fIidx\fP . When \fIfmt\fP is set +to PEM, multiple responses can be loaded. +.SH "NOTE" +the ability to set multiple OCSP responses per credential +structure via the index \fIidx\fP was added in version 3.5.6. To keep +backwards compatibility, it requires using \fBgnutls_certificate_set_flags()\fP +with the \fBGNUTLS_CERTIFICATE_API_V2\fP flag to make the set certificate +functions return an index usable by this function. + +This function must be called after setting any certificates, and +cannot be used for certificates that are provided via a callback \-\- +that is when \fBgnutls_certificate_set_retrieve_function()\fP is used. + +This function can be called multiple times when multiple responses which +apply to the certificate chain are available. +If the response provided does not match any certificates present +in the chain, the code \fBGNUTLS_E_OCSP_MISMATCH_WITH_CERTS\fP is returned. +If the response is already expired at the time of loading the code +\fBGNUTLS_E_EXPIRED\fP is returned. +.SH "RETURNS" +On success, the number of loaded responses is returned, +otherwise a negative error code. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_params_function.3 b/doc/manpages/gnutls_certificate_set_params_function.3 new file mode 100644 index 0000000..d913756 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_params_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_params_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_params_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_set_params_function(gnutls_certificate_credentials_t " res ", gnutls_params_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a gnutls_certificate_credentials_t type +.IP "gnutls_params_function * func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback in order for the server to get +the Diffie\-Hellman or RSA parameters for certificate +authentication. The callback should return \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_pin_function.3 b/doc/manpages/gnutls_certificate_set_pin_function.3 new file mode 100644 index 0000000..482da88 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_pin_function.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_pin_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_pin_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_set_pin_function(gnutls_certificate_credentials_t " cred ", gnutls_pin_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_pin_callback_t fn" 12 +A PIN callback +.IP "void * userdata" 12 +Data to be passed in the callback +.SH "DESCRIPTION" +This function will set a callback function to be used when +required to access a protected object. This function overrides any other +global PIN functions. + +Note that this function must be called right after initialization +to have effect. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_rawpk_key_file.3 b/doc/manpages/gnutls_certificate_set_rawpk_key_file.3 new file mode 100644 index 0000000..90da7e3 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_rawpk_key_file.3 @@ -0,0 +1,90 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_rawpk_key_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_rawpk_key_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_rawpk_key_file(gnutls_certificate_credentials_t " cred ", const char* " rawpkfile ", const char* " privkeyfile ", gnutls_x509_crt_fmt_t " format ", const char * " pass ", unsigned int " key_usage ", const char ** " names ", unsigned int " names_length ", unsigned int " privkey_flags ", unsigned int " pkcs11_flags ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const char* rawpkfile" 12 +contains a raw public key in +PKIX.SubjectPublicKeyInfo format. +.IP "const char* privkeyfile" 12 +contains a file path to a private key. +.IP "gnutls_x509_crt_fmt_t format" 12 +encoding of the keys. DER or PEM. +.IP "const char * pass" 12 +an optional password to unlock the private key privkeyfile. +.IP "unsigned int key_usage" 12 +an ORed sequence of \fBGNUTLS_KEY_\fP* flags. +.IP "const char ** names" 12 +is an array of DNS names belonging to the public\-key (NULL if none). +.IP "unsigned int names_length" 12 +holds the length of the names list. +.IP "unsigned int privkey_flags" 12 +an ORed sequence of \fBgnutls_pkcs_encrypt_flags_t\fP. +These apply to the private key pkey. +.IP "unsigned int pkcs11_flags" 12 +one of gnutls_pkcs11_obj_flags. These apply to URLs. +.SH "DESCRIPTION" +This function sets a public/private keypair read from file in the +\fBgnutls_certificate_credentials_t\fP type to be used for authentication +and/or encryption. \fIspki\fP and \fIprivkey\fP should match otherwise set +signatures cannot be validated. In case of no match this function +returns \fBGNUTLS_E_CERTIFICATE_KEY_MISMATCH\fP. This function should +be called once for the client because there is currently no mechanism +to determine which raw public\-key to select for the peer when there +are multiple present. Multiple raw public keys for the server can be +distinghuished by setting the \fInames\fP . + +Note here that \fIspki\fP is a raw public\-key as defined +in RFC7250. It means that there is no surrounding certificate that +holds the public key and that there is therefore no direct mechanism +to prove the authenticity of this key. The keypair can be used during +a TLS handshake but its authenticity should be established via a +different mechanism (e.g. TOFU or known fingerprint). + +The supported formats are basic unencrypted key, PKCS8, PKCS12, +and the openssl format and will be autodetected. + +If the raw public\-key and the private key are given in PEM encoding +then the strings that hold their values must be null terminated. + +Key usage (as defined by X.509 extension (2.5.29.15)) can be explicitly +set because there is no certificate structure around the key to define +this value. See for more info \fBgnutls_x509_crt_get_key_usage()\fP. + +Note that, this function by default returns zero on success and a +negative value on error. Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP +is set using \fBgnutls_certificate_set_flags()\fP it returns an index +(greater or equal to zero). That index can be used in other functions +to refer to the added key\-pair. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, in case the +key pair does not match \fBGNUTLS_E_CERTIFICATE_KEY_MISMATCH\fP is returned, +in other erroneous cases a different negative error code is returned. +.SH "SINCE" +3.6.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_rawpk_key_mem.3 b/doc/manpages/gnutls_certificate_set_rawpk_key_mem.3 new file mode 100644 index 0000000..acd12bc --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_rawpk_key_mem.3 @@ -0,0 +1,88 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_rawpk_key_mem" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_rawpk_key_mem \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_rawpk_key_mem(gnutls_certificate_credentials_t " cred ", const gnutls_datum_t* " spki ", const gnutls_datum_t* " pkey ", gnutls_x509_crt_fmt_t " format ", const char* " pass ", unsigned int " key_usage ", const char ** " names ", unsigned int " names_length ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const gnutls_datum_t* spki" 12 +contains a raw public key in +PKIX.SubjectPublicKeyInfo format. +.IP "const gnutls_datum_t* pkey" 12 +contains a raw private key. +.IP "gnutls_x509_crt_fmt_t format" 12 +encoding of the keys. DER or PEM. +.IP "const char* pass" 12 +an optional password to unlock the private key pkey. +.IP "unsigned int key_usage" 12 +An ORed sequence of \fBGNUTLS_KEY_\fP* flags. +.IP "const char ** names" 12 +is an array of DNS names belonging to the public\-key (NULL if none). +.IP "unsigned int names_length" 12 +holds the length of the names list. +.IP "unsigned int flags" 12 +an ORed sequence of \fBgnutls_pkcs_encrypt_flags_t\fP. +These apply to the private key pkey. +.SH "DESCRIPTION" +This function sets a public/private keypair in the +\fBgnutls_certificate_credentials_t\fP type to be used for authentication +and/or encryption. \fIspki\fP and \fIprivkey\fP should match otherwise set +signatures cannot be validated. In case of no match this function +returns \fBGNUTLS_E_CERTIFICATE_KEY_MISMATCH\fP. This function should +be called once for the client because there is currently no mechanism +to determine which raw public\-key to select for the peer when there +are multiple present. Multiple raw public keys for the server can be +distinghuished by setting the \fInames\fP . + +Note here that \fIspki\fP is a raw public\-key as defined +in RFC7250. It means that there is no surrounding certificate that +holds the public key and that there is therefore no direct mechanism +to prove the authenticity of this key. The keypair can be used during +a TLS handshake but its authenticity should be established via a +different mechanism (e.g. TOFU or known fingerprint). + +The supported formats are basic unencrypted key, PKCS8, PKCS12, +and the openssl format and will be autodetected. + +If the raw public\-key and the private key are given in PEM encoding +then the strings that hold their values must be null terminated. + +Key usage (as defined by X.509 extension (2.5.29.15)) can be explicitly +set because there is no certificate structure around the key to define +this value. See for more info \fBgnutls_x509_crt_get_key_usage()\fP. + +Note that, this function by default returns zero on success and a +negative value on error. Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP +is set using \fBgnutls_certificate_set_flags()\fP it returns an index +(greater or equal to zero). That index can be used in other functions +to refer to the added key\-pair. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, in case the +key pair does not match \fBGNUTLS_E_CERTIFICATE_KEY_MISMATCH\fP is returned, +in other erroneous cases a different negative error code is returned. +.SH "SINCE" +3.6.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_retrieve_function.3 b/doc/manpages/gnutls_certificate_set_retrieve_function.3 new file mode 100644 index 0000000..4cb0043 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_retrieve_function.3 @@ -0,0 +1,68 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_retrieve_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_retrieve_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_set_retrieve_function(gnutls_certificate_credentials_t " cred ", gnutls_certificate_retrieve_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_certificate_retrieve_function * func" 12 +is the callback function +.SH "DESCRIPTION" +This function sets a callback to be called in order to retrieve the +certificate to be used in the handshake. The callback will take control +only if a certificate is requested by the peer. You are advised +to use \fBgnutls_certificate_set_retrieve_function2()\fP because it +is much more efficient in the processing it requires from gnutls. + +The callback's function prototype is: +int (*callback)(gnutls_session_t, const gnutls_datum_t* req_ca_dn, int nreqs, +const gnutls_pk_algorithm_t* pk_algos, int pk_algos_length, gnutls_retr2_st* st); + + \fIreq_ca_dn\fP is only used in X.509 certificates. +Contains a list with the CA names that the server considers trusted. +This is a hint and typically the client should send a certificate that is signed +by one of these CAs. These names, when available, are DER encoded. To get a more +meaningful value use the function \fBgnutls_x509_rdn_get()\fP. + + \fIpk_algos\fP contains a list with server's acceptable public key algorithms. +The certificate returned should support the server's given algorithms. + + \fIst\fP should contain the certificates and private keys. + +If the callback function is provided then gnutls will call it, in the +handshake, after the certificate request message has been received. + +In server side pk_algos and req_ca_dn are NULL. + +The callback function should set the certificate list to be sent, +and return 0 on success. If no certificate was selected then the +number of certificates should be set to zero. The value (\-1) +indicates error and the handshake will be terminated. If both certificates +are set in the credentials and a callback is available, the callback +takes predence. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_retrieve_function2.3 b/doc/manpages/gnutls_certificate_set_retrieve_function2.3 new file mode 100644 index 0000000..0c6fd6c --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_retrieve_function2.3 @@ -0,0 +1,73 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_retrieve_function2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_retrieve_function2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "void gnutls_certificate_set_retrieve_function2(gnutls_certificate_credentials_t " cred ", gnutls_certificate_retrieve_function2 * " func ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_certificate_retrieve_function2 * func" 12 +is the callback function +.SH "DESCRIPTION" +This function sets a callback to be called in order to retrieve the +certificate to be used in the handshake. The callback will take control +only if a certificate is requested by the peer. + +The callback's function prototype is: +int (*callback)(gnutls_session_t, const gnutls_datum_t* req_ca_dn, int nreqs, +const gnutls_pk_algorithm_t* pk_algos, int pk_algos_length, gnutls_pcert_st** pcert, +unsigned int *pcert_length, gnutls_privkey_t * pkey); + + \fIreq_ca_dn\fP is only used in X.509 certificates. +Contains a list with the CA names that the server considers trusted. +This is a hint and typically the client should send a certificate that is signed +by one of these CAs. These names, when available, are DER encoded. To get a more +meaningful value use the function \fBgnutls_x509_rdn_get()\fP. + + \fIpk_algos\fP contains a list with server's acceptable public key algorithms. +The certificate returned should support the server's given algorithms. + + \fIpcert\fP should contain a single certificate and public key or a list of them. + + \fIpcert_length\fP is the size of the previous list. + + \fIpkey\fP is the private key. + +If the callback function is provided then gnutls will call it, in the +handshake, after the certificate request message has been received. +All the provided by the callback values will not be released or +modified by gnutls. + +In server side pk_algos and req_ca_dn are NULL. + +The callback function should set the certificate list to be sent, +and return 0 on success. If no certificate was selected then the +number of certificates should be set to zero. The value (\-1) +indicates error and the handshake will be terminated. If both certificates +are set in the credentials and a callback is available, the callback +takes predence. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_retrieve_function3.3 b/doc/manpages/gnutls_certificate_set_retrieve_function3.3 new file mode 100644 index 0000000..08857a8 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_retrieve_function3.3 @@ -0,0 +1,86 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_retrieve_function3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_retrieve_function3 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "void gnutls_certificate_set_retrieve_function3(gnutls_certificate_credentials_t " cred ", gnutls_certificate_retrieve_function3 * " func ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_certificate_retrieve_function3 * func" 12 +is the callback function +.SH "DESCRIPTION" +This function sets a callback to be called in order to retrieve the +certificate and OCSP responses to be used in the handshake. \fIfunc\fP will +be called only if the peer requests a certificate either during handshake +or during post\-handshake authentication. + +The callback's function prototype is defined in `abstract.h': + +int gnutls_certificate_retrieve_function3( +gnutls_session_t, +const struct gnutls_cert_retr_st *info, +gnutls_pcert_st **certs, +unsigned int *certs_length, +gnutls_ocsp_data_st **ocsp, +unsigned int *ocsp_length, +gnutls_privkey_t *privkey, +unsigned int *flags); + +The info field of the callback contains: + \fIreq_ca_dn\fP which is a list with the CA names that the server considers trusted. +This is a hint and typically the client should send a certificate that is signed +by one of these CAs. These names, when available, are DER encoded. To get a more +meaningful value use the function \fBgnutls_x509_rdn_get()\fP. + \fIpk_algos\fP contains a list with server's acceptable public key algorithms. +The certificate returned should support the server's given algorithms. + +The callback should fill\-in the following values: + + \fIcerts\fP should contain an allocated list of certificates and public keys. + \fIcerts_length\fP is the size of the previous list. + \fIocsp\fP should contain an allocated list of OCSP responses. + \fIocsp_length\fP is the size of the previous list. + \fIprivkey\fP is the private key. + +If flags in the callback are set to \fBGNUTLS_CERT_RETR_DEINIT_ALL\fP then +all provided values must be allocated using \fBgnutls_malloc()\fP, and will +be released by gnutls; otherwise they will not be touched by gnutls. + +The callback function should set the certificate and OCSP response +list to be sent, and return 0 on success. If no certificates are available, +the \fIcerts_length\fP and \fIocsp_length\fP should be set to zero. The return +value (\-1) indicates error and the handshake will be terminated. If both +certificates are set in the credentials and a callback is available, the +callback takes predence. + +Raw public\-keys: +In case raw public\-keys are negotiated as certificate type, certificates +that would normally hold the public\-key material are not available. In that case, + \fIcerts\fP contains an allocated list with only the public key. Since there is no +certificate, there is also no certificate status. Therefore, OCSP information +should not be set. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_trust_list.3 b/doc/manpages/gnutls_certificate_set_trust_list.3 new file mode 100644 index 0000000..e954e86 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_trust_list.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_trust_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_trust_list \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_certificate_set_trust_list(gnutls_certificate_credentials_t " res ", gnutls_x509_trust_list_t " tlist ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_x509_trust_list_t tlist" 12 +is a \fBgnutls_x509_trust_list_t\fP type +.IP "unsigned flags" 12 +must be zero +.SH "DESCRIPTION" +This function sets a trust list in the gnutls_certificate_credentials_t type. + +Note that the \fItlist\fP will become part of the credentials +structure and must not be deallocated. It will be automatically deallocated +when the \fIres\fP structure is deinitialized. +.SH "SINCE" +3.2.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_verify_flags.3 b/doc/manpages/gnutls_certificate_set_verify_flags.3 new file mode 100644 index 0000000..7fd483b --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_verify_flags.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_verify_flags" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_verify_flags \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_set_verify_flags(gnutls_certificate_credentials_t " res ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a gnutls_certificate_credentials_t type +.IP "unsigned int flags" 12 +are the flags +.SH "DESCRIPTION" +This function will set the flags to be used for verification +of certificates and override any defaults. The provided flags must be an OR of the +\fBgnutls_certificate_verify_flags\fP enumerations. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_verify_function.3 b/doc/manpages/gnutls_certificate_set_verify_function.3 new file mode 100644 index 0000000..96abe68 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_verify_function.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_verify_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_verify_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_set_verify_function(gnutls_certificate_credentials_t " cred ", gnutls_certificate_verify_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_certificate_verify_function * func" 12 +is the callback function +.SH "DESCRIPTION" +This function sets a callback to be called when peer's certificate +has been received in order to verify it on receipt rather than +doing after the handshake is completed. + +The callback's function prototype is: +int (*callback)(gnutls_session_t); + +If the callback function is provided then gnutls will call it, in the +handshake, just after the certificate message has been received. +To verify or obtain the certificate the \fBgnutls_certificate_verify_peers2()\fP, +\fBgnutls_certificate_type_get()\fP, \fBgnutls_certificate_get_peers()\fP functions +can be used. + +The callback function should return 0 for the handshake to continue +or non\-zero to terminate. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_verify_limits.3 b/doc/manpages/gnutls_certificate_set_verify_limits.3 new file mode 100644 index 0000000..f871451 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_verify_limits.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_verify_limits" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_verify_limits \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_certificate_set_verify_limits(gnutls_certificate_credentials_t " res ", unsigned int " max_bits ", unsigned int " max_depth ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a gnutls_certificate_credentials type +.IP "unsigned int max_bits" 12 +is the number of bits of an acceptable certificate (default 8200) +.IP "unsigned int max_depth" 12 +is maximum depth of the verification of a certificate chain (default 5) +.SH "DESCRIPTION" +This function will set some upper limits for the default +verification function, \fBgnutls_certificate_verify_peers2()\fP, to avoid +denial of service attacks. You can set them to zero to disable +limits. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_crl.3 b/doc/manpages/gnutls_certificate_set_x509_crl.3 new file mode 100644 index 0000000..44db84f --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_crl.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_crl" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_crl \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_crl(gnutls_certificate_credentials_t " res ", gnutls_x509_crl_t * " crl_list ", int " crl_list_size ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_x509_crl_t * crl_list" 12 +is a list of trusted CRLs. They should have been verified before. +.IP "int crl_list_size" 12 +holds the size of the crl_list +.SH "DESCRIPTION" +This function adds the trusted CRLs in order to verify client or +server certificates. In case of a client this is not required to +be called if the certificates are not verified using +\fBgnutls_certificate_verify_peers2()\fP. This function may be called +multiple times. +.SH "RETURNS" +number of CRLs processed, or a negative error code on error. +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_crl_file.3 b/doc/manpages/gnutls_certificate_set_x509_crl_file.3 new file mode 100644 index 0000000..cfd0274 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_crl_file.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_crl_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_crl_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_crl_file(gnutls_certificate_credentials_t " res ", const char * " crlfile ", gnutls_x509_crt_fmt_t " type ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const char * crlfile" 12 +is a file containing the list of verified CRLs (DER or PEM list) +.IP "gnutls_x509_crt_fmt_t type" 12 +is PEM or DER +.SH "DESCRIPTION" +This function adds the trusted CRLs in order to verify client or server +certificates. In case of a client this is not required +to be called if the certificates are not verified using +\fBgnutls_certificate_verify_peers2()\fP. +This function may be called multiple times. +.SH "RETURNS" +number of CRLs processed or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_crl_mem.3 b/doc/manpages/gnutls_certificate_set_x509_crl_mem.3 new file mode 100644 index 0000000..684de3d --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_crl_mem.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_crl_mem" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_crl_mem \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_crl_mem(gnutls_certificate_credentials_t " res ", const gnutls_datum_t * " CRL ", gnutls_x509_crt_fmt_t " type ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const gnutls_datum_t * CRL" 12 +is a list of trusted CRLs. They should have been verified before. +.IP "gnutls_x509_crt_fmt_t type" 12 +is DER or PEM +.SH "DESCRIPTION" +This function adds the trusted CRLs in order to verify client or +server certificates. In case of a client this is not required to +be called if the certificates are not verified using +\fBgnutls_certificate_verify_peers2()\fP. This function may be called +multiple times. +.SH "RETURNS" +number of CRLs processed, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_key.3 b/doc/manpages/gnutls_certificate_set_x509_key.3 new file mode 100644 index 0000000..1a9a4ac --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_key.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_key" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_key \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_key(gnutls_certificate_credentials_t " res ", gnutls_x509_crt_t * " cert_list ", int " cert_list_size ", gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_x509_crt_t * cert_list" 12 +contains a certificate list (path) for the specified private key +.IP "int cert_list_size" 12 +holds the size of the certificate list +.IP "gnutls_x509_privkey_t key" 12 +is a \fBgnutls_x509_privkey_t\fP key +.SH "DESCRIPTION" +This function sets a certificate/private key pair in the +gnutls_certificate_credentials_t type. This function may be +called more than once, in case multiple keys/certificates exist for +the server. For clients that wants to send more than their own end +entity certificate (e.g., also an intermediate CA cert) then put +the certificate chain in \fIcert_list\fP . + +Note that the certificates and keys provided, can be safely deinitialized +after this function is called. + +If that function fails to load the \fIres\fP type is at an undefined state, it must +not be reused to load other keys or certificates. + +Note that, this function by default returns zero on success and a negative value on error. +Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP is set using \fBgnutls_certificate_set_flags()\fP +it returns an index (greater or equal to zero). That index can be used to other functions to refer to the added key\-pair. +.SH "RETURNS" +On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior). +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_key_file.3 b/doc/manpages/gnutls_certificate_set_x509_key_file.3 new file mode 100644 index 0000000..c2d123c --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_key_file.3 @@ -0,0 +1,67 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_key_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_key_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_key_file(gnutls_certificate_credentials_t " res ", const char * " certfile ", const char * " keyfile ", gnutls_x509_crt_fmt_t " type ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const char * certfile" 12 +is a file that containing the certificate list (path) for +the specified private key, in PKCS7 format, or a list of certificates +.IP "const char * keyfile" 12 +is a file that contains the private key +.IP "gnutls_x509_crt_fmt_t type" 12 +is PEM or DER +.SH "DESCRIPTION" +This function sets a certificate/private key pair in the +gnutls_certificate_credentials_t type. This function may be +called more than once, in case multiple keys/certificates exist for +the server. For clients that need to send more than its own end +entity certificate, e.g., also an intermediate CA cert, then the + \fIcertfile\fP must contain the ordered certificate chain. + +Note that the names in the certificate provided will be considered +when selecting the appropriate certificate to use (in case of multiple +certificate/key pairs). + +This function can also accept URLs at \fIkeyfile\fP and \fIcertfile\fP . In that case it +will use the private key and certificate indicated by the URLs. Note +that the supported URLs are the ones indicated by \fBgnutls_url_is_supported()\fP. + +In case the \fIcertfile\fP is provided as a PKCS \fB11\fP URL, then the certificate, and its +present issuers in the token are imported (i.e., forming the required trust chain). + +If that function fails to load the \fIres\fP structure is at an undefined state, it must +not be reused to load other keys or certificates. + +Note that, this function by default returns zero on success and a negative value on error. +Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP is set using \fBgnutls_certificate_set_flags()\fP +it returns an index (greater or equal to zero). That index can be used to other functions to refer to the added key\-pair. +.SH "RETURNS" +On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior). +.SH "SINCE" +3.1.11 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_key_file2.3 b/doc/manpages/gnutls_certificate_set_x509_key_file2.3 new file mode 100644 index 0000000..5c1250f --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_key_file2.3 @@ -0,0 +1,71 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_key_file2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_key_file2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_key_file2(gnutls_certificate_credentials_t " res ", const char * " certfile ", const char * " keyfile ", gnutls_x509_crt_fmt_t " type ", const char * " pass ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const char * certfile" 12 +is a file that containing the certificate list (path) for +the specified private key, in PKCS7 format, or a list of certificates +.IP "const char * keyfile" 12 +is a file that contains the private key +.IP "gnutls_x509_crt_fmt_t type" 12 +is PEM or DER +.IP "const char * pass" 12 +is the password of the key +.IP "unsigned int flags" 12 +an ORed sequence of gnutls_pkcs_encrypt_flags_t +.SH "DESCRIPTION" +This function sets a certificate/private key pair in the +gnutls_certificate_credentials_t type. This function may be +called more than once, in case multiple keys/certificates exist for +the server. For clients that need to send more than its own end +entity certificate, e.g., also an intermediate CA cert, then the + \fIcertfile\fP must contain the ordered certificate chain. + +Note that the names in the certificate provided will be considered +when selecting the appropriate certificate to use (in case of multiple +certificate/key pairs). + +This function can also accept URLs at \fIkeyfile\fP and \fIcertfile\fP . In that case it +will use the private key and certificate indicated by the URLs. Note +that the supported URLs are the ones indicated by \fBgnutls_url_is_supported()\fP. +Before GnuTLS 3.4.0 when a URL was specified, the \fIpass\fP part was ignored and a +PIN callback had to be registered, this is no longer the case in current releases. + +In case the \fIcertfile\fP is provided as a PKCS \fB11\fP URL, then the certificate, and its +present issuers in the token are imported (i.e., forming the required trust chain). + +If that function fails to load the \fIres\fP structure is at an undefined state, it must +not be reused to load other keys or certificates. + +Note that, this function by default returns zero on success and a negative value on error. +Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP is set using \fBgnutls_certificate_set_flags()\fP +it returns an index (greater or equal to zero). That index can be used to other functions to refer to the added key\-pair. +.SH "RETURNS" +On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior). +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_key_mem.3 b/doc/manpages/gnutls_certificate_set_x509_key_mem.3 new file mode 100644 index 0000000..53c3c75 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_key_mem.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_key_mem" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_key_mem \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_key_mem(gnutls_certificate_credentials_t " res ", const gnutls_datum_t * " cert ", const gnutls_datum_t * " key ", gnutls_x509_crt_fmt_t " type ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const gnutls_datum_t * cert" 12 +contains a certificate list (path) for the specified private key +.IP "const gnutls_datum_t * key" 12 +is the private key, or \fBNULL\fP +.IP "gnutls_x509_crt_fmt_t type" 12 +is PEM or DER +.SH "DESCRIPTION" +This function sets a certificate/private key pair in the +gnutls_certificate_credentials_t type. This function may be called +more than once, in case multiple keys/certificates exist for the +server. + +Note that the keyUsage (2.5.29.15) PKIX extension in X.509 certificates +is supported. This means that certificates intended for signing cannot +be used for ciphersuites that require encryption. + +If the certificate and the private key are given in PEM encoding +then the strings that hold their values must be null terminated. + +The \fIkey\fP may be \fBNULL\fP if you are using a sign callback, see +\fBgnutls_sign_callback_set()\fP. + +Note that, this function by default returns zero on success and a negative value on error. +Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP is set using \fBgnutls_certificate_set_flags()\fP +it returns an index (greater or equal to zero). That index can be used to other functions to refer to the added key\-pair. +.SH "RETURNS" +On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior). +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_key_mem2.3 b/doc/manpages/gnutls_certificate_set_x509_key_mem2.3 new file mode 100644 index 0000000..f63ddc7 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_key_mem2.3 @@ -0,0 +1,62 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_key_mem2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_key_mem2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_key_mem2(gnutls_certificate_credentials_t " res ", const gnutls_datum_t * " cert ", const gnutls_datum_t * " key ", gnutls_x509_crt_fmt_t " type ", const char * " pass ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const gnutls_datum_t * cert" 12 +contains a certificate list (path) for the specified private key +.IP "const gnutls_datum_t * key" 12 +is the private key, or \fBNULL\fP +.IP "gnutls_x509_crt_fmt_t type" 12 +is PEM or DER +.IP "const char * pass" 12 +is the key's password +.IP "unsigned int flags" 12 +an ORed sequence of gnutls_pkcs_encrypt_flags_t +.SH "DESCRIPTION" +This function sets a certificate/private key pair in the +gnutls_certificate_credentials_t type. This function may be called +more than once, in case multiple keys/certificates exist for the +server. + +Note that the keyUsage (2.5.29.15) PKIX extension in X.509 certificates +is supported. This means that certificates intended for signing cannot +be used for ciphersuites that require encryption. + +If the certificate and the private key are given in PEM encoding +then the strings that hold their values must be null terminated. + +The \fIkey\fP may be \fBNULL\fP if you are using a sign callback, see +\fBgnutls_sign_callback_set()\fP. + +Note that, this function by default returns zero on success and a negative value on error. +Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP is set using \fBgnutls_certificate_set_flags()\fP +it returns an index (greater or equal to zero). That index can be used to other functions to refer to the added key\-pair. +.SH "RETURNS" +On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior). +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_simple_pkcs12_file.3 b/doc/manpages/gnutls_certificate_set_x509_simple_pkcs12_file.3 new file mode 100644 index 0000000..06e0472 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_simple_pkcs12_file.3 @@ -0,0 +1,67 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_simple_pkcs12_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_simple_pkcs12_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_simple_pkcs12_file(gnutls_certificate_credentials_t " res ", const char * " pkcs12file ", gnutls_x509_crt_fmt_t " type ", const char * " password ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const char * pkcs12file" 12 +filename of file containing PKCS\fB12\fP blob. +.IP "gnutls_x509_crt_fmt_t type" 12 +is PEM or DER of the \fIpkcs12file\fP . +.IP "const char * password" 12 +optional password used to decrypt PKCS\fB12\fP file, bags and keys. +.SH "DESCRIPTION" +This function sets a certificate/private key pair and/or a CRL in +the gnutls_certificate_credentials_t type. This function may +be called more than once (in case multiple keys/certificates exist +for the server). + +PKCS\fB12\fP files with a MAC, encrypted bags and PKCS \fB8\fP +private keys are supported. However, +only password based security, and the same password for all +operations, are supported. + +PKCS\fB12\fP file may contain many keys and/or certificates, and this +function will try to auto\-detect based on the key ID the certificate +and key pair to use. If the PKCS\fB12\fP file contain the issuer of +the selected certificate, it will be appended to the certificate +to form a chain. + +If more than one private keys are stored in the PKCS\fB12\fP file, +then only one key will be read (and it is undefined which one). + +It is believed that the limitations of this function is acceptable +for most usage, and that any more flexibility would introduce +complexity that would make it harder to use this functionality at +all. + +Note that, this function by default returns zero on success and a negative value on error. +Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP is set using \fBgnutls_certificate_set_flags()\fP +it returns an index (greater or equal to zero). That index can be used to other functions to refer to the added key\-pair. +.SH "RETURNS" +On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior). +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_simple_pkcs12_mem.3 b/doc/manpages/gnutls_certificate_set_x509_simple_pkcs12_mem.3 new file mode 100644 index 0000000..a46b963 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_simple_pkcs12_mem.3 @@ -0,0 +1,68 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_simple_pkcs12_mem" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_simple_pkcs12_mem \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_simple_pkcs12_mem(gnutls_certificate_credentials_t " res ", const gnutls_datum_t * " p12blob ", gnutls_x509_crt_fmt_t " type ", const char * " password ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const gnutls_datum_t * p12blob" 12 +the PKCS\fB12\fP blob. +.IP "gnutls_x509_crt_fmt_t type" 12 +is PEM or DER of the \fIpkcs12file\fP . +.IP "const char * password" 12 +optional password used to decrypt PKCS\fB12\fP file, bags and keys. +.SH "DESCRIPTION" +This function sets a certificate/private key pair and/or a CRL in +the gnutls_certificate_credentials_t type. This function may +be called more than once (in case multiple keys/certificates exist +for the server). + +Encrypted PKCS\fB12\fP bags and PKCS\fB8\fP private keys are supported. However, +only password based security, and the same password for all +operations, are supported. + +PKCS\fB12\fP file may contain many keys and/or certificates, and this +function will try to auto\-detect based on the key ID the certificate +and key pair to use. If the PKCS\fB12\fP file contain the issuer of +the selected certificate, it will be appended to the certificate +to form a chain. + +If more than one private keys are stored in the PKCS\fB12\fP file, +then only one key will be read (and it is undefined which one). + +It is believed that the limitations of this function is acceptable +for most usage, and that any more flexibility would introduce +complexity that would make it harder to use this functionality at +all. + +Note that, this function by default returns zero on success and a negative value on error. +Since 3.5.6, when the flag \fBGNUTLS_CERTIFICATE_API_V2\fP is set using \fBgnutls_certificate_set_flags()\fP +it returns an index (greater or equal to zero). That index can be used to other functions to refer to the added key\-pair. +.SH "RETURNS" +On success this functions returns zero, and otherwise a negative value on error (see above for modifying that behavior). +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_system_trust.3 b/doc/manpages/gnutls_certificate_set_x509_system_trust.3 new file mode 100644 index 0000000..5af21ce --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_system_trust.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_system_trust" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_system_trust \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_system_trust(gnutls_certificate_credentials_t " cred ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.SH "DESCRIPTION" +This function adds the system's default trusted CAs in order to +verify client or server certificates. + +In the case the system is currently unsupported \fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP +is returned. +.SH "RETURNS" +the number of certificates processed or a negative error code +on error. +.SH "SINCE" +3.0.20 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_trust.3 b/doc/manpages/gnutls_certificate_set_x509_trust.3 new file mode 100644 index 0000000..e3b6a9e --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_trust.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_trust" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_trust \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_trust(gnutls_certificate_credentials_t " res ", gnutls_x509_crt_t * " ca_list ", int " ca_list_size ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "gnutls_x509_crt_t * ca_list" 12 +is a list of trusted CAs +.IP "int ca_list_size" 12 +holds the size of the CA list +.SH "DESCRIPTION" +This function adds the trusted CAs in order to verify client +or server certificates. In case of a client this is not required +to be called if the certificates are not verified using +\fBgnutls_certificate_verify_peers2()\fP. +This function may be called multiple times. + +In case of a server the CAs set here will be sent to the client if +a certificate request is sent. This can be disabled using +\fBgnutls_certificate_send_x509_rdn_sequence()\fP. +.SH "RETURNS" +the number of certificates processed or a negative error code +on error. +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_trust_dir.3 b/doc/manpages/gnutls_certificate_set_x509_trust_dir.3 new file mode 100644 index 0000000..ab08695 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_trust_dir.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_trust_dir" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_trust_dir \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_trust_dir(gnutls_certificate_credentials_t " cred ", const char * " ca_dir ", gnutls_x509_crt_fmt_t " type ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const char * ca_dir" 12 +is a directory containing the list of trusted CAs (DER or PEM list) +.IP "gnutls_x509_crt_fmt_t type" 12 +is PEM or DER +.SH "DESCRIPTION" +This function adds the trusted CAs present in the directory in order to +verify client or server certificates. This function is identical +to \fBgnutls_certificate_set_x509_trust_file()\fP but loads all certificates +in a directory. +.SH "RETURNS" +the number of certificates processed +.SH "SINCE" +3.3.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_trust_file.3 b/doc/manpages/gnutls_certificate_set_x509_trust_file.3 new file mode 100644 index 0000000..c564bdb --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_trust_file.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_trust_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_trust_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_trust_file(gnutls_certificate_credentials_t " cred ", const char * " cafile ", gnutls_x509_crt_fmt_t " type ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t cred" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const char * cafile" 12 +is a file containing the list of trusted CAs (DER or PEM list) +.IP "gnutls_x509_crt_fmt_t type" 12 +is PEM or DER +.SH "DESCRIPTION" +This function adds the trusted CAs in order to verify client or +server certificates. In case of a client this is not required to +be called if the certificates are not verified using +\fBgnutls_certificate_verify_peers2()\fP. This function may be called +multiple times. + +In case of a server the names of the CAs set here will be sent to +the client if a certificate request is sent. This can be disabled +using \fBgnutls_certificate_send_x509_rdn_sequence()\fP. + +This function can also accept URLs. In that case it +will import all certificates that are marked as trusted. Note +that the supported URLs are the ones indicated by \fBgnutls_url_is_supported()\fP. +.SH "RETURNS" +the number of certificates processed +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_set_x509_trust_mem.3 b/doc/manpages/gnutls_certificate_set_x509_trust_mem.3 new file mode 100644 index 0000000..c4f8473 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_trust_mem.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_trust_mem" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_trust_mem \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_set_x509_trust_mem(gnutls_certificate_credentials_t " res ", const gnutls_datum_t * " ca ", gnutls_x509_crt_fmt_t " type ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type. +.IP "const gnutls_datum_t * ca" 12 +is a list of trusted CAs or a DER certificate +.IP "gnutls_x509_crt_fmt_t type" 12 +is DER or PEM +.SH "DESCRIPTION" +This function adds the trusted CAs in order to verify client or +server certificates. In case of a client this is not required to be +called if the certificates are not verified using +\fBgnutls_certificate_verify_peers2()\fP. This function may be called +multiple times. + +In case of a server the CAs set here will be sent to the client if +a certificate request is sent. This can be disabled using +\fBgnutls_certificate_send_x509_rdn_sequence()\fP. +.SH "RETURNS" +the number of certificates processed or a negative error code +on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_type_get.3 b/doc/manpages/gnutls_certificate_type_get.3 new file mode 100644 index 0000000..60bb718 --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_get.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_certificate_type_t gnutls_certificate_type_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function returns the type of the certificate that is negotiated +for this side to send to the peer. The certificate type is by default +X.509, unless an alternative certificate type is enabled by +\fBgnutls_init()\fP and negotiated during the session. + +Resumed sessions will return the certificate type that was negotiated +and used in the original session. + +As of version 3.6.4 it is recommended to use +\fBgnutls_certificate_type_get2()\fP which is more fine\-grained. +.SH "RETURNS" +the currently used \fBgnutls_certificate_type_t\fP certificate +type as negotiated for 'our' side of the connection. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_type_get2.3 b/doc/manpages/gnutls_certificate_type_get2.3 new file mode 100644 index 0000000..88a0c8a --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_get2.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_get2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_get2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_certificate_type_t gnutls_certificate_type_get2(gnutls_session_t " session ", gnutls_ctype_target_t " target ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_ctype_target_t target" 12 +is a \fBgnutls_ctype_target_t\fP type. +.SH "DESCRIPTION" +This function returns the type of the certificate that a side +is negotiated to use. The certificate type is by default X.509, +unless an alternative certificate type is enabled by \fBgnutls_init()\fP and +negotiated during the session. + +The \fItarget\fP parameter specifies whether to request the negotiated +certificate type for the client (\fBGNUTLS_CTYPE_CLIENT\fP), +or for the server (\fBGNUTLS_CTYPE_SERVER\fP). Additionally, in P2P mode +connection set up where you don't know in advance who will be client +and who will be server you can use the flag (\fBGNUTLS_CTYPE_OURS\fP) and +(\fBGNUTLS_CTYPE_PEERS\fP) to retrieve the corresponding certificate types. + +Resumed sessions will return the certificate type that was negotiated +and used in the original session. That is, this function can be used +to reliably determine the type of the certificate returned by +\fBgnutls_certificate_get_peers()\fP. +.SH "RETURNS" +the currently used \fBgnutls_certificate_type_t\fP certificate +type for the client or the server. +.SH "SINCE" +3.6.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_type_get_id.3 b/doc/manpages/gnutls_certificate_type_get_id.3 new file mode 100644 index 0000000..a68634d --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_get_id.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_certificate_type_t gnutls_certificate_type_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a certificate type name +.SH "DESCRIPTION" +The names are compared in a case insensitive way. +.SH "RETURNS" +a \fBgnutls_certificate_type_t\fP for the specified in a +string certificate type, or \fBGNUTLS_CRT_UNKNOWN\fP on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_type_get_name.3 b/doc/manpages/gnutls_certificate_type_get_name.3 new file mode 100644 index 0000000..4caf341 --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_certificate_type_get_name(gnutls_certificate_type_t " type ");" +.SH ARGUMENTS +.IP "gnutls_certificate_type_t type" 12 +is a certificate type +.SH "DESCRIPTION" +Convert a \fBgnutls_certificate_type_t\fP type to a string. +.SH "RETURNS" +a string that contains the name of the specified +certificate type, or \fBNULL\fP in case of unknown types. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_type_list.3 b/doc/manpages/gnutls_certificate_type_list.3 new file mode 100644 index 0000000..905370e --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_list.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_certificate_type_t * gnutls_certificate_type_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get a list of certificate types. +.SH "RETURNS" +a (0)\-terminated list of \fBgnutls_certificate_type_t\fP +integers indicating the available certificate types. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_verification_profile_get_id.3 b/doc/manpages/gnutls_certificate_verification_profile_get_id.3 new file mode 100644 index 0000000..0ac9f5d --- /dev/null +++ b/doc/manpages/gnutls_certificate_verification_profile_get_id.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_verification_profile_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_verification_profile_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "gnutls_certificate_verification_profiles_t gnutls_certificate_verification_profile_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a profile name +.SH "DESCRIPTION" +Convert a string to a \fBgnutls_certificate_verification_profiles_t\fP value. The names are +compared in a case insensitive way. +.SH "RETURNS" +a \fBgnutls_certificate_verification_profiles_t\fP id of the specified profile, +or \fBGNUTLS_PROFILE_UNKNOWN\fP on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_verification_profile_get_name.3 b/doc/manpages/gnutls_certificate_verification_profile_get_name.3 new file mode 100644 index 0000000..b607c79 --- /dev/null +++ b/doc/manpages/gnutls_certificate_verification_profile_get_name.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_verification_profile_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_verification_profile_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "const char * gnutls_certificate_verification_profile_get_name(gnutls_certificate_verification_profiles_t " id ");" +.SH ARGUMENTS +.IP "gnutls_certificate_verification_profiles_t id" 12 +is a profile ID +.SH "DESCRIPTION" +Convert a \fBgnutls_certificate_verification_profiles_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified profile or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_verification_status_print.3 b/doc/manpages/gnutls_certificate_verification_status_print.3 new file mode 100644 index 0000000..5b92e85 --- /dev/null +++ b/doc/manpages/gnutls_certificate_verification_status_print.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_verification_status_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_verification_status_print \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_verification_status_print(unsigned int " status ", gnutls_certificate_type_t " type ", gnutls_datum_t * " out ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "unsigned int status" 12 +The status flags to be printed +.IP "gnutls_certificate_type_t type" 12 +The certificate type +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with (0) terminated string. +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will pretty print the status of a verification +process \-\- eg. the one obtained by \fBgnutls_certificate_verify_peers3()\fP. + +The output \fIout\fP needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_verify_peers.3 b/doc/manpages/gnutls_certificate_verify_peers.3 new file mode 100644 index 0000000..1b66688 --- /dev/null +++ b/doc/manpages/gnutls_certificate_verify_peers.3 @@ -0,0 +1,74 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_verify_peers" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_verify_peers \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_verify_peers(gnutls_session_t " session ", gnutls_typed_vdata_st * " data ", unsigned int " elements ", unsigned int * " status ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "gnutls_typed_vdata_st * data" 12 +an array of typed data +.IP "unsigned int elements" 12 +the number of data elements +.IP "unsigned int * status" 12 +is the output of the verification +.SH "DESCRIPTION" +This function will verify the peer's certificate and store the +the status in the \fIstatus\fP variable as a bitwise OR of gnutls_certificate_status_t +values or zero if the certificate is trusted. Note that value in \fIstatus\fP is set only when the return value of this function is success (i.e, failure +to trust a certificate does not imply a negative return value). +The default verification flags used by this function can be overridden +using \fBgnutls_certificate_set_verify_flags()\fP. See the documentation +of \fBgnutls_certificate_verify_peers2()\fP for details in the verification process. + +This function will take into account the stapled OCSP responses sent by the server, +as well as the following X.509 certificate extensions: Name Constraints, +Key Usage, and Basic Constraints (pathlen). + +The acceptable \fIdata\fP types are \fBGNUTLS_DT_DNS_HOSTNAME\fP, \fBGNUTLS_DT_RFC822NAME\fP and \fBGNUTLS_DT_KEY_PURPOSE_OID\fP. +The former two accept as data a null\-terminated hostname or email address, and the latter a null\-terminated +object identifier (e.g., \fBGNUTLS_KP_TLS_WWW_SERVER\fP). + +If a DNS hostname is provided then this function will compare +the hostname in the certificate against the given. If names do not match the +\fBGNUTLS_CERT_UNEXPECTED_OWNER\fP status flag will be set. +If a key purpose OID is provided and the end\-certificate contains the extended key +usage PKIX extension, it will be required to be have the provided key purpose +or be marked for any purpose, otherwise verification status will have the +\fBGNUTLS_CERT_SIGNER_CONSTRAINTS_FAILURE\fP flag set. + +To avoid denial of service attacks some +default upper limits regarding the certificate key size and chain +size are set. To override them use \fBgnutls_certificate_set_verify_limits()\fP. + +Note that when using raw public\-keys verification will not work because there is +no corresponding certificate body belonging to the raw key that can be verified. In that +case this function will return \fBGNUTLS_E_INVALID_REQUEST\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) when the validation is performed, or a negative error code otherwise. +A successful error code means that the \fIstatus\fP parameter must be checked to obtain the validation status. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_verify_peers2.3 b/doc/manpages/gnutls_certificate_verify_peers2.3 new file mode 100644 index 0000000..c46229c --- /dev/null +++ b/doc/manpages/gnutls_certificate_verify_peers2.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_verify_peers2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_verify_peers2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_verify_peers2(gnutls_session_t " session ", unsigned int * " status ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "unsigned int * status" 12 +is the output of the verification +.SH "DESCRIPTION" +This function will verify the peer's certificate and store +the status in the \fIstatus\fP variable as a bitwise OR of gnutls_certificate_status_t +values or zero if the certificate is trusted. Note that value in \fIstatus\fP is set only when the return value of this function is success (i.e, failure +to trust a certificate does not imply a negative return value). +The default verification flags used by this function can be overridden +using \fBgnutls_certificate_set_verify_flags()\fP. + +This function will take into account the stapled OCSP responses sent by the server, +as well as the following X.509 certificate extensions: Name Constraints, +Key Usage, and Basic Constraints (pathlen). + +Note that you must also check the peer's name in order to check if +the verified certificate belongs to the actual peer, see \fBgnutls_x509_crt_check_hostname()\fP, +or use \fBgnutls_certificate_verify_peers3()\fP. + +To avoid denial of service attacks some +default upper limits regarding the certificate key size and chain +size are set. To override them use \fBgnutls_certificate_set_verify_limits()\fP. + +Note that when using raw public\-keys verification will not work because there is +no corresponding certificate body belonging to the raw key that can be verified. In that +case this function will return \fBGNUTLS_E_INVALID_REQUEST\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) when the validation is performed, or a negative error code otherwise. +A successful error code means that the \fIstatus\fP parameter must be checked to obtain the validation status. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_certificate_verify_peers3.3 b/doc/manpages/gnutls_certificate_verify_peers3.3 new file mode 100644 index 0000000..69e6bcc --- /dev/null +++ b/doc/manpages/gnutls_certificate_verify_peers3.3 @@ -0,0 +1,68 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_verify_peers3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_verify_peers3 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_certificate_verify_peers3(gnutls_session_t " session ", const char * " hostname ", unsigned int * " status ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "const char * hostname" 12 +is the expected name of the peer; may be \fBNULL\fP +.IP "unsigned int * status" 12 +is the output of the verification +.SH "DESCRIPTION" +This function will verify the peer's certificate and store the +the status in the \fIstatus\fP variable as a bitwise OR of gnutls_certificate_status_t +values or zero if the certificate is trusted. Note that value in \fIstatus\fP is set only when the return value of this function is success (i.e, failure +to trust a certificate does not imply a negative return value). +The default verification flags used by this function can be overridden +using \fBgnutls_certificate_set_verify_flags()\fP. See the documentation +of \fBgnutls_certificate_verify_peers2()\fP for details in the verification process. + +This function will take into account the stapled OCSP responses sent by the server, +as well as the following X.509 certificate extensions: Name Constraints, +Key Usage, and Basic Constraints (pathlen). + +If the \fIhostname\fP provided is non\-NULL then this function will compare +the hostname in the certificate against it. The comparison will follow +the RFC6125 recommendations. If names do not match the +\fBGNUTLS_CERT_UNEXPECTED_OWNER\fP status flag will be set. + +In order to verify the purpose of the end\-certificate (by checking the extended +key usage), use \fBgnutls_certificate_verify_peers()\fP. + +To avoid denial of service attacks some +default upper limits regarding the certificate key size and chain +size are set. To override them use \fBgnutls_certificate_set_verify_limits()\fP. + +Note that when using raw public\-keys verification will not work because there is +no corresponding certificate body belonging to the raw key that can be verified. In that +case this function will return \fBGNUTLS_E_INVALID_REQUEST\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) when the validation is performed, or a negative error code otherwise. +A successful error code means that the \fIstatus\fP parameter must be checked to obtain the validation status. +.SH "SINCE" +3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_check_version.3 b/doc/manpages/gnutls_check_version.3 new file mode 100644 index 0000000..abe531b --- /dev/null +++ b/doc/manpages/gnutls_check_version.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_check_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_check_version \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_check_version(const char * " req_version ");" +.SH ARGUMENTS +.IP "const char * req_version" 12 +version string to compare with, or \fBNULL\fP. +.SH "DESCRIPTION" +Check the GnuTLS Library version against the provided string. +See \fBGNUTLS_VERSION\fP for a suitable \fIreq_version\fP string. + +See also \fBgnutls_check_version_numeric()\fP, which provides this +functionality as a macro. +.SH "RETURNS" +Check that the version of the library is at +minimum the one given as a string in \fIreq_version\fP and return the +actual version string of the library; return \fBNULL\fP if the +condition is not met. If \fBNULL\fP is passed to this function no +check is done and only the version string is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_add_auth.3 b/doc/manpages/gnutls_cipher_add_auth.3 new file mode 100644 index 0000000..55ba65a --- /dev/null +++ b/doc/manpages/gnutls_cipher_add_auth.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_add_auth" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_add_auth \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_add_auth(gnutls_cipher_hd_t " handle ", const void * " ptext ", size_t " ptext_size ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "const void * ptext" 12 +the data to be authenticated +.IP "size_t ptext_size" 12 +the length of the data +.SH "DESCRIPTION" +This function operates on authenticated encryption with +associated data (AEAD) ciphers and authenticate the +input data. This function can only be called once +and before any encryption operations. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_decrypt.3 b/doc/manpages/gnutls_cipher_decrypt.3 new file mode 100644 index 0000000..75f7cb7 --- /dev/null +++ b/doc/manpages/gnutls_cipher_decrypt.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_decrypt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_decrypt \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_decrypt(gnutls_cipher_hd_t " handle ", void * " ctext ", size_t " ctext_len ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "void * ctext" 12 +the data to decrypt +.IP "size_t ctext_len" 12 +the length of data to decrypt +.SH "DESCRIPTION" +This function will decrypt the given data using the algorithm +specified by the context. + +Note that in AEAD ciphers, this will not check the tag. You will +need to compare the tag sent with the value returned from \fBgnutls_cipher_tag()\fP. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_decrypt2.3 b/doc/manpages/gnutls_cipher_decrypt2.3 new file mode 100644 index 0000000..4ea0773 --- /dev/null +++ b/doc/manpages/gnutls_cipher_decrypt2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_decrypt2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_decrypt2 \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_decrypt2(gnutls_cipher_hd_t " handle ", const void * " ctext ", size_t " ctext_len ", void * " ptext ", size_t " ptext_len ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "const void * ctext" 12 +the data to decrypt +.IP "size_t ctext_len" 12 +the length of data to decrypt +.IP "void * ptext" 12 +the decrypted data +.IP "size_t ptext_len" 12 +the available length for decrypted data +.SH "DESCRIPTION" +This function will decrypt the given data using the algorithm +specified by the context. For block ciphers the \fIctext_len\fP must be +a multiple of the block size. For the supported ciphers the plaintext +data length will equal the ciphertext size. + +Note that in AEAD ciphers, this will not check the tag. You will +need to compare the tag sent with the value returned from \fBgnutls_cipher_tag()\fP. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_decrypt3.3 b/doc/manpages/gnutls_cipher_decrypt3.3 new file mode 100644 index 0000000..aa4cac7 --- /dev/null +++ b/doc/manpages/gnutls_cipher_decrypt3.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_decrypt3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_decrypt3 \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_decrypt3(gnutls_cipher_hd_t " handle ", const void * " ctext ", size_t " ctext_len ", void * " ptext ", size_t * " ptext_len ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "const void * ctext" 12 +the data to decrypt +.IP "size_t ctext_len" 12 +the length of data to decrypt +.IP "void * ptext" 12 +the decrypted data +.IP "size_t * ptext_len" 12 +the available length for decrypted data +.IP "unsigned flags" 12 +flags for padding +.SH "DESCRIPTION" +This function will decrypt the given data using the algorithm +specified by the context. If \fIflags\fP is specified, padding for the +decrypted data will be removed accordingly and \fIptext_len\fP will be +updated. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.7.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_deinit.3 b/doc/manpages/gnutls_cipher_deinit.3 new file mode 100644 index 0000000..df234c8 --- /dev/null +++ b/doc/manpages/gnutls_cipher_deinit.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "void gnutls_cipher_deinit(gnutls_cipher_hd_t " handle ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.SH "DESCRIPTION" +This function will deinitialize all resources occupied by the given +encryption context. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_encrypt.3 b/doc/manpages/gnutls_cipher_encrypt.3 new file mode 100644 index 0000000..7df8b13 --- /dev/null +++ b/doc/manpages/gnutls_cipher_encrypt.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_encrypt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_encrypt \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_encrypt(gnutls_cipher_hd_t " handle ", void * " ptext ", size_t " ptext_len ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "void * ptext" 12 +the data to encrypt +.IP "size_t ptext_len" 12 +the length of data to encrypt +.SH "DESCRIPTION" +This function will encrypt the given data using the algorithm +specified by the context. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_encrypt2.3 b/doc/manpages/gnutls_cipher_encrypt2.3 new file mode 100644 index 0000000..ed3da76 --- /dev/null +++ b/doc/manpages/gnutls_cipher_encrypt2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_encrypt2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_encrypt2 \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_encrypt2(gnutls_cipher_hd_t " handle ", const void * " ptext ", size_t " ptext_len ", void * " ctext ", size_t " ctext_len ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "const void * ptext" 12 +the data to encrypt +.IP "size_t ptext_len" 12 +the length of data to encrypt +.IP "void * ctext" 12 +the encrypted data +.IP "size_t ctext_len" 12 +the available length for encrypted data +.SH "DESCRIPTION" +This function will encrypt the given data using the algorithm +specified by the context. For block ciphers the \fIptext_len\fP must be +a multiple of the block size. For the supported ciphers the encrypted +data length will equal the plaintext size. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_encrypt3.3 b/doc/manpages/gnutls_cipher_encrypt3.3 new file mode 100644 index 0000000..f689ff8 --- /dev/null +++ b/doc/manpages/gnutls_cipher_encrypt3.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_encrypt3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_encrypt3 \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_encrypt3(gnutls_cipher_hd_t " handle ", const void * " ptext ", size_t " ptext_len ", void * " ctext ", size_t * " ctext_len ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "const void * ptext" 12 +the data to encrypt +.IP "size_t ptext_len" 12 +the length of data to encrypt +.IP "void * ctext" 12 +the encrypted data +.IP "size_t * ctext_len" 12 +the length of encrypted data (initially must hold the maximum available size) +.IP "unsigned flags" 12 +flags for padding +.SH "DESCRIPTION" +This function will encrypt the given data using the algorithm +specified by the context. For block ciphers, \fIptext_len\fP is +typically a multiple of the block size. If not, the caller can +instruct the function to pad the last block according to \fIflags\fP . +Currently, the only available padding scheme is +\fBGNUTLS_CIPHER_PADDING_PKCS7\fP. + +If \fIctext\fP is not \fBNULL\fP, it must hold enough space to store +resulting cipher text. To check the required size, this function +can be called with \fIctext\fP set to \fBNULL\fP. Then \fIctext_len\fP will be +updated without performing actual encryption. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.7.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_get.3 b/doc/manpages/gnutls_cipher_get.3 new file mode 100644 index 0000000..c4a0e09 --- /dev/null +++ b/doc/manpages/gnutls_cipher_get.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_cipher_algorithm_t gnutls_cipher_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the currently used cipher. +.SH "RETURNS" +the currently used cipher, a \fBgnutls_cipher_algorithm_t\fP +type. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_get_block_size.3 b/doc/manpages/gnutls_cipher_get_block_size.3 new file mode 100644 index 0000000..f2f87f2 --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_block_size.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_block_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_block_size \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "unsigned gnutls_cipher_get_block_size(gnutls_cipher_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_cipher_algorithm_t algorithm" 12 +is an encryption algorithm +.SH "RETURNS" +the block size of the encryption algorithm. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_get_id.3 b/doc/manpages/gnutls_cipher_get_id.3 new file mode 100644 index 0000000..40c7c52 --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_id.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_cipher_algorithm_t gnutls_cipher_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a cipher algorithm name +.SH "DESCRIPTION" +The names are compared in a case insensitive way. +.SH "RETURNS" +return a \fBgnutls_cipher_algorithm_t\fP value corresponding to +the specified cipher, or \fBGNUTLS_CIPHER_UNKNOWN\fP on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_get_iv_size.3 b/doc/manpages/gnutls_cipher_get_iv_size.3 new file mode 100644 index 0000000..0a5368f --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_iv_size.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_iv_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_iv_size \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "unsigned gnutls_cipher_get_iv_size(gnutls_cipher_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_cipher_algorithm_t algorithm" 12 +is an encryption algorithm +.SH "DESCRIPTION" +This function returns the size of the initialization vector (IV) for the +provided algorithm. For algorithms with variable size IV (e.g., AES\-CCM), +the returned size will be the one used by TLS. +.SH "RETURNS" +block size for encryption algorithm. +.SH "SINCE" +3.2.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_get_key_size.3 b/doc/manpages/gnutls_cipher_get_key_size.3 new file mode 100644 index 0000000..672e43b --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_key_size.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_key_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_key_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "size_t gnutls_cipher_get_key_size(gnutls_cipher_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_cipher_algorithm_t algorithm" 12 +is an encryption algorithm +.SH "DESCRIPTION" +This function returns the key size of the provided algorithm. +.SH "RETURNS" +length (in bytes) of the given cipher's key size, or 0 if +the given cipher is invalid. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_get_name.3 b/doc/manpages/gnutls_cipher_get_name.3 new file mode 100644 index 0000000..8480f87 --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_cipher_get_name(gnutls_cipher_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_cipher_algorithm_t algorithm" 12 +is an encryption algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_cipher_algorithm_t\fP type to a string. +.SH "RETURNS" +a pointer to a string that contains the name of the +specified cipher, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_get_tag_size.3 b/doc/manpages/gnutls_cipher_get_tag_size.3 new file mode 100644 index 0000000..f03f471 --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_tag_size.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_tag_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_tag_size \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "unsigned gnutls_cipher_get_tag_size(gnutls_cipher_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_cipher_algorithm_t algorithm" 12 +is an encryption algorithm +.SH "DESCRIPTION" +This function returns the tag size of an authenticated encryption +algorithm. For non\-AEAD algorithms, it returns zero. +.SH "RETURNS" +the tag size of the authenticated encryption algorithm. +.SH "SINCE" +3.2.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_init.3 b/doc/manpages/gnutls_cipher_init.3 new file mode 100644 index 0000000..3a44563 --- /dev/null +++ b/doc/manpages/gnutls_cipher_init.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_init \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_init(gnutls_cipher_hd_t * " handle ", gnutls_cipher_algorithm_t " cipher ", const gnutls_datum_t * " key ", const gnutls_datum_t * " iv ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t * handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "gnutls_cipher_algorithm_t cipher" 12 +the encryption algorithm to use +.IP "const gnutls_datum_t * key" 12 +the key to be used for encryption/decryption +.IP "const gnutls_datum_t * iv" 12 +the IV to use (if not applicable set NULL) +.SH "DESCRIPTION" +This function will initialize the \fIhandle\fP context to be usable +for encryption/decryption of data. This will effectively use the +current crypto backend in use by gnutls or the cryptographic +accelerator in use. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_list.3 b/doc/manpages/gnutls_cipher_list.3 new file mode 100644 index 0000000..0b80b8b --- /dev/null +++ b/doc/manpages/gnutls_cipher_list.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_cipher_algorithm_t * gnutls_cipher_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get a list of supported cipher algorithms. Note that not +necessarily all ciphers are supported as TLS cipher suites. For +example, DES is not supported as a cipher suite, but is supported +for other purposes (e.g., PKCS\fB8\fP or similar). + +This function is not thread safe. +.SH "RETURNS" +a (0)\-terminated list of \fBgnutls_cipher_algorithm_t\fP +integers indicating the available ciphers. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_set_iv.3 b/doc/manpages/gnutls_cipher_set_iv.3 new file mode 100644 index 0000000..07416d2 --- /dev/null +++ b/doc/manpages/gnutls_cipher_set_iv.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_set_iv" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_set_iv \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "void gnutls_cipher_set_iv(gnutls_cipher_hd_t " handle ", void * " iv ", size_t " ivlen ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "void * iv" 12 +the IV to set +.IP "size_t ivlen" 12 +the length of the IV +.SH "DESCRIPTION" +This function will set the IV to be used for the next +encryption block. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_suite_get_name.3 b/doc/manpages/gnutls_cipher_suite_get_name.3 new file mode 100644 index 0000000..36abae0 --- /dev/null +++ b/doc/manpages/gnutls_cipher_suite_get_name.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_suite_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_suite_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_cipher_suite_get_name(gnutls_kx_algorithm_t " kx_algorithm ", gnutls_cipher_algorithm_t " cipher_algorithm ", gnutls_mac_algorithm_t " mac_algorithm ");" +.SH ARGUMENTS +.IP "gnutls_kx_algorithm_t kx_algorithm" 12 +is a Key exchange algorithm +.IP "gnutls_cipher_algorithm_t cipher_algorithm" 12 +is a cipher algorithm +.IP "gnutls_mac_algorithm_t mac_algorithm" 12 +is a MAC algorithm +.SH "DESCRIPTION" +This function returns the ciphersuite name under TLS1.2 or earlier +versions when provided with individual algorithms. The full cipher suite +name must be prepended by TLS or SSL depending of the protocol in use. + +To get a description of the current ciphersuite across versions, it +is recommended to use \fBgnutls_session_get_desc()\fP. +.SH "RETURNS" +a string that contains the name of a TLS cipher suite, +specified by the given algorithms, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_suite_info.3 b/doc/manpages/gnutls_cipher_suite_info.3 new file mode 100644 index 0000000..532a693 --- /dev/null +++ b/doc/manpages/gnutls_cipher_suite_info.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_suite_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_suite_info \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_cipher_suite_info(size_t " idx ", unsigned char * " cs_id ", gnutls_kx_algorithm_t * " kx ", gnutls_cipher_algorithm_t * " cipher ", gnutls_mac_algorithm_t * " mac ", gnutls_protocol_t * " min_version ");" +.SH ARGUMENTS +.IP "size_t idx" 12 +index of cipher suite to get information about, starts on 0. +.IP "unsigned char * cs_id" 12 +output buffer with room for 2 bytes, indicating cipher suite value +.IP "gnutls_kx_algorithm_t * kx" 12 +output variable indicating key exchange algorithm, or \fBNULL\fP. +.IP "gnutls_cipher_algorithm_t * cipher" 12 +output variable indicating cipher, or \fBNULL\fP. +.IP "gnutls_mac_algorithm_t * mac" 12 +output variable indicating MAC algorithm, or \fBNULL\fP. +.IP "gnutls_protocol_t * min_version" 12 +output variable indicating TLS protocol version, or \fBNULL\fP. +.SH "DESCRIPTION" +Get information about supported cipher suites. Use the function +iteratively to get information about all supported cipher suites. +Call with idx=0 to get information about first cipher suite, then +idx=1 and so on until the function returns NULL. +.SH "RETURNS" +the name of \fIidx\fP cipher suite, and set the information +about the cipher suite in the output variables. If \fIidx\fP is out of +bounds, \fBNULL\fP is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_cipher_tag.3 b/doc/manpages/gnutls_cipher_tag.3 new file mode 100644 index 0000000..a39402f --- /dev/null +++ b/doc/manpages/gnutls_cipher_tag.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_tag" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_tag \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_cipher_tag(gnutls_cipher_hd_t " handle ", void * " tag ", size_t " tag_size ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP type +.IP "void * tag" 12 +will hold the tag +.IP "size_t tag_size" 12 +the length of the tag to return +.SH "DESCRIPTION" +This function operates on authenticated encryption with +associated data (AEAD) ciphers and will return the +output tag. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ciphersuite_get.3 b/doc/manpages/gnutls_ciphersuite_get.3 new file mode 100644 index 0000000..9733eef --- /dev/null +++ b/doc/manpages/gnutls_ciphersuite_get.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ciphersuite_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ciphersuite_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_ciphersuite_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the canonical name of negotiated TLS ciphersuite. The names +returned by this function match the IANA registry, with one +exception: + +TLS_DHE_DSS_RC4_128_SHA { 0x00, 0x66 } + +which is reserved for compatibility. + +To get a detailed description of the current ciphersuite, it is +recommended to use \fBgnutls_session_get_desc()\fP. +.SH "RETURNS" +a string that contains the canonical name of a TLS ciphersuite, +or \fBNULL\fP if the handshake is not completed. +.SH "SINCE" +3.7.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_compress_certificate_get_selected_method.3 b/doc/manpages/gnutls_compress_certificate_get_selected_method.3 new file mode 100644 index 0000000..fc11842 --- /dev/null +++ b/doc/manpages/gnutls_compress_certificate_get_selected_method.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compress_certificate_get_selected_method" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_compress_certificate_get_selected_method \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_compression_method_t gnutls_compress_certificate_get_selected_method(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function returns the certificate compression method that has been +selected to compress the certificate before sending it to the peer. +The selection is done based on the local list of supported compression +methods and the peer's requested compression methods. +.SH "RETURNS" +selected certificate compression method. + +Since 3.7.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_compress_certificate_set_methods.3 b/doc/manpages/gnutls_compress_certificate_set_methods.3 new file mode 100644 index 0000000..8f290ad --- /dev/null +++ b/doc/manpages/gnutls_compress_certificate_set_methods.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compress_certificate_set_methods" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_compress_certificate_set_methods \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_compress_certificate_set_methods(gnutls_session_t " session ", const gnutls_compression_method_t * " methods ", size_t " methods_len ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const gnutls_compression_method_t * methods" 12 +is a list of supported compression methods. +.IP "size_t methods_len" 12 +number of compression methods in \fImethods\fP +.SH "DESCRIPTION" +This function sets the supported compression methods for certificate compression +for the given session. The list of supported compression methods will be used +for a) requesting the compression of peer's certificate and b) selecting the +method to compress the local certificate before sending it to the peer. +The order of compression methods inside the list does matter as the method +that appears earlier in the list will be preffered before the later ones. +Note that even if you set the list of supported compression methods, the +compression might not be used if the peer does not support any of your chosen +compression methods. + +The list of supported compression methods must meet the following criteria: +Argument \fImethods\fP must be an array of valid compression methods of type +\fBgnutls_compression_method_t\fP. Argument \fImethods_len\fP must contain the number of +compression methods stored in the \fImethods\fP array and must be within range <1, 127>. +The length constraints are defined by \fBMIN_COMPRESS_CERTIFICATE_METHODS\fP +and \fBMAX_COMPRESS_CERTIFICATE_METHODS\fP macros located in the header file +compress_certificate.h. + +If either \fImethods\fP or \fImethods_len\fP is equal to 0, current list of supported +compression methods will be unset. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. + +Since 3.7.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_compression_get.3 b/doc/manpages/gnutls_compression_get.3 new file mode 100644 index 0000000..b85a63d --- /dev/null +++ b/doc/manpages/gnutls_compression_get.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compression_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_compression_get \- API function +.SH SYNOPSIS +.B #include <gnutls/compat.h> +.sp +.BI "gnutls_compression_method_t gnutls_compression_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the currently used compression algorithm. +.SH "RETURNS" +the currently used compression method, a +\fBgnutls_compression_method_t\fP value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_compression_get_id.3 b/doc/manpages/gnutls_compression_get_id.3 new file mode 100644 index 0000000..60dc368 --- /dev/null +++ b/doc/manpages/gnutls_compression_get_id.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compression_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_compression_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/compat.h> +.sp +.BI "gnutls_compression_method_t gnutls_compression_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a compression method name +.SH "DESCRIPTION" +The names are compared in a case insensitive way. +.SH "RETURNS" +an id of the specified in a string compression method, or +\fBGNUTLS_COMP_UNKNOWN\fP on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_compression_get_name.3 b/doc/manpages/gnutls_compression_get_name.3 new file mode 100644 index 0000000..98f4eb4 --- /dev/null +++ b/doc/manpages/gnutls_compression_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compression_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_compression_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/compat.h> +.sp +.BI "const char * gnutls_compression_get_name(gnutls_compression_method_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_compression_method_t algorithm" 12 +is a Compression algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_compression_method_t\fP value to a string. +.SH "RETURNS" +a pointer to a string that contains the name of the +specified compression algorithm, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_compression_list.3 b/doc/manpages/gnutls_compression_list.3 new file mode 100644 index 0000000..0b180a9 --- /dev/null +++ b/doc/manpages/gnutls_compression_list.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compression_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_compression_list \- API function +.SH SYNOPSIS +.B #include <gnutls/compat.h> +.sp +.BI "const gnutls_compression_method_t * gnutls_compression_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get a list of compression methods. +.SH "RETURNS" +a zero\-terminated list of \fBgnutls_compression_method_t\fP +integers indicating the available compression methods. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_credentials_clear.3 b/doc/manpages/gnutls_credentials_clear.3 new file mode 100644 index 0000000..8b2136b --- /dev/null +++ b/doc/manpages/gnutls_credentials_clear.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_credentials_clear" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_credentials_clear \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_credentials_clear(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Clears all the credentials previously set in this session. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_credentials_get.3 b/doc/manpages/gnutls_credentials_get.3 new file mode 100644 index 0000000..8a9fd1b --- /dev/null +++ b/doc/manpages/gnutls_credentials_get.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_credentials_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_credentials_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_credentials_get(gnutls_session_t " session ", gnutls_credentials_type_t " type ", void ** " cred ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_credentials_type_t type" 12 +is the type of the credentials to return +.IP "void ** cred" 12 +will contain the credentials. +.SH "DESCRIPTION" +Returns the previously provided credentials structures. + +For \fBGNUTLS_CRD_ANON\fP, \fIcred\fP will be +\fBgnutls_anon_client_credentials_t\fP in case of a client. In case of +a server it should be \fBgnutls_anon_server_credentials_t\fP. + +For \fBGNUTLS_CRD_SRP\fP, \fIcred\fP will be \fBgnutls_srp_client_credentials_t\fP +in case of a client, and \fBgnutls_srp_server_credentials_t\fP, in case +of a server. + +For \fBGNUTLS_CRD_CERTIFICATE\fP, \fIcred\fP will be +\fBgnutls_certificate_credentials_t\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "SINCE" +3.3.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_credentials_set.3 b/doc/manpages/gnutls_credentials_set.3 new file mode 100644 index 0000000..788aa38 --- /dev/null +++ b/doc/manpages/gnutls_credentials_set.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_credentials_set" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_credentials_set \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_credentials_set(gnutls_session_t " session ", gnutls_credentials_type_t " type ", void * " cred ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_credentials_type_t type" 12 +is the type of the credentials +.IP "void * cred" 12 +the credentials to set +.SH "DESCRIPTION" +Sets the needed credentials for the specified type. E.g. username, +password \- or public and private keys etc. The \fIcred\fP parameter is +a structure that depends on the specified type and on the current +session (client or server). + +In order to minimize memory usage, and share credentials between +several threads gnutls keeps a pointer to cred, and not the whole +cred structure. Thus you will have to keep the structure allocated +until you call \fBgnutls_deinit()\fP. + +For \fBGNUTLS_CRD_ANON\fP, \fIcred\fP should be +\fBgnutls_anon_client_credentials_t\fP in case of a client. In case of +a server it should be \fBgnutls_anon_server_credentials_t\fP. + +For \fBGNUTLS_CRD_SRP\fP, \fIcred\fP should be \fBgnutls_srp_client_credentials_t\fP +in case of a client, and \fBgnutls_srp_server_credentials_t\fP, in case +of a server. + +For \fBGNUTLS_CRD_CERTIFICATE\fP, \fIcred\fP should be +\fBgnutls_certificate_credentials_t\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_crypto_register_aead_cipher.3 b/doc/manpages/gnutls_crypto_register_aead_cipher.3 new file mode 100644 index 0000000..0239ad7 --- /dev/null +++ b/doc/manpages/gnutls_crypto_register_aead_cipher.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_crypto_register_aead_cipher" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_crypto_register_aead_cipher \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_crypto_register_aead_cipher(gnutls_cipher_algorithm_t " algorithm ", int " priority ", gnutls_cipher_init_func " init ", gnutls_cipher_setkey_func " setkey ", gnutls_cipher_aead_encrypt_func " aead_encrypt ", gnutls_cipher_aead_decrypt_func " aead_decrypt ", gnutls_cipher_deinit_func " deinit ");" +.SH ARGUMENTS +.IP "gnutls_cipher_algorithm_t algorithm" 12 +is the gnutls AEAD cipher identifier +.IP "int priority" 12 +is the priority of the algorithm +.IP "gnutls_cipher_init_func init" 12 +A function which initializes the cipher +.IP "gnutls_cipher_setkey_func setkey" 12 +A function which sets the key of the cipher +.IP "gnutls_cipher_aead_encrypt_func aead_encrypt" 12 +Perform the AEAD encryption +.IP "gnutls_cipher_aead_decrypt_func aead_decrypt" 12 +Perform the AEAD decryption +.IP "gnutls_cipher_deinit_func deinit" 12 +A function which deinitializes the cipher +.SH "DESCRIPTION" +This function will register a cipher algorithm to be used by +gnutls. Any algorithm registered will override the included +algorithms and by convention kernel implemented algorithms have +priority of 90 and CPU\-assisted of 80. The algorithm with the lowest priority will be +used by gnutls. + +In the case the registered init or setkey functions return \fBGNUTLS_E_NEED_FALLBACK\fP, +GnuTLS will attempt to use the next in priority registered cipher. + +The functions registered will be used with the new AEAD API introduced in +GnuTLS 3.4.0. Internally GnuTLS uses the new AEAD API. +.SH "DEPRECATED" +since 3.7.0 it is no longer possible to override cipher implementation +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_crypto_register_cipher.3 b/doc/manpages/gnutls_crypto_register_cipher.3 new file mode 100644 index 0000000..8f55b4a --- /dev/null +++ b/doc/manpages/gnutls_crypto_register_cipher.3 @@ -0,0 +1,64 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_crypto_register_cipher" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_crypto_register_cipher \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_crypto_register_cipher(gnutls_cipher_algorithm_t " algorithm ", int " priority ", gnutls_cipher_init_func " init ", gnutls_cipher_setkey_func " setkey ", gnutls_cipher_setiv_func " setiv ", gnutls_cipher_encrypt_func " encrypt ", gnutls_cipher_decrypt_func " decrypt ", gnutls_cipher_deinit_func " deinit ");" +.SH ARGUMENTS +.IP "gnutls_cipher_algorithm_t algorithm" 12 +is the gnutls algorithm identifier +.IP "int priority" 12 +is the priority of the algorithm +.IP "gnutls_cipher_init_func init" 12 +A function which initializes the cipher +.IP "gnutls_cipher_setkey_func setkey" 12 +A function which sets the key of the cipher +.IP "gnutls_cipher_setiv_func setiv" 12 +A function which sets the nonce/IV of the cipher (non\-AEAD) +.IP "gnutls_cipher_encrypt_func encrypt" 12 +A function which performs encryption (non\-AEAD) +.IP "gnutls_cipher_decrypt_func decrypt" 12 +A function which performs decryption (non\-AEAD) +.IP "gnutls_cipher_deinit_func deinit" 12 +A function which deinitializes the cipher +.SH "DESCRIPTION" +This function will register a cipher algorithm to be used by +gnutls. Any algorithm registered will override the included +algorithms and by convention kernel implemented algorithms have +priority of 90 and CPU\-assisted of 80. The algorithm with the lowest priority will be +used by gnutls. + +In the case the registered init or setkey functions return \fBGNUTLS_E_NEED_FALLBACK\fP, +GnuTLS will attempt to use the next in priority registered cipher. + +The functions which are marked as non\-AEAD they are not required when +registering a cipher to be used with the new AEAD API introduced in +GnuTLS 3.4.0. Internally GnuTLS uses the new AEAD API. +.SH "DEPRECATED" +since 3.7.0 it is no longer possible to override cipher implementation +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_crypto_register_digest.3 b/doc/manpages/gnutls_crypto_register_digest.3 new file mode 100644 index 0000000..d12d961 --- /dev/null +++ b/doc/manpages/gnutls_crypto_register_digest.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_crypto_register_digest" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_crypto_register_digest \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_crypto_register_digest(gnutls_digest_algorithm_t " algorithm ", int " priority ", gnutls_digest_init_func " init ", gnutls_digest_hash_func " hash ", gnutls_digest_output_func " output ", gnutls_digest_deinit_func " deinit ", gnutls_digest_fast_func " hash_fast ");" +.SH ARGUMENTS +.IP "gnutls_digest_algorithm_t algorithm" 12 +is the gnutls digest identifier +.IP "int priority" 12 +is the priority of the algorithm +.IP "gnutls_digest_init_func init" 12 +A function which initializes the digest +.IP "gnutls_digest_hash_func hash" 12 +Perform the hash operation +.IP "gnutls_digest_output_func output" 12 +Provide the output of the digest +.IP "gnutls_digest_deinit_func deinit" 12 +A function which deinitializes the digest +.IP "gnutls_digest_fast_func hash_fast" 12 +Perform the digest operation in one go +.SH "DESCRIPTION" +This function will register a digest algorithm to be used by gnutls. +Any algorithm registered will override the included algorithms and +by convention kernel implemented algorithms have priority of 90 +and CPU\-assisted of 80. +The algorithm with the lowest priority will be used by gnutls. +.SH "DEPRECATED" +since 3.7.0 it is no longer possible to override cipher implementation +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_crypto_register_mac.3 b/doc/manpages/gnutls_crypto_register_mac.3 new file mode 100644 index 0000000..37bb03a --- /dev/null +++ b/doc/manpages/gnutls_crypto_register_mac.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_crypto_register_mac" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_crypto_register_mac \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_crypto_register_mac(gnutls_mac_algorithm_t " algorithm ", int " priority ", gnutls_mac_init_func " init ", gnutls_mac_setkey_func " setkey ", gnutls_mac_setnonce_func " setnonce ", gnutls_mac_hash_func " hash ", gnutls_mac_output_func " output ", gnutls_mac_deinit_func " deinit ", gnutls_mac_fast_func " hash_fast ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t algorithm" 12 +is the gnutls MAC identifier +.IP "int priority" 12 +is the priority of the algorithm +.IP "gnutls_mac_init_func init" 12 +A function which initializes the MAC +.IP "gnutls_mac_setkey_func setkey" 12 +A function which sets the key of the MAC +.IP "gnutls_mac_setnonce_func setnonce" 12 +A function which sets the nonce for the mac (may be \fBNULL\fP for common MAC algorithms) +.IP "gnutls_mac_hash_func hash" 12 +Perform the hash operation +.IP "gnutls_mac_output_func output" 12 +Provide the output of the MAC +.IP "gnutls_mac_deinit_func deinit" 12 +A function which deinitializes the MAC +.IP "gnutls_mac_fast_func hash_fast" 12 +Perform the MAC operation in one go +.SH "DESCRIPTION" +This function will register a MAC algorithm to be used by gnutls. +Any algorithm registered will override the included algorithms and +by convention kernel implemented algorithms have priority of 90 +and CPU\-assisted of 80. +The algorithm with the lowest priority will be used by gnutls. +.SH "DEPRECATED" +since 3.7.0 it is no longer possible to override cipher implementation +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_check_entry.3 b/doc/manpages/gnutls_db_check_entry.3 new file mode 100644 index 0000000..8595220 --- /dev/null +++ b/doc/manpages/gnutls_db_check_entry.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_check_entry" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_check_entry \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_db_check_entry(gnutls_session_t " session ", gnutls_datum_t " session_entry ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_datum_t session_entry" 12 +is the session data (not key) +.SH "DESCRIPTION" +This function has no effect. +.SH "RETURNS" +Returns \fBGNUTLS_E_EXPIRED\fP, if the database entry has +expired or 0 otherwise. +.SH "DEPRECATED" +This function is deprecated. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_check_entry_expire_time.3 b/doc/manpages/gnutls_db_check_entry_expire_time.3 new file mode 100644 index 0000000..adf23fc --- /dev/null +++ b/doc/manpages/gnutls_db_check_entry_expire_time.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_check_entry_expire_time" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_check_entry_expire_time \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "time_t gnutls_db_check_entry_expire_time(gnutls_datum_t * " entry ");" +.SH ARGUMENTS +.IP "gnutls_datum_t * entry" 12 +is a pointer to a \fBgnutls_datum_t\fP type. +.SH "DESCRIPTION" +This function returns the time that this entry will expire. +It can be used for database entry expiration. +.SH "RETURNS" +The time this entry will expire, or zero on error. +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_check_entry_time.3 b/doc/manpages/gnutls_db_check_entry_time.3 new file mode 100644 index 0000000..db47aec --- /dev/null +++ b/doc/manpages/gnutls_db_check_entry_time.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_check_entry_time" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_check_entry_time \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "time_t gnutls_db_check_entry_time(gnutls_datum_t * " entry ");" +.SH ARGUMENTS +.IP "gnutls_datum_t * entry" 12 +is a pointer to a \fBgnutls_datum_t\fP type. +.SH "DESCRIPTION" +This function returns the time that this entry was active. +It can be used for database entry expiration. +.SH "RETURNS" +The time this entry was created, or zero on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_get_default_cache_expiration.3 b/doc/manpages/gnutls_db_get_default_cache_expiration.3 new file mode 100644 index 0000000..8f97e85 --- /dev/null +++ b/doc/manpages/gnutls_db_get_default_cache_expiration.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_get_default_cache_expiration" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_get_default_cache_expiration \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_db_get_default_cache_expiration( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Returns the expiration time (in seconds) of stored sessions for resumption. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_get_ptr.3 b/doc/manpages/gnutls_db_get_ptr.3 new file mode 100644 index 0000000..f97e8ac --- /dev/null +++ b/doc/manpages/gnutls_db_get_ptr.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_get_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_get_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void * gnutls_db_get_ptr(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get db function pointer. +.SH "RETURNS" +the pointer that will be sent to db store, retrieve and +delete functions, as the first argument. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_remove_session.3 b/doc/manpages/gnutls_db_remove_session.3 new file mode 100644 index 0000000..ba86271 --- /dev/null +++ b/doc/manpages/gnutls_db_remove_session.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_remove_session" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_remove_session \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_db_remove_session(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function will remove the current session data from the +session database. This will prevent future handshakes reusing +these session data. This function should be called if a session +was terminated abnormally, and before \fBgnutls_deinit()\fP is called. + +Normally \fBgnutls_deinit()\fP will remove abnormally terminated +sessions. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_set_cache_expiration.3 b/doc/manpages/gnutls_db_set_cache_expiration.3 new file mode 100644 index 0000000..c327636 --- /dev/null +++ b/doc/manpages/gnutls_db_set_cache_expiration.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_cache_expiration" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_cache_expiration \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_db_set_cache_expiration(gnutls_session_t " session ", int " seconds ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "int seconds" 12 +is the number of seconds. +.SH "DESCRIPTION" +Set the expiration time for resumed sessions. The default is 21600 +(6 hours) at the time of writing. + +The maximum value that can be set using this function is 604800 +(7 days). +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_set_ptr.3 b/doc/manpages/gnutls_db_set_ptr.3 new file mode 100644 index 0000000..427bb57 --- /dev/null +++ b/doc/manpages/gnutls_db_set_ptr.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_db_set_ptr(gnutls_session_t " session ", void * " ptr ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "void * ptr" 12 +is the pointer +.SH "DESCRIPTION" +Sets the pointer that will be provided to db store, retrieve and +delete functions, as the first argument. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_set_remove_function.3 b/doc/manpages/gnutls_db_set_remove_function.3 new file mode 100644 index 0000000..7e57d4c --- /dev/null +++ b/doc/manpages/gnutls_db_set_remove_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_remove_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_remove_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_db_set_remove_function(gnutls_session_t " session ", gnutls_db_remove_func " rem_func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_db_remove_func rem_func" 12 +is the function. +.SH "DESCRIPTION" +Sets the function that will be used to remove data from the +resumed sessions database. This function must return 0 on success. + +The first argument to \fIrem_func\fP will be null unless +\fBgnutls_db_set_ptr()\fP has been called. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_set_retrieve_function.3 b/doc/manpages/gnutls_db_set_retrieve_function.3 new file mode 100644 index 0000000..0981cf9 --- /dev/null +++ b/doc/manpages/gnutls_db_set_retrieve_function.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_retrieve_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_retrieve_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_db_set_retrieve_function(gnutls_session_t " session ", gnutls_db_retr_func " retr_func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_db_retr_func retr_func" 12 +is the function. +.SH "DESCRIPTION" +Sets the function that will be used to retrieve data from the +resumed sessions database. This function must return a +gnutls_datum_t containing the data on success, or a gnutls_datum_t +containing null and 0 on failure. + +The datum's data must be allocated using the function +\fBgnutls_malloc()\fP. + +The first argument to \fIretr_func\fP will be null unless +\fBgnutls_db_set_ptr()\fP has been called. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_db_set_store_function.3 b/doc/manpages/gnutls_db_set_store_function.3 new file mode 100644 index 0000000..c9a4c58 --- /dev/null +++ b/doc/manpages/gnutls_db_set_store_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_store_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_store_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_db_set_store_function(gnutls_session_t " session ", gnutls_db_store_func " store_func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_db_store_func store_func" 12 +is the function +.SH "DESCRIPTION" +Sets the function that will be used to store data in the resumed +sessions database. This function must return 0 on success. + +The first argument to \fIstore_func\fP will be null unless +\fBgnutls_db_set_ptr()\fP has been called. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_decode_ber_digest_info.3 b/doc/manpages/gnutls_decode_ber_digest_info.3 new file mode 100644 index 0000000..0fe9831 --- /dev/null +++ b/doc/manpages/gnutls_decode_ber_digest_info.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_decode_ber_digest_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_decode_ber_digest_info \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_decode_ber_digest_info(const gnutls_datum_t * " info ", gnutls_digest_algorithm_t * " hash ", unsigned char * " digest ", unsigned int * " digest_size ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * info" 12 +an RSA BER encoded DigestInfo structure +.IP "gnutls_digest_algorithm_t * hash" 12 +will contain the hash algorithm of the structure +.IP "unsigned char * digest" 12 +will contain the hash output of the structure +.IP "unsigned int * digest_size" 12 +will contain the hash size of the structure; initially must hold the maximum size of \fIdigest\fP +.SH "DESCRIPTION" +This function will parse an RSA PKCS\fB1\fP 1.5 DigestInfo structure +and report the hash algorithm used as well as the digest data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_decode_gost_rs_value.3 b/doc/manpages/gnutls_decode_gost_rs_value.3 new file mode 100644 index 0000000..d5bc08e --- /dev/null +++ b/doc/manpages/gnutls_decode_gost_rs_value.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_decode_gost_rs_value" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_decode_gost_rs_value \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_decode_gost_rs_value(const gnutls_datum_t * " sig_value ", gnutls_datum_t * " r ", gnutls_datum_t * " s ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * sig_value" 12 +will holds a GOST signature according to RFC 4491 section 2.2.2 +.IP "gnutls_datum_t * r" 12 +will contain the r value +.IP "gnutls_datum_t * s" 12 +will contain the s value +.SH "DESCRIPTION" +This function will decode the provided \fIsig_value\fP , into \fIr\fP and \fIs\fP elements. +See RFC 4491 section 2.2.2 for the format of signature value. + +The output values may be padded with a zero byte to prevent them +from being interpreted as negative values. The value +should be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_decode_rs_value.3 b/doc/manpages/gnutls_decode_rs_value.3 new file mode 100644 index 0000000..326a399 --- /dev/null +++ b/doc/manpages/gnutls_decode_rs_value.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_decode_rs_value" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_decode_rs_value \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_decode_rs_value(const gnutls_datum_t * " sig_value ", gnutls_datum_t * " r ", gnutls_datum_t * " s ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * sig_value" 12 +holds a Dss\-Sig\-Value DER or BER encoded structure +.IP "gnutls_datum_t * r" 12 +will contain the r value +.IP "gnutls_datum_t * s" 12 +will contain the s value +.SH "DESCRIPTION" +This function will decode the provided \fIsig_value\fP , +into \fIr\fP and \fIs\fP elements. The Dss\-Sig\-Value is used for DSA and ECDSA +signatures. + +The output values may be padded with a zero byte to prevent them +from being interpreted as negative values. The value +should be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_deinit.3 b/doc/manpages/gnutls_deinit.3 new file mode 100644 index 0000000..6d4ba8e --- /dev/null +++ b/doc/manpages/gnutls_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_deinit(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function clears all buffers associated with the \fIsession\fP . +This function will also remove session data from the session +database if the session was terminated abnormally. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_get_group.3 b/doc/manpages/gnutls_dh_get_group.3 new file mode 100644 index 0000000..2386a63 --- /dev/null +++ b/doc/manpages/gnutls_dh_get_group.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_group" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_group \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_get_group(gnutls_session_t " session ", gnutls_datum_t * " raw_gen ", gnutls_datum_t * " raw_prime ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "gnutls_datum_t * raw_gen" 12 +will hold the generator. +.IP "gnutls_datum_t * raw_prime" 12 +will hold the prime. +.SH "DESCRIPTION" +This function will return the group parameters used in the last +Diffie\-Hellman key exchange with the peer. These are the prime and +the generator used. This function should be used for both +anonymous and ephemeral Diffie\-Hellman. The output parameters must +be freed with \fBgnutls_free()\fP. + +Note, that the prime and generator are exported as non\-negative +integers and may include a leading zero byte. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_get_peers_public_bits.3 b/doc/manpages/gnutls_dh_get_peers_public_bits.3 new file mode 100644 index 0000000..801199b --- /dev/null +++ b/doc/manpages/gnutls_dh_get_peers_public_bits.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_peers_public_bits" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_peers_public_bits \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_get_peers_public_bits(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +Get the Diffie\-Hellman public key bit size. Can be used for both +anonymous and ephemeral Diffie\-Hellman. +.SH "RETURNS" +The public key bit size used in the last Diffie\-Hellman +key exchange with the peer, or a negative error code in case of error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_get_prime_bits.3 b/doc/manpages/gnutls_dh_get_prime_bits.3 new file mode 100644 index 0000000..d4dedc8 --- /dev/null +++ b/doc/manpages/gnutls_dh_get_prime_bits.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_prime_bits" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_prime_bits \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_get_prime_bits(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +This function will return the bits of the prime used in the last +Diffie\-Hellman key exchange with the peer. Should be used for both +anonymous and ephemeral Diffie\-Hellman. Note that some ciphers, +like RSA and DSA without DHE, do not use a Diffie\-Hellman key +exchange, and then this function will return 0. +.SH "RETURNS" +The Diffie\-Hellman bit strength is returned, or 0 if no +Diffie\-Hellman key exchange was done, or a negative error code on +failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_get_pubkey.3 b/doc/manpages/gnutls_dh_get_pubkey.3 new file mode 100644 index 0000000..30fe8fa --- /dev/null +++ b/doc/manpages/gnutls_dh_get_pubkey.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_pubkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_pubkey \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_get_pubkey(gnutls_session_t " session ", gnutls_datum_t * " raw_key ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "gnutls_datum_t * raw_key" 12 +will hold the public key. +.SH "DESCRIPTION" +This function will return the peer's public key used in the last +Diffie\-Hellman key exchange. This function should be used for both +anonymous and ephemeral Diffie\-Hellman. The output parameters must +be freed with \fBgnutls_free()\fP. + +Note, that public key is exported as non\-negative +integer and may include a leading zero byte. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_get_secret_bits.3 b/doc/manpages/gnutls_dh_get_secret_bits.3 new file mode 100644 index 0000000..9ac948f --- /dev/null +++ b/doc/manpages/gnutls_dh_get_secret_bits.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_secret_bits" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_secret_bits \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_get_secret_bits(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +This function will return the bits used in the last Diffie\-Hellman +key exchange with the peer. Should be used for both anonymous and +ephemeral Diffie\-Hellman. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_cpy.3 b/doc/manpages/gnutls_dh_params_cpy.3 new file mode 100644 index 0000000..93658ea --- /dev/null +++ b/doc/manpages/gnutls_dh_params_cpy.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_cpy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_cpy \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_cpy(gnutls_dh_params_t " dst ", gnutls_dh_params_t " src ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t dst" 12 +Is the destination parameters, which should be initialized. +.IP "gnutls_dh_params_t src" 12 +Is the source parameters +.SH "DESCRIPTION" +This function will copy the DH parameters structure from source +to destination. The destination should be already initialized. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_deinit.3 b/doc/manpages/gnutls_dh_params_deinit.3 new file mode 100644 index 0000000..982f481 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_dh_params_deinit(gnutls_dh_params_t " dh_params ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t dh_params" 12 +The parameters +.SH "DESCRIPTION" +This function will deinitialize the DH parameters type. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_export2_pkcs3.3 b/doc/manpages/gnutls_dh_params_export2_pkcs3.3 new file mode 100644 index 0000000..5dc3dbd --- /dev/null +++ b/doc/manpages/gnutls_dh_params_export2_pkcs3.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_export2_pkcs3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_export2_pkcs3 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_export2_pkcs3(gnutls_dh_params_t " params ", gnutls_x509_crt_fmt_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t params" 12 +Holds the DH parameters +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "gnutls_datum_t * out" 12 +will contain a PKCS3 DHParams structure PEM or DER encoded +.SH "DESCRIPTION" +This function will export the given dh parameters to a PKCS3 +DHParams structure. This is the format generated by "openssl dhparam" tool. +The data in \fIout\fP will be allocated using \fBgnutls_malloc()\fP. + +If the structure is PEM encoded, it will have a header +of "BEGIN DH PARAMETERS". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_export_pkcs3.3 b/doc/manpages/gnutls_dh_params_export_pkcs3.3 new file mode 100644 index 0000000..320ede4 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_export_pkcs3.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_export_pkcs3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_export_pkcs3 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_export_pkcs3(gnutls_dh_params_t " params ", gnutls_x509_crt_fmt_t " format ", unsigned char * " params_data ", size_t * " params_data_size ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t params" 12 +Holds the DH parameters +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "unsigned char * params_data" 12 +will contain a PKCS3 DHParams structure PEM or DER encoded +.IP "size_t * params_data_size" 12 +holds the size of params_data (and will be replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the given dh parameters to a PKCS3 +DHParams structure. This is the format generated by "openssl dhparam" tool. +If the buffer provided is not long enough to hold the output, then +GNUTLS_E_SHORT_MEMORY_BUFFER will be returned. + +If the structure is PEM encoded, it will have a header +of "BEGIN DH PARAMETERS". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_export_raw.3 b/doc/manpages/gnutls_dh_params_export_raw.3 new file mode 100644 index 0000000..13b4d15 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_export_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_export_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_export_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_export_raw(gnutls_dh_params_t " params ", gnutls_datum_t * " prime ", gnutls_datum_t * " generator ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t params" 12 +Holds the DH parameters +.IP "gnutls_datum_t * prime" 12 +will hold the new prime +.IP "gnutls_datum_t * generator" 12 +will hold the new generator +.IP "unsigned int * bits" 12 +if non null will hold the secret key's number of bits +.SH "DESCRIPTION" +This function will export the pair of prime and generator for use +in the Diffie\-Hellman key exchange. The new parameters will be +allocated using \fBgnutls_malloc()\fP and will be stored in the +appropriate datum. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_generate2.3 b/doc/manpages/gnutls_dh_params_generate2.3 new file mode 100644 index 0000000..a321b14 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_generate2.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_generate2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_generate2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_generate2(gnutls_dh_params_t " dparams ", unsigned int " bits ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t dparams" 12 +The parameters +.IP "unsigned int bits" 12 +is the prime's number of bits +.SH "DESCRIPTION" +This function will generate a new pair of prime and generator for use in +the Diffie\-Hellman key exchange. This may take long time. + +It is recommended not to set the number of bits directly, but +use \fBgnutls_sec_param_to_pk_bits()\fP instead. +Also note that the DH parameters are only useful to servers. +Since clients use the parameters sent by the server, it's of +no use to call this in client side. + +The parameters generated are of the DSA form. It also is possible +to generate provable parameters (following the Shawe\-Taylor +algorithm), using \fBgnutls_x509_privkey_generate2()\fP with DSA option +and the \fBGNUTLS_PRIVKEY_FLAG_PROVABLE\fP flag set. These can the +be imported with \fBgnutls_dh_params_import_dsa()\fP. + +It is no longer recommended for applications to generate parameters. +See the "Parameter generation" section in the manual. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_import_dsa.3 b/doc/manpages/gnutls_dh_params_import_dsa.3 new file mode 100644 index 0000000..c3d1c81 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_import_dsa.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_import_dsa" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_import_dsa \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_import_dsa(gnutls_dh_params_t " dh_params ", gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t dh_params" 12 +The parameters +.IP "gnutls_x509_privkey_t key" 12 +holds a DSA private key +.SH "DESCRIPTION" +This function will import the prime and generator of the DSA key for use +in the Diffie\-Hellman key exchange. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_import_pkcs3.3 b/doc/manpages/gnutls_dh_params_import_pkcs3.3 new file mode 100644 index 0000000..dc50930 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_import_pkcs3.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_import_pkcs3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_import_pkcs3 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_import_pkcs3(gnutls_dh_params_t " params ", const gnutls_datum_t * " pkcs3_params ", gnutls_x509_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t params" 12 +The parameters +.IP "const gnutls_datum_t * pkcs3_params" 12 +should contain a PKCS3 DHParams structure PEM or DER encoded +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of params. PEM or DER. +.SH "DESCRIPTION" +This function will extract the DHParams found in a PKCS3 formatted +structure. This is the format generated by "openssl dhparam" tool. + +If the structure is PEM encoded, it should have a header +of "BEGIN DH PARAMETERS". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_import_raw.3 b/doc/manpages/gnutls_dh_params_import_raw.3 new file mode 100644 index 0000000..689d67f --- /dev/null +++ b/doc/manpages/gnutls_dh_params_import_raw.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_import_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_import_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_import_raw(gnutls_dh_params_t " dh_params ", const gnutls_datum_t * " prime ", const gnutls_datum_t * " generator ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t dh_params" 12 +The parameters +.IP "const gnutls_datum_t * prime" 12 +holds the new prime +.IP "const gnutls_datum_t * generator" 12 +holds the new generator +.SH "DESCRIPTION" +This function will replace the pair of prime and generator for use +in the Diffie\-Hellman key exchange. The new parameters should be +stored in the appropriate gnutls_datum. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_import_raw2.3 b/doc/manpages/gnutls_dh_params_import_raw2.3 new file mode 100644 index 0000000..27bf55f --- /dev/null +++ b/doc/manpages/gnutls_dh_params_import_raw2.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_import_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_import_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_import_raw2(gnutls_dh_params_t " dh_params ", const gnutls_datum_t * " prime ", const gnutls_datum_t * " generator ", unsigned " key_bits ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t dh_params" 12 +The parameters +.IP "const gnutls_datum_t * prime" 12 +holds the new prime +.IP "const gnutls_datum_t * generator" 12 +holds the new generator +.IP "unsigned key_bits" 12 +the private key bits (set to zero when unknown) +.SH "DESCRIPTION" +This function will replace the pair of prime and generator for use +in the Diffie\-Hellman key exchange. The new parameters should be +stored in the appropriate gnutls_datum. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_import_raw3.3 b/doc/manpages/gnutls_dh_params_import_raw3.3 new file mode 100644 index 0000000..35e2c7c --- /dev/null +++ b/doc/manpages/gnutls_dh_params_import_raw3.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_import_raw3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_import_raw3 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_import_raw3(gnutls_dh_params_t " dh_params ", const gnutls_datum_t * " prime ", const gnutls_datum_t * " q ", const gnutls_datum_t * " generator ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t dh_params" 12 +The parameters +.IP "const gnutls_datum_t * prime" 12 +holds the new prime +.IP "const gnutls_datum_t * q" 12 +holds the subgroup if available, otherwise NULL +.IP "const gnutls_datum_t * generator" 12 +holds the new generator +.SH "DESCRIPTION" +This function will replace the pair of prime and generator for use +in the Diffie\-Hellman key exchange. The new parameters should be +stored in the appropriate gnutls_datum. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_params_init.3 b/doc/manpages/gnutls_dh_params_init.3 new file mode 100644 index 0000000..70d780b --- /dev/null +++ b/doc/manpages/gnutls_dh_params_init.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_init \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_dh_params_init(gnutls_dh_params_t * " dh_params ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t * dh_params" 12 +The parameters +.SH "DESCRIPTION" +This function will initialize the DH parameters type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dh_set_prime_bits.3 b/doc/manpages/gnutls_dh_set_prime_bits.3 new file mode 100644 index 0000000..62bf397 --- /dev/null +++ b/doc/manpages/gnutls_dh_set_prime_bits.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_set_prime_bits" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dh_set_prime_bits \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_dh_set_prime_bits(gnutls_session_t " session ", unsigned int " bits ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int bits" 12 +is the number of bits +.SH "DESCRIPTION" +This function sets the number of bits, for use in a Diffie\-Hellman +key exchange. This is used both in DH ephemeral and DH anonymous +cipher suites. This will set the minimum size of the prime that +will be used for the handshake. + +In the client side it sets the minimum accepted number of bits. If +a server sends a prime with less bits than that +\fBGNUTLS_E_DH_PRIME_UNACCEPTABLE\fP will be returned by the handshake. + +Note that this function will warn via the audit log for value that +are believed to be weak. + +The function has no effect in server side. + +Note that since 3.1.7 this function is deprecated. The minimum +number of bits is set by the priority string level. +Also this function must be called after \fBgnutls_priority_set_direct()\fP +or the set value may be overridden by the selected priority options. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_digest_get_id.3 b/doc/manpages/gnutls_digest_get_id.3 new file mode 100644 index 0000000..d7b7e7c --- /dev/null +++ b/doc/manpages/gnutls_digest_get_id.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_digest_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_digest_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_digest_algorithm_t gnutls_digest_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a digest algorithm name +.SH "DESCRIPTION" +Convert a string to a \fBgnutls_digest_algorithm_t\fP value. The names are +compared in a case insensitive way. +.SH "RETURNS" +a \fBgnutls_digest_algorithm_t\fP id of the specified MAC +algorithm string, or \fBGNUTLS_DIG_UNKNOWN\fP on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_digest_get_name.3 b/doc/manpages/gnutls_digest_get_name.3 new file mode 100644 index 0000000..5833101 --- /dev/null +++ b/doc/manpages/gnutls_digest_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_digest_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_digest_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_digest_get_name(gnutls_digest_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_digest_algorithm_t algorithm" 12 +is a digest algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_digest_algorithm_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified digest +algorithm, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_digest_get_oid.3 b/doc/manpages/gnutls_digest_get_oid.3 new file mode 100644 index 0000000..f494875 --- /dev/null +++ b/doc/manpages/gnutls_digest_get_oid.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_digest_get_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_digest_get_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_digest_get_oid(gnutls_digest_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_digest_algorithm_t algorithm" 12 +is a digest algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_digest_algorithm_t\fP value to its object identifier. +.SH "RETURNS" +a string that contains the object identifier of the specified digest +algorithm, or \fBNULL\fP. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_digest_list.3 b/doc/manpages/gnutls_digest_list.3 new file mode 100644 index 0000000..48625c7 --- /dev/null +++ b/doc/manpages/gnutls_digest_list.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_digest_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_digest_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_digest_algorithm_t * gnutls_digest_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get a list of hash (digest) algorithms supported by GnuTLS. + +This function is not thread safe. +.SH "RETURNS" +Return a (0)\-terminated list of \fBgnutls_digest_algorithm_t\fP +integers indicating the available digests. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_digest_set_secure.3 b/doc/manpages/gnutls_digest_set_secure.3 new file mode 100644 index 0000000..3bca45f --- /dev/null +++ b/doc/manpages/gnutls_digest_set_secure.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_digest_set_secure" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_digest_set_secure \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_digest_set_secure(gnutls_digest_algorithm_t " dig ", unsigned int " secure ");" +.SH ARGUMENTS +.IP "gnutls_digest_algorithm_t dig" 12 +is a digest algorithm +.IP "unsigned int secure" 12 +whether to mark the digest algorithm secure +.SH "DESCRIPTION" +Modify the previous system wide setting that marked \fIdig\fP as secure +or insecure. This only has effect when the algorithm is enabled +through the allowlisting mode in the configuration file, or when +the setting is modified with a prior call to this function. +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dtls_cookie_send.3 b/doc/manpages/gnutls_dtls_cookie_send.3 new file mode 100644 index 0000000..03ef024 --- /dev/null +++ b/doc/manpages/gnutls_dtls_cookie_send.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_cookie_send" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_cookie_send \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "int gnutls_dtls_cookie_send(gnutls_datum_t * " key ", void * " client_data ", size_t " client_data_size ", gnutls_dtls_prestate_st * " prestate ", gnutls_transport_ptr_t " ptr ", gnutls_push_func " push_func ");" +.SH ARGUMENTS +.IP "gnutls_datum_t * key" 12 +is a random key to be used at cookie generation +.IP "void * client_data" 12 +contains data identifying the client (i.e. address) +.IP "size_t client_data_size" 12 +The size of client's data +.IP "gnutls_dtls_prestate_st * prestate" 12 +The previous cookie returned by \fBgnutls_dtls_cookie_verify()\fP +.IP "gnutls_transport_ptr_t ptr" 12 +A transport pointer to be used by \fIpush_func\fP +.IP "gnutls_push_func push_func" 12 +A function that will be used to reply +.SH "DESCRIPTION" +This function can be used to prevent denial of service +attacks to a DTLS server by requiring the client to +reply using a cookie sent by this function. That way +it can be ensured that a client we allocated resources +for (i.e. \fBgnutls_session_t\fP) is the one that the +original incoming packet was originated from. + +This function must be called at the first incoming packet, +prior to allocating any resources and must be succeeded +by \fBgnutls_dtls_cookie_verify()\fP. +.SH "RETURNS" +the number of bytes sent, or a negative error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dtls_cookie_verify.3 b/doc/manpages/gnutls_dtls_cookie_verify.3 new file mode 100644 index 0000000..fb5573d --- /dev/null +++ b/doc/manpages/gnutls_dtls_cookie_verify.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_cookie_verify" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_cookie_verify \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "int gnutls_dtls_cookie_verify(gnutls_datum_t * " key ", void * " client_data ", size_t " client_data_size ", void * " _msg ", size_t " msg_size ", gnutls_dtls_prestate_st * " prestate ");" +.SH ARGUMENTS +.IP "gnutls_datum_t * key" 12 +is a random key to be used at cookie generation +.IP "void * client_data" 12 +contains data identifying the client (i.e. address) +.IP "size_t client_data_size" 12 +The size of client's data +.IP "void * _msg" 12 +An incoming message that initiates a connection. +.IP "size_t msg_size" 12 +The size of the message. +.IP "gnutls_dtls_prestate_st * prestate" 12 +The cookie of this client. +.SH "DESCRIPTION" +This function will verify the received message for +a valid cookie. If a valid cookie is returned then +it should be associated with the session using +\fBgnutls_dtls_prestate_set()\fP; + +This function must be called after \fBgnutls_dtls_cookie_send()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dtls_get_data_mtu.3 b/doc/manpages/gnutls_dtls_get_data_mtu.3 new file mode 100644 index 0000000..7eb10c5 --- /dev/null +++ b/doc/manpages/gnutls_dtls_get_data_mtu.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_get_data_mtu" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_get_data_mtu \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "unsigned int gnutls_dtls_get_data_mtu(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function will return the actual maximum transfer unit for +application data. I.e. DTLS headers are subtracted from the +actual MTU which is set using \fBgnutls_dtls_set_mtu()\fP. +.SH "RETURNS" +the maximum allowed transfer unit. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dtls_get_mtu.3 b/doc/manpages/gnutls_dtls_get_mtu.3 new file mode 100644 index 0000000..442946e --- /dev/null +++ b/doc/manpages/gnutls_dtls_get_mtu.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_get_mtu" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_get_mtu \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "unsigned int gnutls_dtls_get_mtu(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function will return the MTU size as set with +\fBgnutls_dtls_set_mtu()\fP. This is not the actual MTU +of data you can transmit. Use \fBgnutls_dtls_get_data_mtu()\fP +for that reason. +.SH "RETURNS" +the set maximum transfer unit. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dtls_get_timeout.3 b/doc/manpages/gnutls_dtls_get_timeout.3 new file mode 100644 index 0000000..f0e62e1 --- /dev/null +++ b/doc/manpages/gnutls_dtls_get_timeout.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_get_timeout" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_get_timeout \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "unsigned int gnutls_dtls_get_timeout(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function will return the milliseconds remaining +for a retransmission of the previously sent handshake +message. This function is useful when DTLS is used in +non\-blocking mode, to estimate when to call \fBgnutls_handshake()\fP +if no packets have been received. +.SH "RETURNS" +the remaining time in milliseconds. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dtls_prestate_set.3 b/doc/manpages/gnutls_dtls_prestate_set.3 new file mode 100644 index 0000000..4320f56 --- /dev/null +++ b/doc/manpages/gnutls_dtls_prestate_set.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_prestate_set" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_prestate_set \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "void gnutls_dtls_prestate_set(gnutls_session_t " session ", gnutls_dtls_prestate_st * " prestate ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +a new session +.IP "gnutls_dtls_prestate_st * prestate" 12 +contains the client's prestate +.SH "DESCRIPTION" +This function will associate the prestate acquired by +the cookie authentication with the client, with the newly +established session. + +This functions must be called after a successful \fBgnutls_dtls_cookie_verify()\fP +and should be succeeded by the actual DTLS handshake using \fBgnutls_handshake()\fP. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dtls_set_data_mtu.3 b/doc/manpages/gnutls_dtls_set_data_mtu.3 new file mode 100644 index 0000000..fb07e79 --- /dev/null +++ b/doc/manpages/gnutls_dtls_set_data_mtu.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_set_data_mtu" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_set_data_mtu \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "int gnutls_dtls_set_data_mtu(gnutls_session_t " session ", unsigned int " mtu ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int mtu" 12 +The maximum unencrypted transfer unit of the session +.SH "DESCRIPTION" +This function will set the maximum size of the *unencrypted* records +which will be sent over a DTLS session. It is equivalent to calculating +the DTLS packet overhead with the current encryption parameters, and +calling \fBgnutls_dtls_set_mtu()\fP with that value. In particular, this means +that you may need to call this function again after any negotiation or +renegotiation, in order to ensure that the MTU is still sufficient to +account for the new protocol overhead. + +In most cases you only need to call \fBgnutls_dtls_set_mtu()\fP with +the maximum MTU of your transport layer. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH "SINCE" +3.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dtls_set_mtu.3 b/doc/manpages/gnutls_dtls_set_mtu.3 new file mode 100644 index 0000000..1020258 --- /dev/null +++ b/doc/manpages/gnutls_dtls_set_mtu.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_set_mtu" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_set_mtu \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "void gnutls_dtls_set_mtu(gnutls_session_t " session ", unsigned int " mtu ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int mtu" 12 +The maximum transfer unit of the transport +.SH "DESCRIPTION" +This function will set the maximum transfer unit of the transport +that DTLS packets are sent over. Note that this should exclude +the IP (or IPv6) and UDP headers. So for DTLS over IPv6 on an +Ethernet device with MTU 1500, the DTLS MTU set with this function +would be 1500 \- 40 (IPV6 header) \- 8 (UDP header) = 1452. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_dtls_set_timeouts.3 b/doc/manpages/gnutls_dtls_set_timeouts.3 new file mode 100644 index 0000000..2062df2 --- /dev/null +++ b/doc/manpages/gnutls_dtls_set_timeouts.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_set_timeouts" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_set_timeouts \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "void gnutls_dtls_set_timeouts(gnutls_session_t " session ", unsigned int " retrans_timeout ", unsigned int " total_timeout ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int retrans_timeout" 12 +The time at which a retransmission will occur in milliseconds +.IP "unsigned int total_timeout" 12 +The time at which the connection will be aborted, in milliseconds. +.SH "DESCRIPTION" +This function will set the timeouts required for the DTLS handshake +protocol. The retransmission timeout is the time after which a +message from the peer is not received, the previous messages will +be retransmitted. The total timeout is the time after which the +handshake will be aborted with \fBGNUTLS_E_TIMEDOUT\fP. + +The DTLS protocol recommends the values of 1 sec and 60 seconds +respectively, and these are the default values. + +To disable retransmissions set a \fIretrans_timeout\fP larger than the \fItotal_timeout\fP . +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_early_cipher_get.3 b/doc/manpages/gnutls_early_cipher_get.3 new file mode 100644 index 0000000..3e2ab3f --- /dev/null +++ b/doc/manpages/gnutls_early_cipher_get.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_early_cipher_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_early_cipher_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_cipher_algorithm_t gnutls_early_cipher_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the cipher algorithm used for encrypting early data. +.SH "RETURNS" +the cipher used for early data, a +\fBgnutls_cipher_algorithm_t\fP type. +.SH "SINCE" +3.7.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_early_prf_hash_get.3 b/doc/manpages/gnutls_early_prf_hash_get.3 new file mode 100644 index 0000000..128b9e0 --- /dev/null +++ b/doc/manpages/gnutls_early_prf_hash_get.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_early_prf_hash_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_early_prf_hash_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_digest_algorithm_t gnutls_early_prf_hash_get(const gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "const gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the hash algorithm used as a PRF to derive keys for encrypting +early data in TLS 1.3. +.SH "RETURNS" +the hash algorithm used for early data, a +\fBgnutls_digest_algorithm_t\fP value. +.SH "SINCE" +3.7.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ecc_curve_get.3 b/doc/manpages/gnutls_ecc_curve_get.3 new file mode 100644 index 0000000..ebe4ee7 --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_get.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_ecc_curve_t gnutls_ecc_curve_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Returns the currently used elliptic curve for key exchange. Only valid +when using an elliptic curve ciphersuite. +.SH "RETURNS" +the currently used curve, a \fBgnutls_ecc_curve_t\fP +type. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ecc_curve_get_id.3 b/doc/manpages/gnutls_ecc_curve_get_id.3 new file mode 100644 index 0000000..04ebdb3 --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_get_id.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_ecc_curve_t gnutls_ecc_curve_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a curve name +.SH "DESCRIPTION" +The names are compared in a case insensitive way. +.SH "RETURNS" +return a \fBgnutls_ecc_curve_t\fP value corresponding to +the specified curve, or \fBGNUTLS_ECC_CURVE_INVALID\fP on error. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ecc_curve_get_name.3 b/doc/manpages/gnutls_ecc_curve_get_name.3 new file mode 100644 index 0000000..3782095 --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_ecc_curve_get_name(gnutls_ecc_curve_t " curve ");" +.SH ARGUMENTS +.IP "gnutls_ecc_curve_t curve" 12 +is an ECC curve +.SH "DESCRIPTION" +Convert a \fBgnutls_ecc_curve_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified +curve or \fBNULL\fP. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ecc_curve_get_oid.3 b/doc/manpages/gnutls_ecc_curve_get_oid.3 new file mode 100644 index 0000000..47b213f --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_get_oid.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_get_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_get_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_ecc_curve_get_oid(gnutls_ecc_curve_t " curve ");" +.SH ARGUMENTS +.IP "gnutls_ecc_curve_t curve" 12 +is an ECC curve +.SH "DESCRIPTION" +Convert a \fBgnutls_ecc_curve_t\fP value to its object identifier. +.SH "RETURNS" +a string that contains the OID of the specified +curve or \fBNULL\fP. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ecc_curve_get_pk.3 b/doc/manpages/gnutls_ecc_curve_get_pk.3 new file mode 100644 index 0000000..ef05337 --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_get_pk.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_get_pk" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_get_pk \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_pk_algorithm_t gnutls_ecc_curve_get_pk(gnutls_ecc_curve_t " curve ");" +.SH ARGUMENTS +.IP "gnutls_ecc_curve_t curve" 12 +is an ECC curve +.SH "RETURNS" +the public key algorithm associated with the named curve or \fBGNUTLS_PK_UNKNOWN\fP. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ecc_curve_get_size.3 b/doc/manpages/gnutls_ecc_curve_get_size.3 new file mode 100644 index 0000000..d587855 --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_get_size.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_get_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_get_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_ecc_curve_get_size(gnutls_ecc_curve_t " curve ");" +.SH ARGUMENTS +.IP "gnutls_ecc_curve_t curve" 12 +is an ECC curve +.SH "RETURNS" +the size in bytes of the curve or 0 on failure. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ecc_curve_list.3 b/doc/manpages/gnutls_ecc_curve_list.3 new file mode 100644 index 0000000..b1a9aa0 --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_list.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_ecc_curve_t * gnutls_ecc_curve_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get the list of supported elliptic curves. + +This function is not thread safe. +.SH "RETURNS" +Return a (0)\-terminated list of \fBgnutls_ecc_curve_t\fP +integers indicating the available curves. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ecc_curve_set_enabled.3 b/doc/manpages/gnutls_ecc_curve_set_enabled.3 new file mode 100644 index 0000000..e2fb8ff --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_set_enabled.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_set_enabled" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_set_enabled \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_ecc_curve_set_enabled(gnutls_ecc_curve_t " curve ", unsigned int " enabled ");" +.SH ARGUMENTS +.IP "gnutls_ecc_curve_t curve" 12 +is an ECC curve +.IP "unsigned int enabled" 12 +whether to enable the curve +.SH "DESCRIPTION" +Modify the previous system wide setting that marked \fIcurve\fP as +enabled or disabled. Calling this fuction is allowed +only if allowlisting mode is set in the configuration file, +and only if the system\-wide TLS priority string +has not been initialized yet. +The intended usage is to provide applications with a way +to expressly deviate from the distribution or site defaults +inherited from the configuration file. +The modification is composable with further modifications +performed through the priority string mechanism. + +This function is not thread\-safe and is intended to be called +in the main thread at the beginning of the process execution. +.SH "RETURNS" +0 on success or negative error code otherwise. +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_encode_ber_digest_info.3 b/doc/manpages/gnutls_encode_ber_digest_info.3 new file mode 100644 index 0000000..c344fc5 --- /dev/null +++ b/doc/manpages/gnutls_encode_ber_digest_info.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_encode_ber_digest_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_encode_ber_digest_info \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_encode_ber_digest_info(gnutls_digest_algorithm_t " hash ", const gnutls_datum_t * " digest ", gnutls_datum_t * " output ");" +.SH ARGUMENTS +.IP "gnutls_digest_algorithm_t hash" 12 +the hash algorithm that was used to get the digest +.IP "const gnutls_datum_t * digest" 12 +must contain the digest data +.IP "gnutls_datum_t * output" 12 +will contain the allocated DigestInfo BER encoded data +.SH "DESCRIPTION" +This function will encode the provided digest data, and its +algorithm into an RSA PKCS\fB1\fP 1.5 DigestInfo structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_encode_gost_rs_value.3 b/doc/manpages/gnutls_encode_gost_rs_value.3 new file mode 100644 index 0000000..581891a --- /dev/null +++ b/doc/manpages/gnutls_encode_gost_rs_value.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_encode_gost_rs_value" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_encode_gost_rs_value \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_encode_gost_rs_value(gnutls_datum_t * " sig_value ", const gnutls_datum_t * " r ", const gnutls_datum_t * " s ");" +.SH ARGUMENTS +.IP "gnutls_datum_t * sig_value" 12 +will hold a GOST signature according to RFC 4491 section 2.2.2 +.IP "const gnutls_datum_t * r" 12 +must contain the r value +.IP "const gnutls_datum_t * s" 12 +must contain the s value +.SH "DESCRIPTION" +This function will encode the provided r and s values, into binary +representation according to RFC 4491 section 2.2.2, used for GOST R +34.10\-2001 (and thus also for GOST R 34.10\-2012) signatures. + +The output value should be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_encode_rs_value.3 b/doc/manpages/gnutls_encode_rs_value.3 new file mode 100644 index 0000000..6b29653 --- /dev/null +++ b/doc/manpages/gnutls_encode_rs_value.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_encode_rs_value" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_encode_rs_value \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_encode_rs_value(gnutls_datum_t * " sig_value ", const gnutls_datum_t * " r ", const gnutls_datum_t * " s ");" +.SH ARGUMENTS +.IP "gnutls_datum_t * sig_value" 12 +will hold a Dss\-Sig\-Value DER encoded structure +.IP "const gnutls_datum_t * r" 12 +must contain the r value +.IP "const gnutls_datum_t * s" 12 +must contain the s value +.SH "DESCRIPTION" +This function will encode the provided r and s values, +into a Dss\-Sig\-Value structure, used for DSA and ECDSA +signatures. + +The output value should be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_error_is_fatal.3 b/doc/manpages/gnutls_error_is_fatal.3 new file mode 100644 index 0000000..baf0767 --- /dev/null +++ b/doc/manpages/gnutls_error_is_fatal.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_error_is_fatal" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_error_is_fatal \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_error_is_fatal(int " error ");" +.SH ARGUMENTS +.IP "int error" 12 +is a GnuTLS error code, a negative error code +.SH "DESCRIPTION" +If a GnuTLS function returns a negative error code you may feed that +value to this function to see if the error condition is fatal to +a TLS session (i.e., must be terminated). + +Note that you may also want to check the error code manually, since some +non\-fatal errors to the protocol (such as a warning alert or +a rehandshake request) may be fatal for your program. + +This function is only useful if you are dealing with errors from +functions that relate to a TLS session (e.g., record layer or handshake +layer handling functions). +.SH "RETURNS" +Non\-zero value on fatal errors or zero on non\-fatal. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_error_to_alert.3 b/doc/manpages/gnutls_error_to_alert.3 new file mode 100644 index 0000000..abc0dc9 --- /dev/null +++ b/doc/manpages/gnutls_error_to_alert.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_error_to_alert" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_error_to_alert \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_error_to_alert(int " err ", int * " level ");" +.SH ARGUMENTS +.IP "int err" 12 +is a negative integer +.IP "int * level" 12 +the alert level will be stored there +.SH "DESCRIPTION" +Get an alert depending on the error code returned by a gnutls +function. All alerts sent by this function should be considered +fatal. The only exception is when \fIerr\fP is \fBGNUTLS_E_REHANDSHAKE\fP, +where a warning alert should be sent to the peer indicating that no +renegotiation will be performed. + +If there is no mapping to a valid alert the alert to indicate +internal error (\fBGNUTLS_A_INTERNAL_ERROR\fP) is returned. +.SH "RETURNS" +the alert code to use for a particular error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_est_record_overhead_size.3 b/doc/manpages/gnutls_est_record_overhead_size.3 new file mode 100644 index 0000000..b2aa6d4 --- /dev/null +++ b/doc/manpages/gnutls_est_record_overhead_size.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_est_record_overhead_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_est_record_overhead_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "size_t gnutls_est_record_overhead_size(gnutls_protocol_t " version ", gnutls_cipher_algorithm_t " cipher ", gnutls_mac_algorithm_t " mac ", gnutls_compression_method_t " comp ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_protocol_t version" 12 +is a \fBgnutls_protocol_t\fP value +.IP "gnutls_cipher_algorithm_t cipher" 12 +is a \fBgnutls_cipher_algorithm_t\fP value +.IP "gnutls_mac_algorithm_t mac" 12 +is a \fBgnutls_mac_algorithm_t\fP value +.IP "gnutls_compression_method_t comp" 12 +is a \fBgnutls_compression_method_t\fP value (ignored) +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will return the set size in bytes of the overhead +due to TLS (or DTLS) per record. + +Note that this function may provide inaccurate values when TLS +extensions that modify the record format are negotiated. In these +cases a more accurate value can be obtained using \fBgnutls_record_overhead_size()\fP +after a completed handshake. +.SH "SINCE" +3.2.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ext_get_current_msg.3 b/doc/manpages/gnutls_ext_get_current_msg.3 new file mode 100644 index 0000000..b600292 --- /dev/null +++ b/doc/manpages/gnutls_ext_get_current_msg.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ext_get_current_msg" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ext_get_current_msg \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_ext_get_current_msg(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +a \fBgnutls_session_t\fP opaque pointer +.SH "DESCRIPTION" +This function allows an extension handler to obtain the message +this extension is being called from. The returned value is a single +entry of the \fBgnutls_ext_flags_t\fP enumeration. That is, if an +extension was registered with the \fBGNUTLS_EXT_FLAG_HRR\fP and +\fBGNUTLS_EXT_FLAG_EE\fP flags, the value when called during parsing of the +encrypted extensions message will be \fBGNUTLS_EXT_FLAG_EE\fP. + +If not called under an extension handler, its value is undefined. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ext_get_data.3 b/doc/manpages/gnutls_ext_get_data.3 new file mode 100644 index 0000000..18ec3f0 --- /dev/null +++ b/doc/manpages/gnutls_ext_get_data.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ext_get_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ext_get_data \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_ext_get_data(gnutls_session_t " session ", unsigned " tls_id ", gnutls_ext_priv_data_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +a \fBgnutls_session_t\fP opaque pointer +.IP "unsigned tls_id" 12 +the numeric id of the extension +.IP "gnutls_ext_priv_data_t * data" 12 +a pointer to the private data to retrieve +.SH "DESCRIPTION" +This function retrieves any data previously stored with \fBgnutls_ext_set_data()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ext_get_name.3 b/doc/manpages/gnutls_ext_get_name.3 new file mode 100644 index 0000000..2f22e66 --- /dev/null +++ b/doc/manpages/gnutls_ext_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ext_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ext_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_ext_get_name(unsigned int " ext ");" +.SH ARGUMENTS +.IP "unsigned int ext" 12 +is a TLS extension numeric ID +.SH "DESCRIPTION" +Convert a TLS extension numeric ID to a printable string. +.SH "RETURNS" +a pointer to a string that contains the name of the +specified cipher, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ext_get_name2.3 b/doc/manpages/gnutls_ext_get_name2.3 new file mode 100644 index 0000000..ddae4e9 --- /dev/null +++ b/doc/manpages/gnutls_ext_get_name2.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ext_get_name2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ext_get_name2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_ext_get_name2(gnutls_session_t " session ", unsigned int " tls_id ", gnutls_ext_parse_type_t " parse_point ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +a \fBgnutls_session_t\fP opaque pointer +.IP "unsigned int tls_id" 12 +is a TLS extension numeric ID +.IP "gnutls_ext_parse_type_t parse_point" 12 +the parse type of the extension +.SH "DESCRIPTION" +Convert a TLS extension numeric ID to a printable string. +.SH "RETURNS" +a pointer to a string that contains the name of the +specified cipher, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ext_raw_parse.3 b/doc/manpages/gnutls_ext_raw_parse.3 new file mode 100644 index 0000000..624d974 --- /dev/null +++ b/doc/manpages/gnutls_ext_raw_parse.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ext_raw_parse" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ext_raw_parse \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_ext_raw_parse(void * " ctx ", gnutls_ext_raw_process_func " cb ", const gnutls_datum_t * " data ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "void * ctx" 12 +a pointer to pass to callback function +.IP "gnutls_ext_raw_process_func cb" 12 +callback function to process each extension found +.IP "const gnutls_datum_t * data" 12 +TLS extension data +.IP "unsigned int flags" 12 +should be zero or \fBGNUTLS_EXT_RAW_FLAG_TLS_CLIENT_HELLO\fP or \fBGNUTLS_EXT_RAW_FLAG_DTLS_CLIENT_HELLO\fP +.SH "DESCRIPTION" +This function iterates through the TLS extensions as passed in + \fIdata\fP , passing the individual extension data to callback. The + \fIdata\fP must conform to Extension extensions<0..2^16\-1> format. + +If flags is \fBGNUTLS_EXT_RAW_TLS_FLAG_CLIENT_HELLO\fP then this function +will parse the extension data from the position, as if the packet in + \fIdata\fP is a client hello (without record or handshake headers) \- +as provided by \fBgnutls_handshake_set_hook_function()\fP. + +The return value of the callback will be propagated. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. On unknown +flags it returns \fBGNUTLS_E_INVALID_REQUEST\fP. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ext_register.3 b/doc/manpages/gnutls_ext_register.3 new file mode 100644 index 0000000..22c8a8e --- /dev/null +++ b/doc/manpages/gnutls_ext_register.3 @@ -0,0 +1,62 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ext_register" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ext_register \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_ext_register(const char * " name ", int " id ", gnutls_ext_parse_type_t " parse_point ", gnutls_ext_recv_func " recv_func ", gnutls_ext_send_func " send_func ", gnutls_ext_deinit_data_func " deinit_func ", gnutls_ext_pack_func " pack_func ", gnutls_ext_unpack_func " unpack_func ");" +.SH ARGUMENTS +.IP "const char * name" 12 +the name of the extension to register +.IP "int id" 12 +the numeric TLS id of the extension +.IP "gnutls_ext_parse_type_t parse_point" 12 +the parse type of the extension (see gnutls_ext_parse_type_t) +.IP "gnutls_ext_recv_func recv_func" 12 +a function to receive the data +.IP "gnutls_ext_send_func send_func" 12 +a function to send the data +.IP "gnutls_ext_deinit_data_func deinit_func" 12 +a function deinitialize any private data +.IP "gnutls_ext_pack_func pack_func" 12 +a function which serializes the extension's private data (used on session packing for resumption) +.IP "gnutls_ext_unpack_func unpack_func" 12 +a function which will deserialize the extension's private data +.SH "DESCRIPTION" +This function will register a new extension type. The extension will remain +registered until \fBgnutls_global_deinit()\fP is called. If the extension type +is already registered then \fBGNUTLS_E_ALREADY_REGISTERED\fP will be returned. + +Each registered extension can store temporary data into the gnutls_session_t +structure using \fBgnutls_ext_set_data()\fP, and they can be retrieved using +\fBgnutls_ext_get_data()\fP. + +Any extensions registered with this function are valid for the client +and TLS1.2 server hello (or encrypted extensions for TLS1.3). + +This function is not thread safe. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ext_set_data.3 b/doc/manpages/gnutls_ext_set_data.3 new file mode 100644 index 0000000..69e0bf8 --- /dev/null +++ b/doc/manpages/gnutls_ext_set_data.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ext_set_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ext_set_data \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_ext_set_data(gnutls_session_t " session ", unsigned " tls_id ", gnutls_ext_priv_data_t " data ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +a \fBgnutls_session_t\fP opaque pointer +.IP "unsigned tls_id" 12 +the numeric id of the extension +.IP "gnutls_ext_priv_data_t data" 12 +the private data to set +.SH "DESCRIPTION" +This function allows an extension handler to store data in the current session +and retrieve them later on. The set data will be deallocated using +the gnutls_ext_deinit_data_func. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_fingerprint.3 b/doc/manpages/gnutls_fingerprint.3 new file mode 100644 index 0000000..2fff775 --- /dev/null +++ b/doc/manpages/gnutls_fingerprint.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fingerprint" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_fingerprint \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_fingerprint(gnutls_digest_algorithm_t " algo ", const gnutls_datum_t * " data ", void * " result ", size_t * " result_size ");" +.SH ARGUMENTS +.IP "gnutls_digest_algorithm_t algo" 12 +is a digest algorithm +.IP "const gnutls_datum_t * data" 12 +is the data +.IP "void * result" 12 +is the place where the result will be copied (may be null). +.IP "size_t * result_size" 12 +should hold the size of the result. The actual size +of the returned result will also be copied there. +.SH "DESCRIPTION" +This function will calculate a fingerprint (actually a hash), of +the given data. The result is not printable data. You should +convert it to hex, or to something else printable. + +This is the usual way to calculate a fingerprint of an X.509 DER +encoded certificate. Note however that the fingerprint of an +OpenPGP certificate is not just a hash and cannot be calculated with this +function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_fips140_context_deinit.3 b/doc/manpages/gnutls_fips140_context_deinit.3 new file mode 100644 index 0000000..7bd14fc --- /dev/null +++ b/doc/manpages/gnutls_fips140_context_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fips140_context_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_fips140_context_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_fips140_context_deinit(gnutls_fips140_context_t " context ");" +.SH ARGUMENTS +.IP "gnutls_fips140_context_t context" 12 +a \fBgnutls_fips140_context_t\fP +.SH "DESCRIPTION" +Uninitialize and release the FIPS context \fIcontext\fP . +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_fips140_context_init.3 b/doc/manpages/gnutls_fips140_context_init.3 new file mode 100644 index 0000000..7b77f54 --- /dev/null +++ b/doc/manpages/gnutls_fips140_context_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fips140_context_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_fips140_context_init \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_fips140_context_init(gnutls_fips140_context_t * " context ");" +.SH ARGUMENTS +.IP "gnutls_fips140_context_t * context" 12 +location to store \fIgnutls_fips140_context_t\fP +.SH "DESCRIPTION" +Create and initialize the FIPS context object. +.SH "RETURNS" +0 upon success, a negative error code otherwise +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_fips140_get_operation_state.3 b/doc/manpages/gnutls_fips140_get_operation_state.3 new file mode 100644 index 0000000..82e1568 --- /dev/null +++ b/doc/manpages/gnutls_fips140_get_operation_state.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fips140_get_operation_state" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_fips140_get_operation_state \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_fips140_operation_state_t gnutls_fips140_get_operation_state(gnutls_fips140_context_t " context ");" +.SH ARGUMENTS +.IP "gnutls_fips140_context_t context" 12 +a \fBgnutls_fips140_context_t\fP +.SH "DESCRIPTION" +Get the previous operation state of \fIcontext\fP in terms of FIPS. +.SH "RETURNS" +a \fBgnutls_fips140_operation_state_t\fP +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_fips140_mode_enabled.3 b/doc/manpages/gnutls_fips140_mode_enabled.3 new file mode 100644 index 0000000..d049842 --- /dev/null +++ b/doc/manpages/gnutls_fips140_mode_enabled.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fips140_mode_enabled" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_fips140_mode_enabled \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_fips140_mode_enabled( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Checks whether this library is in FIPS140 mode. The returned +value corresponds to the library mode as set with +\fBgnutls_fips140_set_mode()\fP. + +If \fBgnutls_fips140_set_mode()\fP was called with \fBGNUTLS_FIPS140_SET_MODE_THREAD\fP +then this function will return the current thread's FIPS140 mode, otherwise +the global value is returned. +.SH "RETURNS" +return non\-zero if true or zero if false. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_fips140_pop_context.3 b/doc/manpages/gnutls_fips140_pop_context.3 new file mode 100644 index 0000000..a6d462a --- /dev/null +++ b/doc/manpages/gnutls_fips140_pop_context.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fips140_pop_context" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_fips140_pop_context \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_fips140_pop_context( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Dissociate the FIPS context currently +active on the current thread, reverting to the previously active +context. If a cryptographic operation is ongoing in the current +thread, e.g., \fBgnutls_aead_cipher_init()\fP is called but +\fBgnutls_aead_cipher_deinit()\fP is not yet called, it returns an error +\fBGNUTLS_E_INVALID_REQUEST\fP. + +This function is no\-op if FIPS140 is not compiled in nor enabled +at run\-time. +.SH "RETURNS" +0 upon success, a negative error code otherwise +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_fips140_push_context.3 b/doc/manpages/gnutls_fips140_push_context.3 new file mode 100644 index 0000000..59ba529 --- /dev/null +++ b/doc/manpages/gnutls_fips140_push_context.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fips140_push_context" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_fips140_push_context \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_fips140_push_context(gnutls_fips140_context_t " context ");" +.SH ARGUMENTS +.IP "gnutls_fips140_context_t context" 12 +a \fBgnutls_fips140_context_t\fP +.SH "DESCRIPTION" +Associate the FIPS \fIcontext\fP to the current thread, diverting the +currently active context. If a cryptographic operation is ongoing +in the current thread, e.g., \fBgnutls_aead_cipher_init()\fP is called +but \fBgnutls_aead_cipher_deinit()\fP is not yet called, it returns an +error \fBGNUTLS_E_INVALID_REQUEST\fP. + +The operation state of \fIcontext\fP will be reset to +\fBGNUTLS_FIPS140_OP_INITIAL\fP. + +This function is no\-op if FIPS140 is not compiled in nor enabled +at run\-time. +.SH "RETURNS" +0 upon success, a negative error code otherwise +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_fips140_run_self_tests.3 b/doc/manpages/gnutls_fips140_run_self_tests.3 new file mode 100644 index 0000000..8c2425f --- /dev/null +++ b/doc/manpages/gnutls_fips140_run_self_tests.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fips140_run_self_tests" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_fips140_run_self_tests \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_fips140_run_self_tests( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Manually perform the second round of the FIPS140 self\-tests, +including: + +\- Known answer tests (KAT) for the selected set of symmetric +cipher, MAC, public key, KDF, and DRBG +\- Library integrity checks + +Upon failure with FIPS140 mode enabled, it makes the library +unusable. This function is not thread\-safe. +.SH "RETURNS" +0 upon success, a negative error code otherwise +.SH "SINCE" +3.7.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_fips140_set_mode.3 b/doc/manpages/gnutls_fips140_set_mode.3 new file mode 100644 index 0000000..1c1c0fe --- /dev/null +++ b/doc/manpages/gnutls_fips140_set_mode.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fips140_set_mode" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_fips140_set_mode \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_fips140_set_mode(gnutls_fips_mode_t " mode ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_fips_mode_t mode" 12 +the FIPS140\-2 mode to switch to +.IP "unsigned flags" 12 +should be zero or \fBGNUTLS_FIPS140_SET_MODE_THREAD\fP +.SH "DESCRIPTION" +That function is not thread\-safe when changing the mode with no flags +(globally), and should be called prior to creating any threads. Its +behavior with no flags after threads are created is undefined. + +When the flag \fBGNUTLS_FIPS140_SET_MODE_THREAD\fP is specified +then this call will change the FIPS140\-2 mode for this particular +thread and not for the whole process. That way an application +can utilize this function to set and reset mode for specific +operations. + +This function never fails but will be a no\-op if used when +the library is not in FIPS140\-2 mode. When asked to switch to unknown +values for \fImode\fP or to \fBGNUTLS_FIPS140_SELFTESTS\fP mode, the library +switches to \fBGNUTLS_FIPS140_STRICT\fP mode. +.SH "SINCE" +3.6.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_get_library_config.3 b/doc/manpages/gnutls_get_library_config.3 new file mode 100644 index 0000000..1d3447f --- /dev/null +++ b/doc/manpages/gnutls_get_library_config.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_get_library_config" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_get_library_config \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_library_config_st * gnutls_get_library_config( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Returns the library configuration as key value pairs. +Currently defined keys are: + +\- fips\-module\-name: the name of the FIPS140 module + +\- fips\-module\-version: the version of the FIPS140 module + +\- libgnutls\-soname: the SONAME of the library itself + +\- libnettle\-soname: the library SONAME of linked libnettle + +\- libhogweed\-soname: the library SONAME of linked libhogweed + +\- libgmp\-soname: the library SONAME of linked libgmp + +\- hardware\-features: enabled hardware support features + +\- tls\-features: enabled TLS protocol features +.SH "RETURNS" +a NUL\-terminated \fBgnutls_library_config_st\fP array +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_get_system_config_file.3 b/doc/manpages/gnutls_get_system_config_file.3 new file mode 100644 index 0000000..5df612e --- /dev/null +++ b/doc/manpages/gnutls_get_system_config_file.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_get_system_config_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_get_system_config_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_get_system_config_file( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Returns the filename of the system wide configuration +file to be loaded by the library. +.SH "RETURNS" +a constant pointer to the config file path +.SH "SINCE" +3.6.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_global_deinit.3 b/doc/manpages/gnutls_global_deinit.3 new file mode 100644 index 0000000..b93902a --- /dev/null +++ b/doc/manpages/gnutls_global_deinit.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_global_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_global_deinit( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +This function deinitializes the global data, that were initialized +using \fBgnutls_global_init()\fP. + +Since GnuTLS 3.3.0 this function is no longer necessary to be explicitly +called. GnuTLS will automatically deinitialize on library destructor. See +\fBgnutls_global_init()\fP for disabling the implicit initialization/deinitialization. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_global_init.3 b/doc/manpages/gnutls_global_init.3 new file mode 100644 index 0000000..9e6fc83 --- /dev/null +++ b/doc/manpages/gnutls_global_init.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_global_init \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_global_init( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Since GnuTLS 3.3.0 this function is no longer necessary to be explicitly +called. To disable the implicit call (in a library constructor) of this +function set the environment variable \fBGNUTLS_NO_IMPLICIT_INIT\fP to 1. + +This function performs any required precalculations, detects +the supported CPU capabilities and initializes the underlying +cryptographic backend. In order to free any resources +taken by this call you should \fBgnutls_global_deinit()\fP +when gnutls usage is no longer needed. + +This function increments a global counter, so that +\fBgnutls_global_deinit()\fP only releases resources when it has been +called as many times as \fBgnutls_global_init()\fP. This is useful when +GnuTLS is used by more than one library in an application. This +function can be called many times, but will only do something the +first time. It is thread safe since GnuTLS 3.3.0. + +A subsequent call of this function if the initial has failed will +return the same error code. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_global_set_audit_log_function.3 b/doc/manpages/gnutls_global_set_audit_log_function.3 new file mode 100644 index 0000000..6ea91f9 --- /dev/null +++ b/doc/manpages/gnutls_global_set_audit_log_function.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_audit_log_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_audit_log_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_global_set_audit_log_function(gnutls_audit_log_func " log_func ");" +.SH ARGUMENTS +.IP "gnutls_audit_log_func log_func" 12 +it is the audit log function +.SH "DESCRIPTION" +This is the function to set the audit logging function. This +is a function to report important issues, such as possible +attacks in the protocol. This is different from \fBgnutls_global_set_log_function()\fP +because it will report also session\-specific events. The session +parameter will be null if there is no corresponding TLS session. + + \fIgnutls_audit_log_func\fP is of the form, +void (*gnutls_audit_log_func)( gnutls_session_t, const char*); +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_global_set_log_function.3 b/doc/manpages/gnutls_global_set_log_function.3 new file mode 100644 index 0000000..16628e4 --- /dev/null +++ b/doc/manpages/gnutls_global_set_log_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_log_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_log_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_global_set_log_function(gnutls_log_func " log_func ");" +.SH ARGUMENTS +.IP "gnutls_log_func log_func" 12 +it's a log function +.SH "DESCRIPTION" +This is the function where you set the logging function gnutls is +going to use. This function only accepts a character array. +Normally you may not use this function since it is only used for +debugging purposes. + + \fIgnutls_log_func\fP is of the form, +void (*gnutls_log_func)( int level, const char*); +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_global_set_log_level.3 b/doc/manpages/gnutls_global_set_log_level.3 new file mode 100644 index 0000000..17d7144 --- /dev/null +++ b/doc/manpages/gnutls_global_set_log_level.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_log_level" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_log_level \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_global_set_log_level(int " level ");" +.SH ARGUMENTS +.IP "int level" 12 +it's an integer from 0 to 99. +.SH "DESCRIPTION" +This is the function that allows you to set the log level. The +level is an integer between 0 and 9. Higher values mean more +verbosity. The default value is 0. Larger values should only be +used with care, since they may reveal sensitive information. + +Use a log level over 10 to enable all debugging options. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_global_set_mem_functions.3 b/doc/manpages/gnutls_global_set_mem_functions.3 new file mode 100644 index 0000000..9933d71 --- /dev/null +++ b/doc/manpages/gnutls_global_set_mem_functions.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_mem_functions" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_mem_functions \- API function +.SH SYNOPSIS +.B #include <gnutls/compat.h> +.sp +.BI "void gnutls_global_set_mem_functions(gnutls_alloc_function " alloc_func ", gnutls_alloc_function " secure_alloc_func ", gnutls_is_secure_function " is_secure_func ", gnutls_realloc_function " realloc_func ", gnutls_free_function " free_func ");" +.SH ARGUMENTS +.IP "gnutls_alloc_function alloc_func" 12 +it's the default memory allocation function. Like \fBmalloc()\fP. +.IP "gnutls_alloc_function secure_alloc_func" 12 +This is the memory allocation function that will be used for sensitive data. +.IP "gnutls_is_secure_function is_secure_func" 12 +a function that returns 0 if the memory given is not secure. May be NULL. +.IP "gnutls_realloc_function realloc_func" 12 +A realloc function +.IP "gnutls_free_function free_func" 12 +The function that frees allocated data. Must accept a NULL pointer. +.SH "DEPRECATED" +since 3.3.0 it is no longer possible to replace the internally used +memory allocation functions + +This is the function where you set the memory allocation functions +gnutls is going to use. By default the libc's allocation functions +(\fBmalloc()\fP, \fBfree()\fP), are used by gnutls, to allocate both sensitive +and not sensitive data. This function is provided to set the +memory allocation functions to something other than the defaults + +This function must be called before \fBgnutls_global_init()\fP is called. +This function is not thread safe. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_global_set_mutex.3 b/doc/manpages/gnutls_global_set_mutex.3 new file mode 100644 index 0000000..5e02f3f --- /dev/null +++ b/doc/manpages/gnutls_global_set_mutex.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_mutex" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_mutex \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_global_set_mutex(mutex_init_func " init ", mutex_deinit_func " deinit ", mutex_lock_func " lock ", mutex_unlock_func " unlock ");" +.SH ARGUMENTS +.IP "mutex_init_func init" 12 +mutex initialization function +.IP "mutex_deinit_func deinit" 12 +mutex deinitialization function +.IP "mutex_lock_func lock" 12 +mutex locking function +.IP "mutex_unlock_func unlock" 12 +mutex unlocking function +.SH "DESCRIPTION" +With this function you are allowed to override the default mutex +locks used in some parts of gnutls and dependent libraries. This function +should be used if you have complete control of your program and libraries. +Do not call this function from a library, or preferably from any application +unless really needed to. GnuTLS will use the appropriate locks for the running +system. + +This function must be called prior to any other GnuTLS function; otherwise +the behavior is undefined. +.SH "DEPRECATED" +This function is discouraged on GnuTLS 3.7.3 or later. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_global_set_time_function.3 b/doc/manpages/gnutls_global_set_time_function.3 new file mode 100644 index 0000000..ab6dc67 --- /dev/null +++ b/doc/manpages/gnutls_global_set_time_function.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_time_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_time_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_global_set_time_function(gnutls_time_func " time_func ");" +.SH ARGUMENTS +.IP "gnutls_time_func time_func" 12 +it's the system time function, a \fBgnutls_time_func()\fP callback. +.SH "DESCRIPTION" +This is the function where you can override the default system time +function. The application provided function should behave the same +as the standard function. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_gost_paramset_get_name.3 b/doc/manpages/gnutls_gost_paramset_get_name.3 new file mode 100644 index 0000000..9c6656e --- /dev/null +++ b/doc/manpages/gnutls_gost_paramset_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_gost_paramset_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_gost_paramset_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_gost_paramset_get_name(gnutls_gost_paramset_t " param ");" +.SH ARGUMENTS +.IP "gnutls_gost_paramset_t param" 12 +is a GOST 28147 param set +.SH "DESCRIPTION" +Convert a \fBgnutls_gost_paramset_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified GOST param set, +or \fBNULL\fP. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_gost_paramset_get_oid.3 b/doc/manpages/gnutls_gost_paramset_get_oid.3 new file mode 100644 index 0000000..4fa9778 --- /dev/null +++ b/doc/manpages/gnutls_gost_paramset_get_oid.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_gost_paramset_get_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_gost_paramset_get_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_gost_paramset_get_oid(gnutls_gost_paramset_t " param ");" +.SH ARGUMENTS +.IP "gnutls_gost_paramset_t param" 12 +is a GOST 28147 param set +.SH "DESCRIPTION" +Convert a \fBgnutls_gost_paramset_t\fP value to its object identifier. +.SH "RETURNS" +a string that contains the object identifier of the specified GOST +param set, or \fBNULL\fP. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_group_get.3 b/doc/manpages/gnutls_group_get.3 new file mode 100644 index 0000000..6a0ccc5 --- /dev/null +++ b/doc/manpages/gnutls_group_get.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_group_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_group_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_group_t gnutls_group_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Returns the currently used group for key exchange. Only valid +when using an elliptic curve or DH ciphersuite. +.SH "RETURNS" +the currently used group, a \fBgnutls_group_t\fP +type. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_group_get_id.3 b/doc/manpages/gnutls_group_get_id.3 new file mode 100644 index 0000000..42c4969 --- /dev/null +++ b/doc/manpages/gnutls_group_get_id.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_group_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_group_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_group_t gnutls_group_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a group name +.SH "DESCRIPTION" +The names are compared in a case insensitive way. +.SH "RETURNS" +return a \fBgnutls_group_t\fP value corresponding to +the specified group, or \fBGNUTLS_GROUP_INVALID\fP on error. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_group_get_name.3 b/doc/manpages/gnutls_group_get_name.3 new file mode 100644 index 0000000..3446f50 --- /dev/null +++ b/doc/manpages/gnutls_group_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_group_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_group_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_group_get_name(gnutls_group_t " group ");" +.SH ARGUMENTS +.IP "gnutls_group_t group" 12 +is an element from \fBgnutls_group_t\fP +.SH "DESCRIPTION" +Convert a \fBgnutls_group_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified +group or \fBNULL\fP. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_group_list.3 b/doc/manpages/gnutls_group_list.3 new file mode 100644 index 0000000..39f2a88 --- /dev/null +++ b/doc/manpages/gnutls_group_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_group_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_group_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_group_t * gnutls_group_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get the list of supported elliptic curves. + +This function is not thread safe. +.SH "RETURNS" +Return a (0)\-terminated list of \fBgnutls_group_t\fP +integers indicating the available groups. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake.3 b/doc/manpages/gnutls_handshake.3 new file mode 100644 index 0000000..edc5e7a --- /dev/null +++ b/doc/manpages/gnutls_handshake.3 @@ -0,0 +1,64 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_handshake(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function performs the handshake of the TLS/SSL protocol, and +initializes the TLS session parameters. + +The non\-fatal errors expected by this function are: +\fBGNUTLS_E_INTERRUPTED\fP, \fBGNUTLS_E_AGAIN\fP, +\fBGNUTLS_E_WARNING_ALERT_RECEIVED\fP. When this function is called +for re\-handshake under TLS 1.2 or earlier, the non\-fatal error code +\fBGNUTLS_E_GOT_APPLICATION_DATA\fP may also be returned. + +The former two interrupt the handshake procedure due to the transport +layer being interrupted, and the latter because of a "warning" alert that +was sent by the peer (it is always a good idea to check any +received alerts). On these non\-fatal errors call this function again, +until it returns 0; cf. \fBgnutls_record_get_direction()\fP and +\fBgnutls_error_is_fatal()\fP. In DTLS sessions the non\-fatal error +\fBGNUTLS_E_LARGE_PACKET\fP is also possible, and indicates that +the MTU should be adjusted. + +When this function is called by a server after a rehandshake request +under TLS 1.2 or earlier the \fBGNUTLS_E_GOT_APPLICATION_DATA\fP error code indicates +that some data were pending prior to peer initiating the handshake. +Under TLS 1.3 this function when called after a successful handshake, is a no\-op +and always succeeds in server side; in client side this function is +equivalent to \fBgnutls_session_key_update()\fP with \fBGNUTLS_KU_PEER\fP flag. + +This function handles both full and abbreviated TLS handshakes (resumption). +For abbreviated handshakes, in client side, the \fBgnutls_session_set_data()\fP +should be called prior to this function to set parameters from a previous session. +In server side, resumption is handled by either setting a DB back\-end, or setting +up keys for session tickets. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on a successful handshake, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_description_get_name.3 b/doc/manpages/gnutls_handshake_description_get_name.3 new file mode 100644 index 0000000..5daf281 --- /dev/null +++ b/doc/manpages/gnutls_handshake_description_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_description_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_description_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_handshake_description_get_name(gnutls_handshake_description_t " type ");" +.SH ARGUMENTS +.IP "gnutls_handshake_description_t type" 12 +is a handshake message description +.SH "DESCRIPTION" +Convert a \fBgnutls_handshake_description_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified handshake +message or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_get_last_in.3 b/doc/manpages/gnutls_handshake_get_last_in.3 new file mode 100644 index 0000000..354293c --- /dev/null +++ b/doc/manpages/gnutls_handshake_get_last_in.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_get_last_in" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_get_last_in \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_handshake_description_t gnutls_handshake_get_last_in(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function is only useful to check where the last performed +handshake failed. If the previous handshake succeed or was not +performed at all then no meaningful value will be returned. + +Check \fBgnutls_handshake_description_t\fP in gnutls.h for the +available handshake descriptions. +.SH "RETURNS" +the last handshake message type received, a +\fBgnutls_handshake_description_t\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_get_last_out.3 b/doc/manpages/gnutls_handshake_get_last_out.3 new file mode 100644 index 0000000..e0cfffb --- /dev/null +++ b/doc/manpages/gnutls_handshake_get_last_out.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_get_last_out" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_get_last_out \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_handshake_description_t gnutls_handshake_get_last_out(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function is only useful to check where the last performed +handshake failed. If the previous handshake succeed or was not +performed at all then no meaningful value will be returned. + +Check \fBgnutls_handshake_description_t\fP in gnutls.h for the +available handshake descriptions. +.SH "RETURNS" +the last handshake message type sent, a +\fBgnutls_handshake_description_t\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_set_hook_function.3 b/doc/manpages/gnutls_handshake_set_hook_function.3 new file mode 100644 index 0000000..de892f7 --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_hook_function.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_hook_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_hook_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_handshake_set_hook_function(gnutls_session_t " session ", unsigned int " htype ", int " when ", gnutls_handshake_hook_func " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type +.IP "unsigned int htype" 12 +the \fBgnutls_handshake_description_t\fP of the message to hook at +.IP "int when" 12 +\fBGNUTLS_HOOK_\fP* depending on when the hook function should be called +.IP "gnutls_handshake_hook_func func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback to be called after or before the specified +handshake message has been received or generated. This is a +generalization of \fBgnutls_handshake_set_post_client_hello_function()\fP. + +To call the hook function prior to the message being generated or processed +use \fBGNUTLS_HOOK_PRE\fP as \fIwhen\fP parameter, \fBGNUTLS_HOOK_POST\fP to call +after, and \fBGNUTLS_HOOK_BOTH\fP for both cases. + +This callback must return 0 on success or a gnutls error code to +terminate the handshake. + +To hook at all handshake messages use an \fIhtype\fP of \fBGNUTLS_HANDSHAKE_ANY\fP. +.SH "WARNING" +You should not use this function to terminate the +handshake based on client input unless you know what you are +doing. Before the handshake is finished there is no way to know if +there is a man\-in\-the\-middle attack being performed. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_set_max_packet_length.3 b/doc/manpages/gnutls_handshake_set_max_packet_length.3 new file mode 100644 index 0000000..008c652 --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_max_packet_length.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_max_packet_length" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_max_packet_length \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_handshake_set_max_packet_length(gnutls_session_t " session ", size_t " max ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t max" 12 +is the maximum number. +.SH "DESCRIPTION" +This function will set the maximum size of all handshake messages. +Handshakes over this size are rejected with +\fBGNUTLS_E_HANDSHAKE_TOO_LARGE\fP error code. The default value is +128kb which is typically large enough. Set this to 0 if you do not +want to set an upper limit. + +The reason for restricting the handshake message sizes are to +limit Denial of Service attacks. + +Note that the maximum handshake size was increased to 128kb +from 48kb in GnuTLS 3.5.5. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_set_post_client_hello_function.3 b/doc/manpages/gnutls_handshake_set_post_client_hello_function.3 new file mode 100644 index 0000000..f112080 --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_post_client_hello_function.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_post_client_hello_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_post_client_hello_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_handshake_set_post_client_hello_function(gnutls_session_t " session ", gnutls_handshake_simple_hook_func " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_handshake_simple_hook_func func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback to be called after the client +hello has been received (callback valid in server side only). This +allows the server to adjust settings based on received extensions. + +Those settings could be ciphersuites, requesting certificate, or +anything else except for version negotiation (this is done before +the hello message is parsed). + +This callback must return 0 on success or a gnutls error code to +terminate the handshake. + +Since GnuTLS 3.3.5 the callback is +allowed to return \fBGNUTLS_E_AGAIN\fP or \fBGNUTLS_E_INTERRUPTED\fP to +put the handshake on hold. In that case \fBgnutls_handshake()\fP +will return \fBGNUTLS_E_INTERRUPTED\fP and can be resumed when needed. +.SH "WARNING" +You should not use this function to terminate the +handshake based on client input unless you know what you are +doing. Before the handshake is finished there is no way to know if +there is a man\-in\-the\-middle attack being performed. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_set_private_extensions.3 b/doc/manpages/gnutls_handshake_set_private_extensions.3 new file mode 100644 index 0000000..19ff623 --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_private_extensions.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_private_extensions" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_private_extensions \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_handshake_set_private_extensions(gnutls_session_t " session ", int " allow ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "int allow" 12 +is an integer (0 or 1) +.SH "DESCRIPTION" +This function will enable or disable the use of private cipher +suites (the ones that start with 0xFF). By default or if \fIallow\fP is 0 then these cipher suites will not be advertised nor used. + +Currently GnuTLS does not include such cipher\-suites or +compression algorithms. + +Enabling the private ciphersuites when talking to other than +gnutls servers and clients may cause interoperability problems. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_set_random.3 b/doc/manpages/gnutls_handshake_set_random.3 new file mode 100644 index 0000000..1b58487 --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_random.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_random" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_random \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_handshake_set_random(gnutls_session_t " session ", const gnutls_datum_t * " random ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const gnutls_datum_t * random" 12 +a random value of 32\-bytes +.SH "DESCRIPTION" +This function will explicitly set the server or client hello +random value in the subsequent TLS handshake. The random value +should be a 32\-byte value. + +Note that this function should not normally be used as gnutls +will select automatically a random value for the handshake. + +This function should not be used when resuming a session. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. + +Since 3.1.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_set_read_function.3 b/doc/manpages/gnutls_handshake_set_read_function.3 new file mode 100644 index 0000000..1ce5f8e --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_read_function.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_read_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_read_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_handshake_set_read_function(gnutls_session_t " session ", gnutls_handshake_read_func " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is \fBgnutls_session_t\fP type +.IP "gnutls_handshake_read_func func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback to be called when a handshake +message is being sent. +.SH "SINCE" +3.7.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_set_secret_function.3 b/doc/manpages/gnutls_handshake_set_secret_function.3 new file mode 100644 index 0000000..878259e --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_secret_function.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_secret_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_secret_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_handshake_set_secret_function(gnutls_session_t " session ", gnutls_handshake_secret_func " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_handshake_secret_func func" 12 +the secret func +.SH "DESCRIPTION" +This function will set a callback to be called when a new traffic +secret is installed. +.SH "SINCE" +3.7.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_set_timeout.3 b/doc/manpages/gnutls_handshake_set_timeout.3 new file mode 100644 index 0000000..720ff07 --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_timeout.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_timeout" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_timeout \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_handshake_set_timeout(gnutls_session_t " session ", unsigned int " ms ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int ms" 12 +is a timeout value in milliseconds +.SH "DESCRIPTION" +This function sets the timeout for the TLS handshake process +to the provided value. Use an \fIms\fP value of zero to disable +timeout, or \fBGNUTLS_DEFAULT_HANDSHAKE_TIMEOUT\fP for a reasonable +default value. For the DTLS protocol, the more detailed +\fBgnutls_dtls_set_timeouts()\fP is provided. + +This function requires to set a pull timeout callback. See +\fBgnutls_transport_set_pull_timeout_function()\fP. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_handshake_write.3 b/doc/manpages/gnutls_handshake_write.3 new file mode 100644 index 0000000..40aa3f2 --- /dev/null +++ b/doc/manpages/gnutls_handshake_write.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_write" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_write \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_handshake_write(gnutls_session_t " session ", gnutls_record_encryption_level_t " level ", const void * " data ", size_t " data_size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_record_encryption_level_t level" 12 +the current encryption level for reading a handshake message +.IP "const void * data" 12 +the (const) handshake data to be processed +.IP "size_t data_size" 12 +the size of data +.SH "DESCRIPTION" +This function processes a handshake message in the encryption level +specified with \fIlevel\fP . Prior to calling this function, a handshake +read callback must be set on \fIsession\fP . Use +\fBgnutls_handshake_set_read_function()\fP to do this. +.SH "SINCE" +3.7.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hash.3 b/doc/manpages/gnutls_hash.3 new file mode 100644 index 0000000..9213e7d --- /dev/null +++ b/doc/manpages/gnutls_hash.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hash \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_hash(gnutls_hash_hd_t " handle ", const void * " ptext ", size_t " ptext_len ");" +.SH ARGUMENTS +.IP "gnutls_hash_hd_t handle" 12 +is a \fBgnutls_hash_hd_t\fP type +.IP "const void * ptext" 12 +the data to hash +.IP "size_t ptext_len" 12 +the length of data to hash +.SH "DESCRIPTION" +This function will hash the given data using the algorithm +specified by the context. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hash_copy.3 b/doc/manpages/gnutls_hash_copy.3 new file mode 100644 index 0000000..6dfac47 --- /dev/null +++ b/doc/manpages/gnutls_hash_copy.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_copy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hash_copy \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "gnutls_hash_hd_t gnutls_hash_copy(gnutls_hash_hd_t " handle ");" +.SH ARGUMENTS +.IP "gnutls_hash_hd_t handle" 12 +is a \fBgnutls_hash_hd_t\fP type +.SH "DESCRIPTION" +This function will create a copy of Message Digest context, containing all +its current state. Copying contexts for Message Digests registered using +\fBgnutls_crypto_register_digest()\fP is not supported and will always result in +an error. In addition to that, some of the Message Digest implementations do +not support this operation. Applications should check the return value and +provide a proper fallback. +.SH "RETURNS" +new Message Digest context or NULL in case of an error. +.SH "SINCE" +3.6.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hash_deinit.3 b/doc/manpages/gnutls_hash_deinit.3 new file mode 100644 index 0000000..451c26b --- /dev/null +++ b/doc/manpages/gnutls_hash_deinit.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hash_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "void gnutls_hash_deinit(gnutls_hash_hd_t " handle ", void * " digest ");" +.SH ARGUMENTS +.IP "gnutls_hash_hd_t handle" 12 +is a \fBgnutls_hash_hd_t\fP type +.IP "void * digest" 12 +is the output value of the hash +.SH "DESCRIPTION" +This function will deinitialize all resources occupied by +the given hash context. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hash_fast.3 b/doc/manpages/gnutls_hash_fast.3 new file mode 100644 index 0000000..6045a96 --- /dev/null +++ b/doc/manpages/gnutls_hash_fast.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_fast" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hash_fast \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_hash_fast(gnutls_digest_algorithm_t " algorithm ", const void * " ptext ", size_t " ptext_len ", void * " digest ");" +.SH ARGUMENTS +.IP "gnutls_digest_algorithm_t algorithm" 12 +the hash algorithm to use +.IP "const void * ptext" 12 +the data to hash +.IP "size_t ptext_len" 12 +the length of data to hash +.IP "void * digest" 12 +is the output value of the hash +.SH "DESCRIPTION" +This convenience function will hash the given data and return output +on a single call. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hash_get_len.3 b/doc/manpages/gnutls_hash_get_len.3 new file mode 100644 index 0000000..1c27693 --- /dev/null +++ b/doc/manpages/gnutls_hash_get_len.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_get_len" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hash_get_len \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "unsigned gnutls_hash_get_len(gnutls_digest_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_digest_algorithm_t algorithm" 12 +the hash algorithm to use +.SH "DESCRIPTION" +This function will return the length of the output data +of the given hash algorithm. +.SH "RETURNS" +The length or zero on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hash_init.3 b/doc/manpages/gnutls_hash_init.3 new file mode 100644 index 0000000..67fbee9 --- /dev/null +++ b/doc/manpages/gnutls_hash_init.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hash_init \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_hash_init(gnutls_hash_hd_t * " dig ", gnutls_digest_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_hash_hd_t * dig" 12 +is a \fBgnutls_hash_hd_t\fP type +.IP "gnutls_digest_algorithm_t algorithm" 12 +the hash algorithm to use +.SH "DESCRIPTION" +This function will initialize an context that can be used to +produce a Message Digest of data. This will effectively use the +current crypto backend in use by gnutls or the cryptographic +accelerator in use. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hash_output.3 b/doc/manpages/gnutls_hash_output.3 new file mode 100644 index 0000000..161a5df --- /dev/null +++ b/doc/manpages/gnutls_hash_output.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_output" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hash_output \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "void gnutls_hash_output(gnutls_hash_hd_t " handle ", void * " digest ");" +.SH ARGUMENTS +.IP "gnutls_hash_hd_t handle" 12 +is a \fBgnutls_hash_hd_t\fP type +.IP "void * digest" 12 +is the output value of the hash +.SH "DESCRIPTION" +This function will output the current hash value +and reset the state of the hash. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_heartbeat_allowed.3 b/doc/manpages/gnutls_heartbeat_allowed.3 new file mode 100644 index 0000000..df52c07 --- /dev/null +++ b/doc/manpages/gnutls_heartbeat_allowed.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_heartbeat_allowed" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_heartbeat_allowed \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_heartbeat_allowed(gnutls_session_t " session ", unsigned int " type ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int type" 12 +one of \fBGNUTLS_HB_LOCAL_ALLOWED_TO_SEND\fP and \fBGNUTLS_HB_PEER_ALLOWED_TO_SEND\fP +.SH "DESCRIPTION" +This function will check whether heartbeats are allowed +to be sent or received in this session. +.SH "RETURNS" +Non zero if heartbeats are allowed. +.SH "SINCE" +3.1.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_heartbeat_enable.3 b/doc/manpages/gnutls_heartbeat_enable.3 new file mode 100644 index 0000000..e31e750 --- /dev/null +++ b/doc/manpages/gnutls_heartbeat_enable.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_heartbeat_enable" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_heartbeat_enable \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_heartbeat_enable(gnutls_session_t " session ", unsigned int " type ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int type" 12 +one of the GNUTLS_HB_* flags +.SH "DESCRIPTION" +If this function is called with the \fBGNUTLS_HB_PEER_ALLOWED_TO_SEND\fP + \fItype\fP , GnuTLS will allow heartbeat messages to be received. Moreover it also +request the peer to accept heartbeat messages. This function +must be called prior to TLS handshake. + +If the \fItype\fP used is \fBGNUTLS_HB_LOCAL_ALLOWED_TO_SEND\fP, then the peer +will be asked to accept heartbeat messages but not send ones. + +The function \fBgnutls_heartbeat_allowed()\fP can be used to test Whether +locally generated heartbeat messages can be accepted by the peer. +.SH "SINCE" +3.1.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_heartbeat_get_timeout.3 b/doc/manpages/gnutls_heartbeat_get_timeout.3 new file mode 100644 index 0000000..0998b8c --- /dev/null +++ b/doc/manpages/gnutls_heartbeat_get_timeout.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_heartbeat_get_timeout" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_heartbeat_get_timeout \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned int gnutls_heartbeat_get_timeout(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function will return the milliseconds remaining +for a retransmission of the previously sent ping +message. This function is useful when ping is used in +non\-blocking mode, to estimate when to call \fBgnutls_heartbeat_ping()\fP +if no packets have been received. +.SH "RETURNS" +the remaining time in milliseconds. +.SH "SINCE" +3.1.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_heartbeat_ping.3 b/doc/manpages/gnutls_heartbeat_ping.3 new file mode 100644 index 0000000..027a238 --- /dev/null +++ b/doc/manpages/gnutls_heartbeat_ping.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_heartbeat_ping" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_heartbeat_ping \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_heartbeat_ping(gnutls_session_t " session ", size_t " data_size ", unsigned int " max_tries ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t data_size" 12 +is the length of the ping payload. +.IP "unsigned int max_tries" 12 +if flags is \fBGNUTLS_HEARTBEAT_WAIT\fP then this sets the number of retransmissions. Use zero for indefinite (until timeout). +.IP "unsigned int flags" 12 +if \fBGNUTLS_HEARTBEAT_WAIT\fP then wait for pong or timeout instead of returning immediately. +.SH "DESCRIPTION" +This function sends a ping to the peer. If the \fIflags\fP is set +to \fBGNUTLS_HEARTBEAT_WAIT\fP then it waits for a reply from the peer. + +Note that it is highly recommended to use this function with the +flag \fBGNUTLS_HEARTBEAT_WAIT\fP, or you need to handle retransmissions +and timeouts manually. + +The total TLS data transmitted as part of the ping message are given by +the following formula: MAX(16, \fIdata_size\fP )+\fBgnutls_record_overhead_size()\fP+3. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.1.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_heartbeat_pong.3 b/doc/manpages/gnutls_heartbeat_pong.3 new file mode 100644 index 0000000..5fa1397 --- /dev/null +++ b/doc/manpages/gnutls_heartbeat_pong.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_heartbeat_pong" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_heartbeat_pong \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_heartbeat_pong(gnutls_session_t " session ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function replies to a ping by sending a pong to the peer. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.1.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_heartbeat_set_timeouts.3 b/doc/manpages/gnutls_heartbeat_set_timeouts.3 new file mode 100644 index 0000000..e5980fa --- /dev/null +++ b/doc/manpages/gnutls_heartbeat_set_timeouts.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_heartbeat_set_timeouts" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_heartbeat_set_timeouts \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_heartbeat_set_timeouts(gnutls_session_t " session ", unsigned int " retrans_timeout ", unsigned int " total_timeout ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int retrans_timeout" 12 +The time at which a retransmission will occur in milliseconds +.IP "unsigned int total_timeout" 12 +The time at which the connection will be aborted, in milliseconds. +.SH "DESCRIPTION" +This function will override the timeouts for the DTLS heartbeat +protocol. The retransmission timeout is the time after which a +message from the peer is not received, the previous request will +be retransmitted. The total timeout is the time after which the +handshake will be aborted with \fBGNUTLS_E_TIMEDOUT\fP. +.SH "SINCE" +3.1.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hex2bin.3 b/doc/manpages/gnutls_hex2bin.3 new file mode 100644 index 0000000..c5302b5 --- /dev/null +++ b/doc/manpages/gnutls_hex2bin.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hex2bin" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hex2bin \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_hex2bin(const char * " hex_data ", size_t " hex_size ", void * " bin_data ", size_t * " bin_size ");" +.SH ARGUMENTS +.IP "const char * hex_data" 12 +string with data in hex format +.IP "size_t hex_size" 12 +size of hex data +.IP "void * bin_data" 12 +output array with binary data +.IP "size_t * bin_size" 12 +when calling should hold maximum size of \fIbin_data\fP , +on return will hold actual length of \fIbin_data\fP . +.SH "DESCRIPTION" +Convert a buffer with hex data to binary data. This function +unlike \fBgnutls_hex_decode()\fP can parse hex data with separators +between numbers. That is, it ignores any non\-hex characters. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hex_decode.3 b/doc/manpages/gnutls_hex_decode.3 new file mode 100644 index 0000000..fc7961c --- /dev/null +++ b/doc/manpages/gnutls_hex_decode.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hex_decode" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hex_decode \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_hex_decode(const gnutls_datum_t * " hex_data ", void * " result ", size_t * " result_size ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * hex_data" 12 +contain the encoded data +.IP "void * result" 12 +the place where decoded data will be copied +.IP "size_t * result_size" 12 +holds the size of the result +.SH "DESCRIPTION" +This function will decode the given encoded data, using the hex +encoding used by PSK password files. + +Initially \fIresult_size\fP must hold the maximum size available in + \fIresult\fP , and on return it will contain the number of bytes written. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not +long enough, \fBGNUTLS_E_PARSING_ERROR\fP on invalid hex data, or 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hex_decode2.3 b/doc/manpages/gnutls_hex_decode2.3 new file mode 100644 index 0000000..bb60e13 --- /dev/null +++ b/doc/manpages/gnutls_hex_decode2.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hex_decode2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hex_decode2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_hex_decode2(const gnutls_datum_t * " hex_data ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * hex_data" 12 +contain the encoded data +.IP "gnutls_datum_t * result" 12 +the result in an allocated string +.SH "DESCRIPTION" +This function will decode the given encoded data, using the hex +encoding used by PSK password files. +.SH "RETURNS" +\fBGNUTLS_E_PARSING_ERROR\fP on invalid hex data, or 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hex_encode.3 b/doc/manpages/gnutls_hex_encode.3 new file mode 100644 index 0000000..3330313 --- /dev/null +++ b/doc/manpages/gnutls_hex_encode.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hex_encode" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hex_encode \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_hex_encode(const gnutls_datum_t * " data ", char * " result ", size_t * " result_size ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * data" 12 +contain the raw data +.IP "char * result" 12 +the place where hex data will be copied +.IP "size_t * result_size" 12 +holds the size of the result +.SH "DESCRIPTION" +This function will convert the given data to printable data, using +the hex encoding, as used in the PSK password files. + +Note that the size of the result includes the null terminator. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not +long enough, or 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hex_encode2.3 b/doc/manpages/gnutls_hex_encode2.3 new file mode 100644 index 0000000..fe615c0 --- /dev/null +++ b/doc/manpages/gnutls_hex_encode2.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hex_encode2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hex_encode2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_hex_encode2(const gnutls_datum_t * " data ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * data" 12 +contain the raw data +.IP "gnutls_datum_t * result" 12 +the result in an allocated string +.SH "DESCRIPTION" +This function will convert the given data to printable data, using +the hex encoding, as used in the PSK password files. + +Note that the size of the result does NOT include the null terminator. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hkdf_expand.3 b/doc/manpages/gnutls_hkdf_expand.3 new file mode 100644 index 0000000..d9354bf --- /dev/null +++ b/doc/manpages/gnutls_hkdf_expand.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hkdf_expand" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hkdf_expand \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_hkdf_expand(gnutls_mac_algorithm_t " mac ", const gnutls_datum_t * " key ", const gnutls_datum_t * " info ", void * " output ", size_t " length ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t mac" 12 +the mac algorithm used internally +.IP "const gnutls_datum_t * key" 12 +the pseudorandom key created with HKDF\-Extract +.IP "const gnutls_datum_t * info" 12 +the optional informational data +.IP "void * output" 12 +the output value of the expand operation +.IP "size_t length" 12 +the desired length of the output key +.SH "DESCRIPTION" +This function will derive a variable length keying material from +the pseudorandom key using the HKDF\-Expand function as defined in +RFC 5869. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.6.13 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hkdf_extract.3 b/doc/manpages/gnutls_hkdf_extract.3 new file mode 100644 index 0000000..a561612 --- /dev/null +++ b/doc/manpages/gnutls_hkdf_extract.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hkdf_extract" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hkdf_extract \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_hkdf_extract(gnutls_mac_algorithm_t " mac ", const gnutls_datum_t * " key ", const gnutls_datum_t * " salt ", void * " output ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t mac" 12 +the mac algorithm used internally +.IP "const gnutls_datum_t * key" 12 +the initial keying material +.IP "const gnutls_datum_t * salt" 12 +the optional salt +.IP "void * output" 12 +the output value of the extract operation +.SH "DESCRIPTION" +This function will derive a fixed\-size key using the HKDF\-Extract +function as defined in RFC 5869. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.6.13 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hmac.3 b/doc/manpages/gnutls_hmac.3 new file mode 100644 index 0000000..ed7bfd6 --- /dev/null +++ b/doc/manpages/gnutls_hmac.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hmac \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_hmac(gnutls_hmac_hd_t " handle ", const void * " ptext ", size_t " ptext_len ");" +.SH ARGUMENTS +.IP "gnutls_hmac_hd_t handle" 12 +is a \fBgnutls_hmac_hd_t\fP type +.IP "const void * ptext" 12 +the data to hash +.IP "size_t ptext_len" 12 +the length of data to hash +.SH "DESCRIPTION" +This function will hash the given data using the algorithm +specified by the context. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hmac_copy.3 b/doc/manpages/gnutls_hmac_copy.3 new file mode 100644 index 0000000..3d7d481 --- /dev/null +++ b/doc/manpages/gnutls_hmac_copy.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_copy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_copy \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "gnutls_hmac_hd_t gnutls_hmac_copy(gnutls_hmac_hd_t " handle ");" +.SH ARGUMENTS +.IP "gnutls_hmac_hd_t handle" 12 +is a \fBgnutls_hmac_hd_t\fP type +.SH "DESCRIPTION" +This function will create a copy of MAC context, containing all its current +state. Copying contexts for MACs registered using +\fBgnutls_crypto_register_mac()\fP is not supported and will always result in an +error. In addition to that, some of the MAC implementations do not support +this operation. Applications should check the return value and provide a +proper fallback. +.SH "RETURNS" +new MAC context or NULL in case of an error. +.SH "SINCE" +3.6.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hmac_deinit.3 b/doc/manpages/gnutls_hmac_deinit.3 new file mode 100644 index 0000000..4f45b78 --- /dev/null +++ b/doc/manpages/gnutls_hmac_deinit.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "void gnutls_hmac_deinit(gnutls_hmac_hd_t " handle ", void * " digest ");" +.SH ARGUMENTS +.IP "gnutls_hmac_hd_t handle" 12 +is a \fBgnutls_hmac_hd_t\fP type +.IP "void * digest" 12 +is the output value of the MAC +.SH "DESCRIPTION" +This function will deinitialize all resources occupied by +the given hmac context. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hmac_fast.3 b/doc/manpages/gnutls_hmac_fast.3 new file mode 100644 index 0000000..056e4f7 --- /dev/null +++ b/doc/manpages/gnutls_hmac_fast.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_fast" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_fast \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_hmac_fast(gnutls_mac_algorithm_t " algorithm ", const void * " key ", size_t " keylen ", const void * " ptext ", size_t " ptext_len ", void * " digest ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t algorithm" 12 +the hash algorithm to use +.IP "const void * key" 12 +the key to use +.IP "size_t keylen" 12 +the length of the key +.IP "const void * ptext" 12 +the data to hash +.IP "size_t ptext_len" 12 +the length of data to hash +.IP "void * digest" 12 +is the output value of the hash +.SH "DESCRIPTION" +This convenience function will hash the given data and return output +on a single call. Note, this call will not work for MAC algorithms +that require nonce (like UMAC or GMAC). +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hmac_get_key_size.3 b/doc/manpages/gnutls_hmac_get_key_size.3 new file mode 100644 index 0000000..c115a0d --- /dev/null +++ b/doc/manpages/gnutls_hmac_get_key_size.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_get_key_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_get_key_size \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "unsigned gnutls_hmac_get_key_size(gnutls_mac_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t algorithm" 12 +the mac algorithm to use +.SH "DESCRIPTION" +This function will return the size of the key to be used with this +algorithm. On the algorithms which may accept arbitrary key sizes, +the returned size is the MAC key size used in the TLS protocol. +.SH "RETURNS" +The key size or zero on error. +.SH "SINCE" +3.6.12 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hmac_get_len.3 b/doc/manpages/gnutls_hmac_get_len.3 new file mode 100644 index 0000000..4d18d92 --- /dev/null +++ b/doc/manpages/gnutls_hmac_get_len.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_get_len" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_get_len \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "unsigned gnutls_hmac_get_len(gnutls_mac_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t algorithm" 12 +the hmac algorithm to use +.SH "DESCRIPTION" +This function will return the length of the output data +of the given hmac algorithm. +.SH "RETURNS" +The length or zero on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hmac_init.3 b/doc/manpages/gnutls_hmac_init.3 new file mode 100644 index 0000000..603899d --- /dev/null +++ b/doc/manpages/gnutls_hmac_init.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_init \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_hmac_init(gnutls_hmac_hd_t * " dig ", gnutls_mac_algorithm_t " algorithm ", const void * " key ", size_t " keylen ");" +.SH ARGUMENTS +.IP "gnutls_hmac_hd_t * dig" 12 +is a \fBgnutls_hmac_hd_t\fP type +.IP "gnutls_mac_algorithm_t algorithm" 12 +the HMAC algorithm to use +.IP "const void * key" 12 +the key to be used for encryption +.IP "size_t keylen" 12 +the length of the key +.SH "DESCRIPTION" +This function will initialize an context that can be used to +produce a Message Authentication Code (MAC) of data. This will +effectively use the current crypto backend in use by gnutls or the +cryptographic accelerator in use. + +Note that despite the name of this function, it can be used +for other MAC algorithms than HMAC. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hmac_output.3 b/doc/manpages/gnutls_hmac_output.3 new file mode 100644 index 0000000..1ee2fea --- /dev/null +++ b/doc/manpages/gnutls_hmac_output.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_output" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_output \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "void gnutls_hmac_output(gnutls_hmac_hd_t " handle ", void * " digest ");" +.SH ARGUMENTS +.IP "gnutls_hmac_hd_t handle" 12 +is a \fBgnutls_hmac_hd_t\fP type +.IP "void * digest" 12 +is the output value of the MAC +.SH "DESCRIPTION" +This function will output the current MAC value +and reset the state of the MAC. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_hmac_set_nonce.3 b/doc/manpages/gnutls_hmac_set_nonce.3 new file mode 100644 index 0000000..a848d5d --- /dev/null +++ b/doc/manpages/gnutls_hmac_set_nonce.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_set_nonce" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_set_nonce \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "void gnutls_hmac_set_nonce(gnutls_hmac_hd_t " handle ", const void * " nonce ", size_t " nonce_len ");" +.SH ARGUMENTS +.IP "gnutls_hmac_hd_t handle" 12 +is a \fBgnutls_hmac_hd_t\fP type +.IP "const void * nonce" 12 +the data to set as nonce +.IP "size_t nonce_len" 12 +the length of data +.SH "DESCRIPTION" +This function will set the nonce in the MAC algorithm. +.SH "SINCE" +3.2.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_idna_map.3 b/doc/manpages/gnutls_idna_map.3 new file mode 100644 index 0000000..506d479 --- /dev/null +++ b/doc/manpages/gnutls_idna_map.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_idna_map" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_idna_map \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_idna_map(const char * " input ", unsigned " ilen ", gnutls_datum_t * " out ", unsigned " flags ");" +.SH ARGUMENTS +.IP "const char * input" 12 +contain the UTF\-8 formatted domain name +.IP "unsigned ilen" 12 +the length of the provided string +.IP "gnutls_datum_t * out" 12 +the result in an null\-terminated allocated string +.IP "unsigned flags" 12 +should be zero +.SH "DESCRIPTION" +This function will convert the provided UTF\-8 domain name, to +its IDNA mapping in an allocated variable. Note that depending on the flags the used gnutls +library was compiled with, the output of this function may vary (i.e., +may be IDNA2008, or IDNA2003). + +To force IDNA2008 specify the flag \fBGNUTLS_IDNA_FORCE_2008\fP. In +the case GnuTLS is not compiled with the necessary dependencies, +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP will be returned to indicate that +gnutls is unable to perform the requested conversion. + +Note also, that this function will return an empty string if an +empty string is provided as input. +.SH "RETURNS" +\fBGNUTLS_E_INVALID_UTF8_STRING\fP on invalid UTF\-8 data, or 0 on success. +.SH "SINCE" +3.5.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_idna_reverse_map.3 b/doc/manpages/gnutls_idna_reverse_map.3 new file mode 100644 index 0000000..ef3c5e8 --- /dev/null +++ b/doc/manpages/gnutls_idna_reverse_map.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_idna_reverse_map" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_idna_reverse_map \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_idna_reverse_map(const char * " input ", unsigned " ilen ", gnutls_datum_t * " out ", unsigned " flags ");" +.SH ARGUMENTS +.IP "const char * input" 12 +contain the ACE (IDNA) formatted domain name +.IP "unsigned ilen" 12 +the length of the provided string +.IP "gnutls_datum_t * out" 12 +the result in an null\-terminated allocated UTF\-8 string +.IP "unsigned flags" 12 +should be zero +.SH "DESCRIPTION" +This function will convert an ACE (ASCII\-encoded) domain name to a UTF\-8 domain name. + +If GnuTLS is compiled without IDNA support, then this function +will return \fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. + +Note also, that this function will return an empty string if an +empty string is provided as input. +.SH "RETURNS" +A negative error code on error, or 0 on success. +.SH "SINCE" +3.5.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_init.3 b/doc/manpages/gnutls_init.3 new file mode 100644 index 0000000..702c3af --- /dev/null +++ b/doc/manpages/gnutls_init.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_init \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_init(gnutls_session_t * " session ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t * session" 12 +is a pointer to a \fBgnutls_session_t\fP type. +.IP "unsigned int flags" 12 +indicate if this session is to be used for server or client. +.SH "DESCRIPTION" +This function initializes the provided session. Every +session must be initialized before use, and must be deinitialized +after used by calling \fBgnutls_deinit()\fP. + + \fIflags\fP can be any combination of flags from \fBgnutls_init_flags_t\fP. + +Note that since version 3.1.2 this function enables some common +TLS extensions such as session tickets and OCSP certificate status +request in client side by default. To prevent that use the \fBGNUTLS_NO_EXTENSIONS\fP +flag. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_key_generate.3 b/doc/manpages/gnutls_key_generate.3 new file mode 100644 index 0000000..ad1a042 --- /dev/null +++ b/doc/manpages/gnutls_key_generate.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_key_generate" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_key_generate \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_key_generate(gnutls_datum_t * " key ", unsigned int " key_size ");" +.SH ARGUMENTS +.IP "gnutls_datum_t * key" 12 +is a pointer to a \fBgnutls_datum_t\fP which will contain a newly +created key +.IP "unsigned int key_size" 12 +the number of bytes of the key +.SH "DESCRIPTION" +Generates a random key of \fIkey_size\fP bytes. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_kx_get.3 b/doc/manpages/gnutls_kx_get.3 new file mode 100644 index 0000000..5b777e1 --- /dev/null +++ b/doc/manpages/gnutls_kx_get.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_kx_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_kx_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_kx_algorithm_t gnutls_kx_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the currently used key exchange algorithm. + +This function will return \fBGNUTLS_KX_ECDHE_RSA\fP, or \fBGNUTLS_KX_DHE_RSA\fP +under TLS 1.3, to indicate an elliptic curve DH key exchange or +a finite field one. The precise group used is available +by calling \fBgnutls_group_get()\fP instead. +.SH "RETURNS" +the key exchange algorithm used in the last handshake, a +\fBgnutls_kx_algorithm_t\fP value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_kx_get_id.3 b/doc/manpages/gnutls_kx_get_id.3 new file mode 100644 index 0000000..ba9a2f9 --- /dev/null +++ b/doc/manpages/gnutls_kx_get_id.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_kx_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_kx_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_kx_algorithm_t gnutls_kx_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a KX name +.SH "DESCRIPTION" +Convert a string to a \fBgnutls_kx_algorithm_t\fP value. The names are +compared in a case insensitive way. +.SH "RETURNS" +an id of the specified KX algorithm, or \fBGNUTLS_KX_UNKNOWN\fP +on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_kx_get_name.3 b/doc/manpages/gnutls_kx_get_name.3 new file mode 100644 index 0000000..909e80e --- /dev/null +++ b/doc/manpages/gnutls_kx_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_kx_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_kx_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_kx_get_name(gnutls_kx_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_kx_algorithm_t algorithm" 12 +is a key exchange algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_kx_algorithm_t\fP value to a string. +.SH "RETURNS" +a pointer to a string that contains the name of the +specified key exchange algorithm, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_kx_list.3 b/doc/manpages/gnutls_kx_list.3 new file mode 100644 index 0000000..ff5f466 --- /dev/null +++ b/doc/manpages/gnutls_kx_list.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_kx_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_kx_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_kx_algorithm_t * gnutls_kx_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get a list of supported key exchange algorithms. + +This function is not thread safe. +.SH "RETURNS" +a (0)\-terminated list of \fBgnutls_kx_algorithm_t\fP integers +indicating the available key exchange algorithms. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_load_file.3 b/doc/manpages/gnutls_load_file.3 new file mode 100644 index 0000000..a1c0366 --- /dev/null +++ b/doc/manpages/gnutls_load_file.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_load_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_load_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_load_file(const char * " filename ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "const char * filename" 12 +the name of the file to load +.IP "gnutls_datum_t * data" 12 +Where the file will be stored +.SH "DESCRIPTION" +This function will load a file into a datum. The data are +zero terminated but the terminating null is not included in length. +The returned data are allocated using \fBgnutls_malloc()\fP. + +Note that this function is not designed for reading sensitive materials, +such as private keys, on practical applications. When the reading fails +in the middle, the partially loaded content might remain on memory. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. + +Since 3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_mac_get.3 b/doc/manpages/gnutls_mac_get.3 new file mode 100644 index 0000000..802d9b3 --- /dev/null +++ b/doc/manpages/gnutls_mac_get.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_mac_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_mac_algorithm_t gnutls_mac_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the currently used MAC algorithm. +.SH "RETURNS" +the currently used mac algorithm, a +\fBgnutls_mac_algorithm_t\fP value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_mac_get_id.3 b/doc/manpages/gnutls_mac_get_id.3 new file mode 100644 index 0000000..1bab47e --- /dev/null +++ b/doc/manpages/gnutls_mac_get_id.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_mac_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_mac_algorithm_t gnutls_mac_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a MAC algorithm name +.SH "DESCRIPTION" +Convert a string to a \fBgnutls_mac_algorithm_t\fP value. The names are +compared in a case insensitive way. +.SH "RETURNS" +a \fBgnutls_mac_algorithm_t\fP id of the specified MAC +algorithm string, or \fBGNUTLS_MAC_UNKNOWN\fP on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_mac_get_key_size.3 b/doc/manpages/gnutls_mac_get_key_size.3 new file mode 100644 index 0000000..44a4613 --- /dev/null +++ b/doc/manpages/gnutls_mac_get_key_size.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_get_key_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_mac_get_key_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "size_t gnutls_mac_get_key_size(gnutls_mac_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t algorithm" 12 +is an encryption algorithm +.SH "DESCRIPTION" +Returns the size of the MAC key used in TLS. +.SH "RETURNS" +length (in bytes) of the given MAC key size, or 0 if the +given MAC algorithm is invalid. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_mac_get_name.3 b/doc/manpages/gnutls_mac_get_name.3 new file mode 100644 index 0000000..aa7f5b3 --- /dev/null +++ b/doc/manpages/gnutls_mac_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_mac_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_mac_get_name(gnutls_mac_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t algorithm" 12 +is a MAC algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_mac_algorithm_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified MAC +algorithm, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_mac_get_nonce_size.3 b/doc/manpages/gnutls_mac_get_nonce_size.3 new file mode 100644 index 0000000..8f8cca6 --- /dev/null +++ b/doc/manpages/gnutls_mac_get_nonce_size.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_get_nonce_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_mac_get_nonce_size \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "size_t gnutls_mac_get_nonce_size(gnutls_mac_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t algorithm" 12 +is an encryption algorithm +.SH "DESCRIPTION" +Returns the size of the nonce used by the MAC in TLS. +.SH "RETURNS" +length (in bytes) of the given MAC nonce size, or 0. +.SH "SINCE" +3.2.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_mac_list.3 b/doc/manpages/gnutls_mac_list.3 new file mode 100644 index 0000000..beb0b58 --- /dev/null +++ b/doc/manpages/gnutls_mac_list.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_mac_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_mac_algorithm_t * gnutls_mac_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get a list of hash algorithms for use as MACs. Note that not +necessarily all MACs are supported in TLS cipher suites. +This function is not thread safe. +.SH "RETURNS" +Return a (0)\-terminated list of \fBgnutls_mac_algorithm_t\fP +integers indicating the available MACs. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_memcmp.3 b/doc/manpages/gnutls_memcmp.3 new file mode 100644 index 0000000..bd9ab2e --- /dev/null +++ b/doc/manpages/gnutls_memcmp.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_memcmp" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_memcmp \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_memcmp(const void * " s1 ", const void * " s2 ", size_t " n ");" +.SH ARGUMENTS +.IP "const void * s1" 12 +the first address to compare +.IP "const void * s2" 12 +the second address to compare +.IP "size_t n" 12 +the size of memory to compare +.SH "DESCRIPTION" +This function will operate similarly to \fBmemcmp()\fP, but will operate +on time that depends only on the size of the string. That is will +not return early if the strings don't match on the first byte. +.SH "RETURNS" +non zero on difference and zero if the buffers are identical. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_memset.3 b/doc/manpages/gnutls_memset.3 new file mode 100644 index 0000000..d3efd76 --- /dev/null +++ b/doc/manpages/gnutls_memset.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_memset" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_memset \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_memset(void * " data ", int " c ", size_t " size ");" +.SH ARGUMENTS +.IP "void * data" 12 +the memory to set +.IP "int c" 12 +the constant byte to fill the memory with +.IP "size_t size" 12 +the size of memory +.SH "DESCRIPTION" +This function will operate similarly to \fBmemset()\fP, but will +not be optimized out by the compiler. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_add_cert.3 b/doc/manpages/gnutls_ocsp_req_add_cert.3 new file mode 100644 index 0000000..62c47f3 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_add_cert.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_add_cert" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_add_cert \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_add_cert(gnutls_ocsp_req_t " req ", gnutls_digest_algorithm_t " digest ", gnutls_x509_crt_t " issuer ", gnutls_x509_crt_t " cert ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_t req" 12 +should contain a \fBgnutls_ocsp_req_t\fP type +.IP "gnutls_digest_algorithm_t digest" 12 +hash algorithm, a \fBgnutls_digest_algorithm_t\fP value +.IP "gnutls_x509_crt_t issuer" 12 +issuer of \fIsubject\fP certificate +.IP "gnutls_x509_crt_t cert" 12 +certificate to request status for +.SH "DESCRIPTION" +This function will add another request to the OCSP request for a +particular certificate. The issuer name hash, issuer key hash, and +serial number fields is populated as follows. The issuer name and +the serial number is taken from \fIcert\fP . The issuer key is taken +from \fIissuer\fP . The hashed values will be hashed using the \fIdigest\fP algorithm, normally \fBGNUTLS_DIG_SHA1\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_add_cert_id.3 b/doc/manpages/gnutls_ocsp_req_add_cert_id.3 new file mode 100644 index 0000000..5e0862c --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_add_cert_id.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_add_cert_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_add_cert_id \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_add_cert_id(gnutls_ocsp_req_t " req ", gnutls_digest_algorithm_t " digest ", const gnutls_datum_t * " issuer_name_hash ", const gnutls_datum_t * " issuer_key_hash ", const gnutls_datum_t * " serial_number ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_t req" 12 +should contain a \fBgnutls_ocsp_req_t\fP type +.IP "gnutls_digest_algorithm_t digest" 12 +hash algorithm, a \fBgnutls_digest_algorithm_t\fP value +.IP "const gnutls_datum_t * issuer_name_hash" 12 +hash of issuer's DN +.IP "const gnutls_datum_t * issuer_key_hash" 12 +hash of issuer's public key +.IP "const gnutls_datum_t * serial_number" 12 +serial number of certificate to check +.SH "DESCRIPTION" +This function will add another request to the OCSP request for a +particular certificate having the issuer name hash of + \fIissuer_name_hash\fP and issuer key hash of \fIissuer_key_hash\fP (both +hashed using \fIdigest\fP ) and serial number \fIserial_number\fP . + +The information needed corresponds to the CertID structure: + +<informalexample><programlisting> +CertID ::= SEQUENCE { +hashAlgorithm AlgorithmIdentifier, +issuerNameHash OCTET STRING, \-\- Hash of Issuer's DN +issuerKeyHash OCTET STRING, \-\- Hash of Issuers public key +serialNumber CertificateSerialNumber } +</programlisting></informalexample> +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_deinit.3 b/doc/manpages/gnutls_ocsp_req_deinit.3 new file mode 100644 index 0000000..327796f --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "void gnutls_ocsp_req_deinit(gnutls_ocsp_req_t " req ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_t req" 12 +The data to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a OCSP request structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_export.3 b/doc/manpages/gnutls_ocsp_req_export.3 new file mode 100644 index 0000000..725c512 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_export.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_export \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_export(gnutls_ocsp_req_const_t " req ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_const_t req" 12 +Holds the OCSP request +.IP "gnutls_datum_t * data" 12 +newly allocate buffer holding DER encoded OCSP request +.SH "DESCRIPTION" +This function will export the OCSP request to DER format. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_get_cert_id.3 b/doc/manpages/gnutls_ocsp_req_get_cert_id.3 new file mode 100644 index 0000000..336c74d --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_get_cert_id.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_get_cert_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_get_cert_id \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_get_cert_id(gnutls_ocsp_req_const_t " req ", unsigned " indx ", gnutls_digest_algorithm_t * " digest ", gnutls_datum_t * " issuer_name_hash ", gnutls_datum_t * " issuer_key_hash ", gnutls_datum_t * " serial_number ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_const_t req" 12 +should contain a \fBgnutls_ocsp_req_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to get. Use (0) to get the first one. +.IP "gnutls_digest_algorithm_t * digest" 12 +output variable with \fBgnutls_digest_algorithm_t\fP hash algorithm +.IP "gnutls_datum_t * issuer_name_hash" 12 +output buffer with hash of issuer's DN +.IP "gnutls_datum_t * issuer_key_hash" 12 +output buffer with hash of issuer's public key +.IP "gnutls_datum_t * serial_number" 12 +output buffer with serial number of certificate to check +.SH "DESCRIPTION" +This function will return the certificate information of the + \fIindx\fP 'ed request in the OCSP request. The information returned +corresponds to the CertID structure: + +<informalexample><programlisting> +CertID ::= SEQUENCE { +hashAlgorithm AlgorithmIdentifier, +issuerNameHash OCTET STRING, \-\- Hash of Issuer's DN +issuerKeyHash OCTET STRING, \-\- Hash of Issuers public key +serialNumber CertificateSerialNumber } +</programlisting></informalexample> + +Each of the pointers to output variables may be NULL to indicate +that the caller is not interested in that value. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. If you have reached the last +CertID available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be +returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_get_extension.3 b/doc/manpages/gnutls_ocsp_req_get_extension.3 new file mode 100644 index 0000000..a04d95a --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_get_extension.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_get_extension" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_get_extension \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_get_extension(gnutls_ocsp_req_const_t " req ", unsigned " indx ", gnutls_datum_t * " oid ", unsigned int * " critical ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_const_t req" 12 +should contain a \fBgnutls_ocsp_req_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to get. Use (0) to get the first one. +.IP "gnutls_datum_t * oid" 12 +will hold newly allocated buffer with OID of extension, may be NULL +.IP "unsigned int * critical" 12 +output variable with critical flag, may be NULL. +.IP "gnutls_datum_t * data" 12 +will hold newly allocated buffer with extension data, may be NULL +.SH "DESCRIPTION" +This function will return all information about the requested +extension in the OCSP request. The information returned is the +OID, the critical flag, and the data itself. The extension OID +will be stored as a string. Any of \fIoid\fP , \fIcritical\fP , and \fIdata\fP may +be NULL which means that the caller is not interested in getting +that information back. + +The caller needs to deallocate memory by calling \fBgnutls_free()\fP on + \fIoid\fP \->data and \fIdata\fP \->data. + +Since 3.7.0 \fIoid\fP \->size does not account for the terminating null byte. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. If you have reached the last +extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will +be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_get_nonce.3 b/doc/manpages/gnutls_ocsp_req_get_nonce.3 new file mode 100644 index 0000000..3e59205 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_get_nonce.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_get_nonce" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_get_nonce \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_get_nonce(gnutls_ocsp_req_const_t " req ", unsigned int * " critical ", gnutls_datum_t * " nonce ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_const_t req" 12 +should contain a \fBgnutls_ocsp_req_t\fP type +.IP "unsigned int * critical" 12 +whether nonce extension is marked critical, or NULL +.IP "gnutls_datum_t * nonce" 12 +will hold newly allocated buffer with nonce data +.SH "DESCRIPTION" +This function will return the OCSP request nonce extension data. + +The caller needs to deallocate memory by calling \fBgnutls_free()\fP on + \fInonce\fP \->data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_get_version.3 b/doc/manpages/gnutls_ocsp_req_get_version.3 new file mode 100644 index 0000000..9dfd54b --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_get_version.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_get_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_get_version \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_get_version(gnutls_ocsp_req_const_t " req ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_const_t req" 12 +should contain a \fBgnutls_ocsp_req_t\fP type +.SH "DESCRIPTION" +This function will return the version of the OCSP request. +Typically this is always 1 indicating version 1. +.SH "RETURNS" +version of OCSP request, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_import.3 b/doc/manpages/gnutls_ocsp_req_import.3 new file mode 100644 index 0000000..b033cef --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_import.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_import \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_import(gnutls_ocsp_req_t " req ", const gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_t req" 12 +The data to store the parsed request. +.IP "const gnutls_datum_t * data" 12 +DER encoded OCSP request. +.SH "DESCRIPTION" +This function will convert the given DER encoded OCSP request to +the native \fBgnutls_ocsp_req_t\fP format. The output will be stored in + \fIreq\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_init.3 b/doc/manpages/gnutls_ocsp_req_init.3 new file mode 100644 index 0000000..e84b1fa --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_init.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_init \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_init(gnutls_ocsp_req_t * " req ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_t * req" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize an OCSP request structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_print.3 b/doc/manpages/gnutls_ocsp_req_print.3 new file mode 100644 index 0000000..9e028c7 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_print.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_print \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_print(gnutls_ocsp_req_const_t " req ", gnutls_ocsp_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_const_t req" 12 +The data to be printed +.IP "gnutls_ocsp_print_formats_t format" 12 +Indicate the format to use +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with (0) terminated string. +.SH "DESCRIPTION" +This function will pretty print a OCSP request, suitable for +display to a human. + +If the format is \fBGNUTLS_OCSP_PRINT_FULL\fP then all fields of the +request will be output, on multiple lines. + +The output \fIout\fP \->data needs to be deallocate using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_randomize_nonce.3 b/doc/manpages/gnutls_ocsp_req_randomize_nonce.3 new file mode 100644 index 0000000..1b8137b --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_randomize_nonce.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_randomize_nonce" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_randomize_nonce \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_randomize_nonce(gnutls_ocsp_req_t " req ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_t req" 12 +should contain a \fBgnutls_ocsp_req_t\fP type +.SH "DESCRIPTION" +This function will add or update an nonce extension to the OCSP +request with a newly generated random value. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_set_extension.3 b/doc/manpages/gnutls_ocsp_req_set_extension.3 new file mode 100644 index 0000000..f679e5b --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_set_extension.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_set_extension" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_set_extension \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_set_extension(gnutls_ocsp_req_t " req ", const char * " oid ", unsigned int " critical ", const gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_t req" 12 +should contain a \fBgnutls_ocsp_req_t\fP type +.IP "const char * oid" 12 +buffer with OID of extension as a string. +.IP "unsigned int critical" 12 +critical flag, normally false. +.IP "const gnutls_datum_t * data" 12 +the extension data +.SH "DESCRIPTION" +This function will add an extension to the OCSP request. Calling +this function multiple times for the same OID will overwrite values +from earlier calls. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_req_set_nonce.3 b/doc/manpages/gnutls_ocsp_req_set_nonce.3 new file mode 100644 index 0000000..89147af --- /dev/null +++ b/doc/manpages/gnutls_ocsp_req_set_nonce.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_req_set_nonce" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_req_set_nonce \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_req_set_nonce(gnutls_ocsp_req_t " req ", unsigned int " critical ", const gnutls_datum_t * " nonce ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_req_t req" 12 +should contain a \fBgnutls_ocsp_req_t\fP type +.IP "unsigned int critical" 12 +critical flag, normally false. +.IP "const gnutls_datum_t * nonce" 12 +the nonce data +.SH "DESCRIPTION" +This function will add an nonce extension to the OCSP request. +Calling this function multiple times will overwrite values from +earlier calls. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_check_crt.3 b/doc/manpages/gnutls_ocsp_resp_check_crt.3 new file mode 100644 index 0000000..ade0c55 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_check_crt.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_check_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_check_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_check_crt(gnutls_ocsp_resp_const_t " resp ", unsigned int " indx ", gnutls_x509_crt_t " crt ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "unsigned int indx" 12 +Specifies response number to get. Use (0) to get the first one. +.IP "gnutls_x509_crt_t crt" 12 +The certificate to check +.SH "DESCRIPTION" +This function will check whether the OCSP response +is about the provided certificate. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_deinit.3 b/doc/manpages/gnutls_ocsp_resp_deinit.3 new file mode 100644 index 0000000..0488c01 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "void gnutls_ocsp_resp_deinit(gnutls_ocsp_resp_t " resp ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_t resp" 12 +The data to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a OCSP response structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_export.3 b/doc/manpages/gnutls_ocsp_resp_export.3 new file mode 100644 index 0000000..c139f13 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_export.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_export \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_export(gnutls_ocsp_resp_const_t " resp ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +Holds the OCSP response +.IP "gnutls_datum_t * data" 12 +newly allocate buffer holding DER encoded OCSP response +.SH "DESCRIPTION" +This function will export the OCSP response to DER format. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_export2.3 b/doc/manpages/gnutls_ocsp_resp_export2.3 new file mode 100644 index 0000000..c16a616 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_export2.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_export2(gnutls_ocsp_resp_const_t " resp ", gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " fmt ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +Holds the OCSP response +.IP "gnutls_datum_t * data" 12 +newly allocate buffer holding DER or PEM encoded OCSP response +.IP "gnutls_x509_crt_fmt_t fmt" 12 +DER or PEM +.SH "DESCRIPTION" +This function will export the OCSP response to DER or PEM format. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_certs.3 b/doc/manpages/gnutls_ocsp_resp_get_certs.3 new file mode 100644 index 0000000..f9983ad --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_certs.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_certs" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_certs \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_certs(gnutls_ocsp_resp_const_t " resp ", gnutls_x509_crt_t ** " certs ", size_t * " ncerts ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "gnutls_x509_crt_t ** certs" 12 +newly allocated array with \fBgnutls_x509_crt_t\fP certificates +.IP "size_t * ncerts" 12 +output variable with number of allocated certs. +.SH "DESCRIPTION" +This function will extract the X.509 certificates found in the +Basic OCSP Response. The \fIcerts\fP output variable will hold a newly +allocated zero\-terminated array with X.509 certificates. + +Every certificate in the array needs to be de\-allocated with +\fBgnutls_x509_crt_deinit()\fP and the array itself must be freed using +\fBgnutls_free()\fP. + +Both the \fIcerts\fP and \fIncerts\fP variables may be NULL. Then the +function will work as normal but will not return the NULL:d +information. This can be used to get the number of certificates +only, or to just get the certificate array without its size. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_extension.3 b/doc/manpages/gnutls_ocsp_resp_get_extension.3 new file mode 100644 index 0000000..f04c93a --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_extension.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_extension" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_extension \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_extension(gnutls_ocsp_resp_const_t " resp ", unsigned " indx ", gnutls_datum_t * " oid ", unsigned int * " critical ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to get. Use (0) to get the first one. +.IP "gnutls_datum_t * oid" 12 +will hold newly allocated buffer with OID of extension, may be NULL +.IP "unsigned int * critical" 12 +output variable with critical flag, may be NULL. +.IP "gnutls_datum_t * data" 12 +will hold newly allocated buffer with extension data, may be NULL +.SH "DESCRIPTION" +This function will return all information about the requested +extension in the OCSP response. The information returned is the +OID, the critical flag, and the data itself. The extension OID +will be stored as a string. Any of \fIoid\fP , \fIcritical\fP , and \fIdata\fP may +be NULL which means that the caller is not interested in getting +that information back. + +The caller needs to deallocate memory by calling \fBgnutls_free()\fP on + \fIoid\fP \->data and \fIdata\fP \->data. + +Since 3.7.0 \fIoid\fP \->size does not account for the terminating null byte. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. If you have reached the last +extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will +be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_nonce.3 b/doc/manpages/gnutls_ocsp_resp_get_nonce.3 new file mode 100644 index 0000000..d7dd2c5 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_nonce.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_nonce" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_nonce \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_nonce(gnutls_ocsp_resp_const_t " resp ", unsigned int * " critical ", gnutls_datum_t * " nonce ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "unsigned int * critical" 12 +whether nonce extension is marked critical +.IP "gnutls_datum_t * nonce" 12 +will hold newly allocated buffer with nonce data +.SH "DESCRIPTION" +This function will return the Basic OCSP Response nonce extension +data. + +The caller needs to deallocate memory by calling \fBgnutls_free()\fP on + \fInonce\fP \->data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_produced.3 b/doc/manpages/gnutls_ocsp_resp_get_produced.3 new file mode 100644 index 0000000..73f2260 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_produced.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_produced" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_produced \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "time_t gnutls_ocsp_resp_get_produced(gnutls_ocsp_resp_const_t " resp ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.SH "DESCRIPTION" +This function will return the time when the OCSP response was +signed. +.SH "RETURNS" +signing time, or (time_t)\-1 on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_responder.3 b/doc/manpages/gnutls_ocsp_resp_get_responder.3 new file mode 100644 index 0000000..09a4392 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_responder.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_responder" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_responder \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_responder(gnutls_ocsp_resp_const_t " resp ", gnutls_datum_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "gnutls_datum_t * dn" 12 +newly allocated buffer with name +.SH "DESCRIPTION" +This function will extract the name of the Basic OCSP Response in +the provided buffer. The name will be in the form +"C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string +will be ASCII or UTF\-8 encoded, depending on the certificate data. + +If the responder ID is not a name but a hash, this function +will return zero and the \fIdn\fP elements will be set to \fBNULL\fP. + +The caller needs to deallocate memory by calling \fBgnutls_free()\fP on + \fIdn\fP \->data. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_ocsp_resp_get_responder2()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. When no data exist it will +return success and set \fIdn\fP elements to zero. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_responder2.3 b/doc/manpages/gnutls_ocsp_resp_get_responder2.3 new file mode 100644 index 0000000..cd19a60 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_responder2.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_responder2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_responder2 \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_responder2(gnutls_ocsp_resp_const_t " resp ", gnutls_datum_t * " dn ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "gnutls_datum_t * dn" 12 +newly allocated buffer with name +.IP "unsigned flags" 12 +zero or \fBGNUTLS_X509_DN_FLAG_COMPAT\fP +.SH "DESCRIPTION" +This function will extract the name of the Basic OCSP Response in +the provided buffer. The name will be in the form +"C=xxxx,O=yyyy,CN=zzzz" as described in RFC2253. The output string +will be ASCII or UTF\-8 encoded, depending on the certificate data. + +If the responder ID is not a name but a hash, this function +will return zero and the \fIdn\fP elements will be set to \fBNULL\fP. + +The caller needs to deallocate memory by calling \fBgnutls_free()\fP on + \fIdn\fP \->data. + +When the flag \fBGNUTLS_X509_DN_FLAG_COMPAT\fP is specified, the output +format will match the format output by previous to 3.5.6 versions of GnuTLS +which was not not fully RFC4514\-compliant. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. When no data exist it will return +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_responder_raw_id.3 b/doc/manpages/gnutls_ocsp_resp_get_responder_raw_id.3 new file mode 100644 index 0000000..29e833d --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_responder_raw_id.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_responder_raw_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_responder_raw_id \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_responder_raw_id(gnutls_ocsp_resp_const_t " resp ", unsigned " type ", gnutls_datum_t * " raw ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "unsigned type" 12 +should be \fBGNUTLS_OCSP_RESP_ID_KEY\fP or \fBGNUTLS_OCSP_RESP_ID_DN\fP +.IP "gnutls_datum_t * raw" 12 +newly allocated buffer with the raw ID +.SH "DESCRIPTION" +This function will extract the raw key (or DN) ID of the Basic OCSP Response in +the provided buffer. If the responder ID is not a key ID then +this function will return \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP. + +The caller needs to deallocate memory by calling \fBgnutls_free()\fP on + \fIdn\fP \->data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_response.3 b/doc/manpages/gnutls_ocsp_resp_get_response.3 new file mode 100644 index 0000000..797a997 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_response.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_response" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_response \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_response(gnutls_ocsp_resp_const_t " resp ", gnutls_datum_t * " response_type_oid ", gnutls_datum_t * " response ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "gnutls_datum_t * response_type_oid" 12 +newly allocated output buffer with response type OID +.IP "gnutls_datum_t * response" 12 +newly allocated output buffer with DER encoded response +.SH "DESCRIPTION" +This function will extract the response type OID in and the +response data from an OCSP response. Normally the + \fIresponse_type_oid\fP is always "1.3.6.1.5.5.7.48.1.1" which means the + \fIresponse\fP should be decoded as a Basic OCSP Response, but +technically other response types could be used. + +This function is typically only useful when you want to extract the +response type OID of an response for diagnostic purposes. +Otherwise \fBgnutls_ocsp_resp_import()\fP will decode the basic OCSP +response part and the caller need not worry about that aspect. + +Since 3.7.0 \fIresponse_type_oid\fP \->size does not account for the terminating +null byte. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_signature.3 b/doc/manpages/gnutls_ocsp_resp_get_signature.3 new file mode 100644 index 0000000..9c9c958 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_signature.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_signature" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_signature \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_signature(gnutls_ocsp_resp_const_t " resp ", gnutls_datum_t * " sig ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "gnutls_datum_t * sig" 12 +newly allocated output buffer with signature data +.SH "DESCRIPTION" +This function will extract the signature field of a OCSP response. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_signature_algorithm.3 b/doc/manpages/gnutls_ocsp_resp_get_signature_algorithm.3 new file mode 100644 index 0000000..39e650e --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_signature_algorithm.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_signature_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_signature_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_signature_algorithm(gnutls_ocsp_resp_const_t " resp ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.SH "DESCRIPTION" +This function will return a value of the \fBgnutls_sign_algorithm_t\fP +enumeration that is the signature algorithm that has been used to +sign the OCSP response. +.SH "RETURNS" +a \fBgnutls_sign_algorithm_t\fP value, or a negative error code +on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_single.3 b/doc/manpages/gnutls_ocsp_resp_get_single.3 new file mode 100644 index 0000000..e4f138a --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_single.3 @@ -0,0 +1,64 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_single" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_single \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_single(gnutls_ocsp_resp_const_t " resp ", unsigned " indx ", gnutls_digest_algorithm_t * " digest ", gnutls_datum_t * " issuer_name_hash ", gnutls_datum_t * " issuer_key_hash ", gnutls_datum_t * " serial_number ", unsigned int * " cert_status ", time_t * " this_update ", time_t * " next_update ", time_t * " revocation_time ", unsigned int * " revocation_reason ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "unsigned indx" 12 +Specifies response number to get. Use (0) to get the first one. +.IP "gnutls_digest_algorithm_t * digest" 12 +output variable with \fBgnutls_digest_algorithm_t\fP hash algorithm +.IP "gnutls_datum_t * issuer_name_hash" 12 +output buffer with hash of issuer's DN +.IP "gnutls_datum_t * issuer_key_hash" 12 +output buffer with hash of issuer's public key +.IP "gnutls_datum_t * serial_number" 12 +output buffer with serial number of certificate to check +.IP "unsigned int * cert_status" 12 +a certificate status, a \fBgnutls_ocsp_cert_status_t\fP enum. +.IP "time_t * this_update" 12 +time at which the status is known to be correct. +.IP "time_t * next_update" 12 +when newer information will be available, or (time_t)\-1 if unspecified +.IP "time_t * revocation_time" 12 +when \fIcert_status\fP is \fBGNUTLS_OCSP_CERT_REVOKED\fP, holds time of revocation. +.IP "unsigned int * revocation_reason" 12 +revocation reason, a \fBgnutls_x509_crl_reason_t\fP enum. +.SH "DESCRIPTION" +This function will return the certificate information of the + \fIindx\fP 'ed response in the Basic OCSP Response \fIresp\fP . The +information returned corresponds to the OCSP SingleResponse structure +except the final singleExtensions. + +Each of the pointers to output variables may be NULL to indicate +that the caller is not interested in that value. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code is returned. If you have reached the last +CertID available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be +returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_status.3 b/doc/manpages/gnutls_ocsp_resp_get_status.3 new file mode 100644 index 0000000..2872722 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_status.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_status \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_status(gnutls_ocsp_resp_const_t " resp ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.SH "DESCRIPTION" +This function will return the status of a OCSP response, an +\fBgnutls_ocsp_resp_status_t\fP enumeration. +.SH "RETURNS" +status of OCSP request as a \fBgnutls_ocsp_resp_status_t\fP, or +a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_get_version.3 b/doc/manpages/gnutls_ocsp_resp_get_version.3 new file mode 100644 index 0000000..7514117 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_get_version.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_get_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_get_version \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_get_version(gnutls_ocsp_resp_const_t " resp ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.SH "DESCRIPTION" +This function will return the version of the Basic OCSP Response. +Typically this is always 1 indicating version 1. +.SH "RETURNS" +version of Basic OCSP response, or a negative error code +on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_import.3 b/doc/manpages/gnutls_ocsp_resp_import.3 new file mode 100644 index 0000000..6a9862a --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_import.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_import \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_import(gnutls_ocsp_resp_t " resp ", const gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_t resp" 12 +The data to store the parsed response. +.IP "const gnutls_datum_t * data" 12 +DER encoded OCSP response. +.SH "DESCRIPTION" +This function will convert the given DER encoded OCSP response to +the native \fBgnutls_ocsp_resp_t\fP format. It also decodes the Basic +OCSP Response part, if any. The output will be stored in \fIresp\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_import2.3 b/doc/manpages/gnutls_ocsp_resp_import2.3 new file mode 100644 index 0000000..9698b1c --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_import2.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_import2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_import2 \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_import2(gnutls_ocsp_resp_t " resp ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " fmt ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_t resp" 12 +The data to store the parsed response. +.IP "const gnutls_datum_t * data" 12 +DER or PEM encoded OCSP response. +.IP "gnutls_x509_crt_fmt_t fmt" 12 +DER or PEM +.SH "DESCRIPTION" +This function will convert the given OCSP response to +the native \fBgnutls_ocsp_resp_t\fP format. It also decodes the Basic +OCSP Response part, if any. The output will be stored in \fIresp\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_init.3 b/doc/manpages/gnutls_ocsp_resp_init.3 new file mode 100644 index 0000000..a6ac54b --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_init.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_init \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_init(gnutls_ocsp_resp_t * " resp ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_t * resp" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize an OCSP response structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_list_import2.3 b/doc/manpages/gnutls_ocsp_resp_list_import2.3 new file mode 100644 index 0000000..dc83dff --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_list_import2.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_list_import2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_list_import2 \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_list_import2(gnutls_ocsp_resp_t ** " ocsps ", unsigned int * " size ", const gnutls_datum_t * " resp_data ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_t ** ocsps" 12 +Will hold the parsed OCSP response list. +.IP "unsigned int * size" 12 +It will contain the size of the list. +.IP "const gnutls_datum_t * resp_data" 12 +The PEM encoded OCSP list. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of \fBGNUTLS_X509_FMT_PEM\fP or \fBGNUTLS_X509_FMT_DER\fP +.IP "unsigned int flags" 12 +must be (0) or an OR'd sequence of gnutls_certificate_import_flags. +.SH "DESCRIPTION" +This function will convert the given PEM encoded OCSP response list +to the native gnutls_ocsp_resp_t format. The output will be stored +in \fIocsps\fP which will be allocated and initialized. + +The OCSP responses should have a header of "OCSP RESPONSE". + +To deinitialize responses, you need to deinitialize each \fBgnutls_ocsp_resp_t\fP +structure independently, and use \fBgnutls_free()\fP at \fIocsps\fP . + +In PEM files, when no OCSP responses are detected +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "RETURNS" +the number of responses read or a negative error value. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_print.3 b/doc/manpages/gnutls_ocsp_resp_print.3 new file mode 100644 index 0000000..4624e6f --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_print.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_print \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_print(gnutls_ocsp_resp_const_t " resp ", gnutls_ocsp_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +The data to be printed +.IP "gnutls_ocsp_print_formats_t format" 12 +Indicate the format to use +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with (0) terminated string. +.SH "DESCRIPTION" +This function will pretty print a OCSP response, suitable for +display to a human. + +If the format is \fBGNUTLS_OCSP_PRINT_FULL\fP then all fields of the +response will be output, on multiple lines. + +The output \fIout\fP \->data needs to be deallocate using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_verify.3 b/doc/manpages/gnutls_ocsp_resp_verify.3 new file mode 100644 index 0000000..7b2a173 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_verify.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_verify" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_verify \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_verify(gnutls_ocsp_resp_const_t " resp ", gnutls_x509_trust_list_t " trustlist ", unsigned int * " verify ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "gnutls_x509_trust_list_t trustlist" 12 +trust anchors as a \fBgnutls_x509_trust_list_t\fP type +.IP "unsigned int * verify" 12 +output variable with verification status, an \fBgnutls_ocsp_verify_reason_t\fP +.IP "unsigned int flags" 12 +verification flags from \fBgnutls_certificate_verify_flags\fP +.SH "DESCRIPTION" +Verify signature of the Basic OCSP Response against the public key +in the certificate of a trusted signer. The \fItrustlist\fP should be +populated with trust anchors. The function will extract the signer +certificate from the Basic OCSP Response and will verify it against +the \fItrustlist\fP . A trusted signer is a certificate that is either +in \fItrustlist\fP , or it is signed directly by a certificate in + \fItrustlist\fP and has the id\-ad\-ocspSigning Extended Key Usage bit +set. + +The output \fIverify\fP variable will hold verification status codes +(e.g., \fBGNUTLS_OCSP_VERIFY_SIGNER_NOT_FOUND\fP, +\fBGNUTLS_OCSP_VERIFY_INSECURE_ALGORITHM\fP) which are only valid if the +function returned \fBGNUTLS_E_SUCCESS\fP. + +Note that the function returns \fBGNUTLS_E_SUCCESS\fP even when +verification failed. The caller must always inspect the \fIverify\fP variable to find out the verification status. + +The \fIflags\fP variable should be 0 for now. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_resp_verify_direct.3 b/doc/manpages/gnutls_ocsp_resp_verify_direct.3 new file mode 100644 index 0000000..2ea5df6 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_resp_verify_direct.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_resp_verify_direct" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_resp_verify_direct \- API function +.SH SYNOPSIS +.B #include <gnutls/ocsp.h> +.sp +.BI "int gnutls_ocsp_resp_verify_direct(gnutls_ocsp_resp_const_t " resp ", gnutls_x509_crt_t " issuer ", unsigned int * " verify ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_ocsp_resp_const_t resp" 12 +should contain a \fBgnutls_ocsp_resp_t\fP type +.IP "gnutls_x509_crt_t issuer" 12 +certificate believed to have signed the response +.IP "unsigned int * verify" 12 +output variable with verification status, an \fBgnutls_ocsp_verify_reason_t\fP +.IP "unsigned int flags" 12 +verification flags from \fBgnutls_certificate_verify_flags\fP +.SH "DESCRIPTION" +Verify signature of the Basic OCSP Response against the public key +in the \fIissuer\fP certificate. + +The output \fIverify\fP variable will hold verification status codes +(e.g., \fBGNUTLS_OCSP_VERIFY_SIGNER_NOT_FOUND\fP, +\fBGNUTLS_OCSP_VERIFY_INSECURE_ALGORITHM\fP) which are only valid if the +function returned \fBGNUTLS_E_SUCCESS\fP. + +Note that the function returns \fBGNUTLS_E_SUCCESS\fP even when +verification failed. The caller must always inspect the \fIverify\fP variable to find out the verification status. + +The \fIflags\fP variable should be 0 for now. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_status_request_enable_client.3 b/doc/manpages/gnutls_ocsp_status_request_enable_client.3 new file mode 100644 index 0000000..7024ac3 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_status_request_enable_client.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_status_request_enable_client" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_status_request_enable_client \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_ocsp_status_request_enable_client(gnutls_session_t " session ", gnutls_datum_t * " responder_id ", size_t " responder_id_size ", gnutls_datum_t * " extensions ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_datum_t * responder_id" 12 +ignored, must be \fBNULL\fP +.IP "size_t responder_id_size" 12 +ignored, must be zero +.IP "gnutls_datum_t * extensions" 12 +ignored, must be \fBNULL\fP +.SH "DESCRIPTION" +This function is to be used by clients to request OCSP response +from the server, using the "status_request" TLS extension. Only +OCSP status type is supported. + +Previous versions of GnuTLS supported setting \fIresponder_id\fP and + \fIextensions\fP fields, but due to the difficult semantics of the +parameter usage, and other issues, this support was removed +since 3.6.0 and these parameters must be set to \fBNULL\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_status_request_get.3 b/doc/manpages/gnutls_ocsp_status_request_get.3 new file mode 100644 index 0000000..c2f9b26 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_status_request_get.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_status_request_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_status_request_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_ocsp_status_request_get(gnutls_session_t " session ", gnutls_datum_t * " response ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_datum_t * response" 12 +a \fBgnutls_datum_t\fP with DER encoded OCSP response +.SH "DESCRIPTION" +This function returns the OCSP status response received +from the TLS server. The \fIresponse\fP should be treated as +constant. If no OCSP response is available then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_status_request_get2.3 b/doc/manpages/gnutls_ocsp_status_request_get2.3 new file mode 100644 index 0000000..4276843 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_status_request_get2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_status_request_get2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_status_request_get2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_ocsp_status_request_get2(gnutls_session_t " session ", unsigned " idx ", gnutls_datum_t * " response ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned idx" 12 +the index of peer's certificate +.IP "gnutls_datum_t * response" 12 +a \fBgnutls_datum_t\fP with DER encoded OCSP response +.SH "DESCRIPTION" +This function returns the OCSP status response received +from the TLS server for the certificate index provided. +The index corresponds to certificates as returned by +gnutls_certificate_get_peers. When index is zero this +function operates identically to \fBgnutls_ocsp_status_request_get()\fP. + +The returned \fIresponse\fP should be treated as +constant. If no OCSP response is available for the +given index then \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_ocsp_status_request_is_checked.3 b/doc/manpages/gnutls_ocsp_status_request_is_checked.3 new file mode 100644 index 0000000..2611c21 --- /dev/null +++ b/doc/manpages/gnutls_ocsp_status_request_is_checked.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ocsp_status_request_is_checked" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_ocsp_status_request_is_checked \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_ocsp_status_request_is_checked(gnutls_session_t " session ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "unsigned int flags" 12 +should be zero or \fBGNUTLS_OCSP_SR_IS_AVAIL\fP +.SH "DESCRIPTION" +When flags are zero this function returns non\-zero if a valid OCSP status +response was included in the TLS handshake. That is, an OCSP status response +which is not too old, superseded or marks the certificate as revoked. +It returns zero otherwise. + +When the flag \fBGNUTLS_OCSP_SR_IS_AVAIL\fP is specified, the function +returns non\-zero if an OCSP status response was included in the handshake +even if it was invalid. Otherwise, if no OCSP status response was included, +it returns zero. The \fBGNUTLS_OCSP_SR_IS_AVAIL\fP flag was introduced in GnuTLS 3.4.0. + +This is a helper function when needing to decide whether to perform an +explicit OCSP validity check on the peer's certificate. Should be called after +any of gnutls_certificate_verify_peers*() are called. + +This function is always usable on client side, but on server side only +under TLS 1.3, which is the first version of TLS that allows cliend\-side OCSP +responses. +.SH "RETURNS" +Non\-zero if the response was valid, or a zero if it wasn't sent, +or sent and was invalid. +.SH "SINCE" +3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_oid_to_digest.3 b/doc/manpages/gnutls_oid_to_digest.3 new file mode 100644 index 0000000..5c417dd --- /dev/null +++ b/doc/manpages/gnutls_oid_to_digest.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_oid_to_digest" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_oid_to_digest \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_digest_algorithm_t gnutls_oid_to_digest(const char * " oid ");" +.SH ARGUMENTS +.IP "const char * oid" 12 +is an object identifier +.SH "DESCRIPTION" +Converts a textual object identifier to a \fBgnutls_digest_algorithm_t\fP value. +.SH "RETURNS" +a \fBgnutls_digest_algorithm_t\fP id of the specified digest +algorithm, or \fBGNUTLS_DIG_UNKNOWN\fP on failure. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_oid_to_ecc_curve.3 b/doc/manpages/gnutls_oid_to_ecc_curve.3 new file mode 100644 index 0000000..c15a1ba --- /dev/null +++ b/doc/manpages/gnutls_oid_to_ecc_curve.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_oid_to_ecc_curve" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_oid_to_ecc_curve \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_ecc_curve_t gnutls_oid_to_ecc_curve(const char * " oid ");" +.SH ARGUMENTS +.IP "const char * oid" 12 +is a curve's OID +.SH "RETURNS" +return a \fBgnutls_ecc_curve_t\fP value corresponding to +the specified OID, or \fBGNUTLS_ECC_CURVE_INVALID\fP on error. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_oid_to_gost_paramset.3 b/doc/manpages/gnutls_oid_to_gost_paramset.3 new file mode 100644 index 0000000..6afbe1c --- /dev/null +++ b/doc/manpages/gnutls_oid_to_gost_paramset.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_oid_to_gost_paramset" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_oid_to_gost_paramset \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_gost_paramset_t gnutls_oid_to_gost_paramset(const char * " oid ");" +.SH ARGUMENTS +.IP "const char * oid" 12 +is an object identifier +.SH "DESCRIPTION" +Converts a textual object identifier to a \fBgnutls_gost_paramset_t\fP value. +.SH "RETURNS" +a \fBgnutls_gost_paramset_get_oid\fP of the specified GOST 28147 +param st, or \fBGNUTLS_GOST_PARAMSET_UNKNOWN\fP on failure. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_oid_to_mac.3 b/doc/manpages/gnutls_oid_to_mac.3 new file mode 100644 index 0000000..d4a068e --- /dev/null +++ b/doc/manpages/gnutls_oid_to_mac.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_oid_to_mac" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_oid_to_mac \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_mac_algorithm_t gnutls_oid_to_mac(const char * " oid ");" +.SH ARGUMENTS +.IP "const char * oid" 12 +is an object identifier +.SH "DESCRIPTION" +Converts a textual object identifier typically from PKCS\fB5\fP values to a \fBgnutls_mac_algorithm_t\fP value. +.SH "RETURNS" +a \fBgnutls_mac_algorithm_t\fP id of the specified digest +algorithm, or \fBGNUTLS_MAC_UNKNOWN\fP on failure. +.SH "SINCE" +3.5.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_oid_to_pk.3 b/doc/manpages/gnutls_oid_to_pk.3 new file mode 100644 index 0000000..8b112c7 --- /dev/null +++ b/doc/manpages/gnutls_oid_to_pk.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_oid_to_pk" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_oid_to_pk \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_pk_algorithm_t gnutls_oid_to_pk(const char * " oid ");" +.SH ARGUMENTS +.IP "const char * oid" 12 +is an object identifier +.SH "DESCRIPTION" +Converts a textual object identifier to a \fBgnutls_pk_algorithm_t\fP value. +.SH "RETURNS" +a \fBgnutls_pk_algorithm_t\fP id of the specified digest +algorithm, or \fBGNUTLS_PK_UNKNOWN\fP on failure. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_oid_to_sign.3 b/doc/manpages/gnutls_oid_to_sign.3 new file mode 100644 index 0000000..10ccfc8 --- /dev/null +++ b/doc/manpages/gnutls_oid_to_sign.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_oid_to_sign" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_oid_to_sign \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_sign_algorithm_t gnutls_oid_to_sign(const char * " oid ");" +.SH ARGUMENTS +.IP "const char * oid" 12 +is an object identifier +.SH "DESCRIPTION" +Converts a textual object identifier to a \fBgnutls_sign_algorithm_t\fP value. +.SH "RETURNS" +a \fBgnutls_sign_algorithm_t\fP id of the specified digest +algorithm, or \fBGNUTLS_SIGN_UNKNOWN\fP on failure. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_openpgp_privkey_sign_hash.3 b/doc/manpages/gnutls_openpgp_privkey_sign_hash.3 new file mode 100644 index 0000000..6b744d7 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_sign_hash.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_sign_hash" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_sign_hash \- API function +.SH SYNOPSIS +.B #include <gnutls/compat.h> +.sp +.BI "int gnutls_openpgp_privkey_sign_hash(gnutls_openpgp_privkey_t " key ", const gnutls_datum_t * " hash ", gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +Holds the key +.IP "const gnutls_datum_t * hash" 12 +holds the data to be signed +.IP "gnutls_datum_t * signature" 12 +will contain newly allocated signature +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_openpgp_send_cert.3 b/doc/manpages/gnutls_openpgp_send_cert.3 new file mode 100644 index 0000000..a12a177 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_send_cert.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_send_cert" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_send_cert \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_openpgp_send_cert(gnutls_session_t " session ", gnutls_openpgp_crt_status_t " status ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "gnutls_openpgp_crt_status_t status" 12 +is ignored +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_packet_deinit.3 b/doc/manpages/gnutls_packet_deinit.3 new file mode 100644 index 0000000..422f376 --- /dev/null +++ b/doc/manpages/gnutls_packet_deinit.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_packet_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_packet_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_packet_deinit(gnutls_packet_t " packet ");" +.SH ARGUMENTS +.IP "gnutls_packet_t packet" 12 +is a pointer to a \fBgnutls_packet_st\fP structure. +.SH "DESCRIPTION" +This function will deinitialize all data associated with +the received packet. +.SH "SINCE" +3.3.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_packet_get.3 b/doc/manpages/gnutls_packet_get.3 new file mode 100644 index 0000000..21f6860 --- /dev/null +++ b/doc/manpages/gnutls_packet_get.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_packet_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_packet_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_packet_get(gnutls_packet_t " packet ", gnutls_datum_t * " data ", unsigned char * " sequence ");" +.SH ARGUMENTS +.IP "gnutls_packet_t packet" 12 +is a \fBgnutls_packet_t\fP type. +.IP "gnutls_datum_t * data" 12 +will contain the data present in the \fIpacket\fP structure (may be \fBNULL\fP) +.IP "unsigned char * sequence" 12 +the 8\-bytes of the packet sequence number (may be \fBNULL\fP) +.SH "DESCRIPTION" +This function returns the data and sequence number associated with +the received packet. +.SH "SINCE" +3.3.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pbkdf2.3 b/doc/manpages/gnutls_pbkdf2.3 new file mode 100644 index 0000000..8efe956 --- /dev/null +++ b/doc/manpages/gnutls_pbkdf2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pbkdf2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pbkdf2 \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_pbkdf2(gnutls_mac_algorithm_t " mac ", const gnutls_datum_t * " key ", const gnutls_datum_t * " salt ", unsigned " iter_count ", void * " output ", size_t " length ");" +.SH ARGUMENTS +.IP "gnutls_mac_algorithm_t mac" 12 +the mac algorithm used internally +.IP "const gnutls_datum_t * key" 12 +the initial keying material +.IP "const gnutls_datum_t * salt" 12 +the salt +.IP "unsigned iter_count" 12 +the iteration count +.IP "void * output" 12 +the output value +.IP "size_t length" 12 +the desired length of the output key +.SH "DESCRIPTION" +This function will derive a variable length keying material from +a password according to PKCS \fB5\fP PBKDF2. +.SH "RETURNS" +Zero or a negative error code on error. +.SH "SINCE" +3.6.13 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_deinit.3 b/doc/manpages/gnutls_pcert_deinit.3 new file mode 100644 index 0000000..418f741 --- /dev/null +++ b/doc/manpages/gnutls_pcert_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "void gnutls_pcert_deinit(gnutls_pcert_st * " pcert ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert" 12 +The structure to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a pcert structure. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_export_openpgp.3 b/doc/manpages/gnutls_pcert_export_openpgp.3 new file mode 100644 index 0000000..031e4f9 --- /dev/null +++ b/doc/manpages/gnutls_pcert_export_openpgp.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_export_openpgp" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_export_openpgp \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_export_openpgp(gnutls_pcert_st * " pcert ", gnutls_openpgp_crt_t * " crt ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert" 12 +The pcert structure. +.IP "gnutls_openpgp_crt_t * crt" 12 +An initialized \fBgnutls_openpgp_crt_t\fP. +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_export_x509.3 b/doc/manpages/gnutls_pcert_export_x509.3 new file mode 100644 index 0000000..5372df3 --- /dev/null +++ b/doc/manpages/gnutls_pcert_export_x509.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_export_x509" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_export_x509 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_export_x509(gnutls_pcert_st * " pcert ", gnutls_x509_crt_t * " crt ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert" 12 +The pcert structure. +.IP "gnutls_x509_crt_t * crt" 12 +An initialized \fBgnutls_x509_crt_t\fP. +.SH "DESCRIPTION" +Converts the given \fBgnutls_pcert_t\fP type into a \fBgnutls_x509_crt_t\fP. +This function only works if the type of \fIpcert\fP is \fBGNUTLS_CRT_X509\fP. +When successful, the value written to \fIcrt\fP must be freed with +\fBgnutls_x509_crt_deinit()\fP when no longer needed. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_import_openpgp.3 b/doc/manpages/gnutls_pcert_import_openpgp.3 new file mode 100644 index 0000000..9ba4e59 --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_openpgp.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_openpgp" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_openpgp \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_import_openpgp(gnutls_pcert_st * " pcert ", gnutls_openpgp_crt_t " crt ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert" 12 +The pcert structure +.IP "gnutls_openpgp_crt_t crt" 12 +The raw certificate to be imported +.IP "unsigned int flags" 12 +zero for now +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_import_openpgp_raw.3 b/doc/manpages/gnutls_pcert_import_openpgp_raw.3 new file mode 100644 index 0000000..69506b8 --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_openpgp_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_openpgp_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_openpgp_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_import_openpgp_raw(gnutls_pcert_st * " pcert ", const gnutls_datum_t * " cert ", gnutls_openpgp_crt_fmt_t " format ", gnutls_openpgp_keyid_t " keyid ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert" 12 +The pcert structure +.IP "const gnutls_datum_t * cert" 12 +The raw certificate to be imported +.IP "gnutls_openpgp_crt_fmt_t format" 12 +The format of the certificate +.IP "gnutls_openpgp_keyid_t keyid" 12 +The key ID to use (NULL for the master key) +.IP "unsigned int flags" 12 +zero for now +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_import_rawpk.3 b/doc/manpages/gnutls_pcert_import_rawpk.3 new file mode 100644 index 0000000..90483f4 --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_rawpk.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_rawpk" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_rawpk \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_import_rawpk(gnutls_pcert_st* " pcert ", gnutls_pubkey_t " pubkey ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st* pcert" 12 +The pcert structure to import the data into. +.IP "gnutls_pubkey_t pubkey" 12 +The raw public\-key in \fBgnutls_pubkey_t\fP format to be imported +.IP "unsigned int flags" 12 +zero for now +.SH "DESCRIPTION" +This convenience function will import (i.e. convert) the given raw +public key \fIpubkey\fP into a \fBgnutls_pcert_st\fP structure. The structure +must be deinitialized afterwards using \fBgnutls_pcert_deinit()\fP. The +given \fIpubkey\fP must not be deinitialized because it will be associated +with the given \fIpcert\fP structure and will be deinitialized with it. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_import_rawpk_raw.3 b/doc/manpages/gnutls_pcert_import_rawpk_raw.3 new file mode 100644 index 0000000..fc3dcdc --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_rawpk_raw.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_rawpk_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_rawpk_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_import_rawpk_raw(gnutls_pcert_st* " pcert ", const gnutls_datum_t* " rawpubkey ", gnutls_x509_crt_fmt_t " format ", unsigned int " key_usage ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st* pcert" 12 +The pcert structure to import the data into. +.IP "const gnutls_datum_t* rawpubkey" 12 +The raw public\-key in \fBgnutls_datum_t\fP format to be imported. +.IP "gnutls_x509_crt_fmt_t format" 12 +The format of the raw public\-key. DER or PEM. +.IP "unsigned int key_usage" 12 +An ORed sequence of \fBGNUTLS_KEY_\fP* flags. +.IP "unsigned int flags" 12 +zero for now +.SH "DESCRIPTION" +This convenience function will import (i.e. convert) the given raw +public key \fIrawpubkey\fP into a \fBgnutls_pcert_st\fP structure. The structure +must be deinitialized afterwards using \fBgnutls_pcert_deinit()\fP. +Note that the caller is responsible for freeing \fIrawpubkey\fP . All necessary +values will be copied into \fIpcert\fP . + +Key usage (as defined by X.509 extension (2.5.29.15)) can be explicitly +set because there is no certificate structure around the key to define +this value. See for more info \fBgnutls_x509_crt_get_key_usage()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_import_x509.3 b/doc/manpages/gnutls_pcert_import_x509.3 new file mode 100644 index 0000000..072aa83 --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_x509.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_x509" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_x509 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_import_x509(gnutls_pcert_st * " pcert ", gnutls_x509_crt_t " crt ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert" 12 +The pcert structure +.IP "gnutls_x509_crt_t crt" 12 +The certificate to be imported +.IP "unsigned int flags" 12 +zero for now +.SH "DESCRIPTION" +This convenience function will import the given certificate to a +\fBgnutls_pcert_st\fP structure. The structure must be deinitialized +afterwards using \fBgnutls_pcert_deinit()\fP; +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_import_x509_list.3 b/doc/manpages/gnutls_pcert_import_x509_list.3 new file mode 100644 index 0000000..2e88ed0 --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_x509_list.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_x509_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_x509_list \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_import_x509_list(gnutls_pcert_st * " pcert_list ", gnutls_x509_crt_t * " crt ", unsigned * " ncrt ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert_list" 12 +The structures to store the certificates; must not contain initialized \fBgnutls_pcert_st\fP structures. +.IP "gnutls_x509_crt_t * crt" 12 +The certificates to be imported +.IP "unsigned * ncrt" 12 +The number of certificates in \fIcrt\fP ; will be updated if necessary +.IP "unsigned int flags" 12 +zero or \fBGNUTLS_X509_CRT_LIST_SORT\fP +.SH "DESCRIPTION" +This convenience function will import the given certificates to an +already allocated set of \fBgnutls_pcert_st\fP structures. The structures must +be deinitialized afterwards using \fBgnutls_pcert_deinit()\fP. \fIpcert_list\fP should contain space for at least \fIncrt\fP elements. + +In the case \fBGNUTLS_X509_CRT_LIST_SORT\fP is specified and that +function cannot sort the list, \fBGNUTLS_E_CERTIFICATE_LIST_UNSORTED\fP +will be returned. Currently sorting can fail if the list size +exceeds an internal constraint (16). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_import_x509_raw.3 b/doc/manpages/gnutls_pcert_import_x509_raw.3 new file mode 100644 index 0000000..876ee32 --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_x509_raw.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_x509_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_x509_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_import_x509_raw(gnutls_pcert_st * " pcert ", const gnutls_datum_t * " cert ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert" 12 +The pcert structure +.IP "const gnutls_datum_t * cert" 12 +The raw certificate to be imported +.IP "gnutls_x509_crt_fmt_t format" 12 +The format of the certificate +.IP "unsigned int flags" 12 +zero for now +.SH "DESCRIPTION" +This convenience function will import the given certificate to a +\fBgnutls_pcert_st\fP structure. The structure must be deinitialized +afterwards using \fBgnutls_pcert_deinit()\fP; +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_list_import_x509_file.3 b/doc/manpages/gnutls_pcert_list_import_x509_file.3 new file mode 100644 index 0000000..3d251d4 --- /dev/null +++ b/doc/manpages/gnutls_pcert_list_import_x509_file.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_list_import_x509_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_list_import_x509_file \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_list_import_x509_file(gnutls_pcert_st * " pcert_list ", unsigned * " pcert_list_size ", const char * " file ", gnutls_x509_crt_fmt_t " format ", gnutls_pin_callback_t " pin_fn ", void * " pin_fn_userdata ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert_list" 12 +The structures to store the certificates; must not contain initialized \fBgnutls_pcert_st\fP structures. +.IP "unsigned * pcert_list_size" 12 +Initially must hold the maximum number of certs. It will be updated with the number of certs available. +.IP "const char * file" 12 +A file or supported URI with the certificates to load +.IP "gnutls_x509_crt_fmt_t format" 12 +\fBGNUTLS_X509_FMT_DER\fP or \fBGNUTLS_X509_FMT_PEM\fP if a file is given +.IP "gnutls_pin_callback_t pin_fn" 12 +a PIN callback if not globally set +.IP "void * pin_fn_userdata" 12 +parameter for the PIN callback +.IP "unsigned int flags" 12 +zero or flags from \fBgnutls_certificate_import_flags\fP +.SH "DESCRIPTION" +This convenience function will import a certificate chain from the given +file or supported URI to \fBgnutls_pcert_st\fP structures. The structures +must be deinitialized afterwards using \fBgnutls_pcert_deinit()\fP. + +This function will always return a sorted certificate chain. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value; if the \fIpcert\fP list doesn't have enough space +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be returned. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pcert_list_import_x509_raw.3 b/doc/manpages/gnutls_pcert_list_import_x509_raw.3 new file mode 100644 index 0000000..b4b665d --- /dev/null +++ b/doc/manpages/gnutls_pcert_list_import_x509_raw.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_list_import_x509_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_list_import_x509_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pcert_list_import_x509_raw(gnutls_pcert_st * " pcert_list ", unsigned int * " pcert_list_size ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcert_list" 12 +The structures to store the certificates; must not contain initialized \fBgnutls_pcert_st\fP structures. +.IP "unsigned int * pcert_list_size" 12 +Initially must hold the maximum number of certs. It will be updated with the number of certs available. +.IP "const gnutls_datum_t * data" 12 +The certificates. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM. +.IP "unsigned int flags" 12 +must be (0) or an OR'd sequence of gnutls_certificate_import_flags. +.SH "DESCRIPTION" +This function will import the provided DER or PEM encoded certificates to an +already allocated set of \fBgnutls_pcert_st\fP structures. The structures must +be deinitialized afterwards using \fBgnutls_pcert_deinit()\fP. \fIpcert_list\fP should contain space for at least \fIpcert_list_size\fP elements. + +If the Certificate is PEM encoded it should have a header of "X509 +CERTIFICATE", or "CERTIFICATE". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value; if the \fIpcert\fP list doesn't have enough space +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be returned. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pem_base64_decode.3 b/doc/manpages/gnutls_pem_base64_decode.3 new file mode 100644 index 0000000..d747f15 --- /dev/null +++ b/doc/manpages/gnutls_pem_base64_decode.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pem_base64_decode" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pem_base64_decode \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_pem_base64_decode(const char * " header ", const gnutls_datum_t * " b64_data ", unsigned char * " result ", size_t * " result_size ");" +.SH ARGUMENTS +.IP "const char * header" 12 +A null terminated string with the PEM header (eg. CERTIFICATE) +.IP "const gnutls_datum_t * b64_data" 12 +contain the encoded data +.IP "unsigned char * result" 12 +the place where decoded data will be copied +.IP "size_t * result_size" 12 +holds the size of the result +.SH "DESCRIPTION" +This function will decode the given encoded data. If the header +given is non \fBNULL\fP this function will search for "\-\-\-\-\-BEGIN header" +and decode only this part. Otherwise it will decode the first PEM +packet found. +.SH "RETURNS" +On success \fBGNUTLS_E_SUCCESS\fP (0) is returned, +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned if the buffer given is +not long enough, or 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pem_base64_decode2.3 b/doc/manpages/gnutls_pem_base64_decode2.3 new file mode 100644 index 0000000..799f691 --- /dev/null +++ b/doc/manpages/gnutls_pem_base64_decode2.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pem_base64_decode2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pem_base64_decode2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_pem_base64_decode2(const char * " header ", const gnutls_datum_t * " b64_data ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const char * header" 12 +The PEM header (eg. CERTIFICATE) +.IP "const gnutls_datum_t * b64_data" 12 +contains the encoded data +.IP "gnutls_datum_t * result" 12 +the location of decoded data +.SH "DESCRIPTION" +This function will decode the given encoded data. The decoded data +will be allocated, and stored into result. If the header given is +non null this function will search for "\-\-\-\-\-BEGIN header" and +decode only this part. Otherwise it will decode the first PEM +packet found. + +You should use \fBgnutls_free()\fP to free the returned data. + +Note, that prior to GnuTLS 3.4.0 this function was available +under the name \fBgnutls_pem_base64_decode_alloc()\fP. There is +compatibility macro pointing to this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pem_base64_encode.3 b/doc/manpages/gnutls_pem_base64_encode.3 new file mode 100644 index 0000000..ad9e7ef --- /dev/null +++ b/doc/manpages/gnutls_pem_base64_encode.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pem_base64_encode" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pem_base64_encode \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_pem_base64_encode(const char * " msg ", const gnutls_datum_t * " data ", char * " result ", size_t * " result_size ");" +.SH ARGUMENTS +.IP "const char * msg" 12 +is a message to be put in the header (may be \fBNULL\fP) +.IP "const gnutls_datum_t * data" 12 +contain the raw data +.IP "char * result" 12 +the place where base64 data will be copied +.IP "size_t * result_size" 12 +holds the size of the result +.SH "DESCRIPTION" +This function will convert the given data to printable data, using +the base64 encoding. This is the encoding used in PEM messages. + +The output string will be null terminated, although the output size will +not include the terminating null. +.SH "RETURNS" +On success \fBGNUTLS_E_SUCCESS\fP (0) is returned, +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned if the buffer given is +not long enough, or 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pem_base64_encode2.3 b/doc/manpages/gnutls_pem_base64_encode2.3 new file mode 100644 index 0000000..fa998b4 --- /dev/null +++ b/doc/manpages/gnutls_pem_base64_encode2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pem_base64_encode2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pem_base64_encode2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_pem_base64_encode2(const char * " header ", const gnutls_datum_t * " data ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const char * header" 12 +is a message to be put in the encoded header (may be \fBNULL\fP) +.IP "const gnutls_datum_t * data" 12 +contains the raw data +.IP "gnutls_datum_t * result" 12 +will hold the newly allocated encoded data +.SH "DESCRIPTION" +This function will convert the given data to printable data, using +the base64 encoding. This is the encoding used in PEM messages. +This function will allocate the required memory to hold the encoded +data. + +You should use \fBgnutls_free()\fP to free the returned data. + +Note, that prior to GnuTLS 3.4.0 this function was available +under the name \fBgnutls_pem_base64_encode_alloc()\fP. There is +compatibility macro pointing to this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_perror.3 b/doc/manpages/gnutls_perror.3 new file mode 100644 index 0000000..6a4f48b --- /dev/null +++ b/doc/manpages/gnutls_perror.3 @@ -0,0 +1,34 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_perror" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_perror \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_perror(int " error ");" +.SH ARGUMENTS +.IP "int error" 12 +is a GnuTLS error code, a negative error code +.SH "DESCRIPTION" +This function is like \fBperror()\fP. The only difference is that it +accepts an error number returned by a gnutls function. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pk_algorithm_get_name.3 b/doc/manpages/gnutls_pk_algorithm_get_name.3 new file mode 100644 index 0000000..f14b901 --- /dev/null +++ b/doc/manpages/gnutls_pk_algorithm_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_algorithm_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pk_algorithm_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_pk_algorithm_get_name(gnutls_pk_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_pk_algorithm_t algorithm" 12 +is a pk algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_pk_algorithm_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified public +key algorithm, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pk_bits_to_sec_param.3 b/doc/manpages/gnutls_pk_bits_to_sec_param.3 new file mode 100644 index 0000000..411f387 --- /dev/null +++ b/doc/manpages/gnutls_pk_bits_to_sec_param.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_bits_to_sec_param" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pk_bits_to_sec_param \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_sec_param_t gnutls_pk_bits_to_sec_param(gnutls_pk_algorithm_t " algo ", unsigned int " bits ");" +.SH ARGUMENTS +.IP "gnutls_pk_algorithm_t algo" 12 +is a public key algorithm +.IP "unsigned int bits" 12 +is the number of bits +.SH "DESCRIPTION" +This is the inverse of \fBgnutls_sec_param_to_pk_bits()\fP. Given an algorithm +and the number of bits, it will return the security parameter. This is +a rough indication. +.SH "RETURNS" +The security parameter. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pk_get_id.3 b/doc/manpages/gnutls_pk_get_id.3 new file mode 100644 index 0000000..58e6b56 --- /dev/null +++ b/doc/manpages/gnutls_pk_get_id.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pk_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_pk_algorithm_t gnutls_pk_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a string containing a public key algorithm name. +.SH "DESCRIPTION" +Convert a string to a \fBgnutls_pk_algorithm_t\fP value. The names are +compared in a case insensitive way. For example, +gnutls_pk_get_id("RSA") will return \fBGNUTLS_PK_RSA\fP. +.SH "RETURNS" +a \fBgnutls_pk_algorithm_t\fP id of the specified public key +algorithm string, or \fBGNUTLS_PK_UNKNOWN\fP on failures. +.SH "SINCE" +2.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pk_get_name.3 b/doc/manpages/gnutls_pk_get_name.3 new file mode 100644 index 0000000..b80c423 --- /dev/null +++ b/doc/manpages/gnutls_pk_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pk_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_pk_get_name(gnutls_pk_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_pk_algorithm_t algorithm" 12 +is a public key algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_pk_algorithm_t\fP value to a string. +.SH "RETURNS" +a pointer to a string that contains the name of the +specified public key algorithm, or \fBNULL\fP. +.SH "SINCE" +2.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pk_get_oid.3 b/doc/manpages/gnutls_pk_get_oid.3 new file mode 100644 index 0000000..369f853 --- /dev/null +++ b/doc/manpages/gnutls_pk_get_oid.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_get_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pk_get_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_pk_get_oid(gnutls_pk_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_pk_algorithm_t algorithm" 12 +is a public key algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_pk_algorithm_t\fP value to its object identifier string. +.SH "RETURNS" +a pointer to a string that contains the object identifier of the +specified public key algorithm, or \fBNULL\fP. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pk_list.3 b/doc/manpages/gnutls_pk_list.3 new file mode 100644 index 0000000..c66f5d6 --- /dev/null +++ b/doc/manpages/gnutls_pk_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pk_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_pk_algorithm_t * gnutls_pk_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get a list of supported public key algorithms. + +This function is not thread safe. +.SH "RETURNS" +a (0)\-terminated list of \fBgnutls_pk_algorithm_t\fP integers +indicating the available ciphers. +.SH "SINCE" +2.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pk_to_sign.3 b/doc/manpages/gnutls_pk_to_sign.3 new file mode 100644 index 0000000..53586b6 --- /dev/null +++ b/doc/manpages/gnutls_pk_to_sign.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_to_sign" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pk_to_sign \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_sign_algorithm_t gnutls_pk_to_sign(gnutls_pk_algorithm_t " pk ", gnutls_digest_algorithm_t " hash ");" +.SH ARGUMENTS +.IP "gnutls_pk_algorithm_t pk" 12 +is a public key algorithm +.IP "gnutls_digest_algorithm_t hash" 12 +a hash algorithm +.SH "DESCRIPTION" +This function maps public key and hash algorithms combinations +to signature algorithms. +.SH "RETURNS" +return a \fBgnutls_sign_algorithm_t\fP value, or \fBGNUTLS_SIGN_UNKNOWN\fP on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_add_provider.3 b/doc/manpages/gnutls_pkcs11_add_provider.3 new file mode 100644 index 0000000..ffba410 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_add_provider.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_add_provider" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_add_provider \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_add_provider(const char * " name ", const char * " params ");" +.SH ARGUMENTS +.IP "const char * name" 12 +The filename of the module +.IP "const char * params" 12 +should be NULL or a known string (see description) +.SH "DESCRIPTION" +This function will load and add a PKCS 11 module to the module +list used in gnutls. After this function is called the module will +be used for PKCS 11 operations. + +When loading a module to be used for certificate verification, +use the string 'trusted' as \fIparams\fP . + +Note that this function is not thread safe. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_copy_attached_extension.3 b/doc/manpages/gnutls_pkcs11_copy_attached_extension.3 new file mode 100644 index 0000000..a07fea1 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_copy_attached_extension.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_copy_attached_extension" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_attached_extension \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_copy_attached_extension(const char * " token_url ", gnutls_x509_crt_t " crt ", gnutls_datum_t * " data ", const char * " label ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "gnutls_x509_crt_t crt" 12 +An X.509 certificate object +.IP "gnutls_datum_t * data" 12 +the attached extension +.IP "const char * label" 12 +A name to be used for the attached extension (may be \fBNULL\fP) +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_FLAG_* +.SH "DESCRIPTION" +This function will copy an the attached extension in \fIdata\fP for +the certificate provided in \fIcrt\fP in the PKCS \fB11\fP token specified +by the URL (typically a trust module). The extension must be in +RFC5280 Extension format. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_copy_pubkey.3 b/doc/manpages/gnutls_pkcs11_copy_pubkey.3 new file mode 100644 index 0000000..cb11f7d --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_copy_pubkey.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_copy_pubkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_pubkey \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_copy_pubkey(const char * " token_url ", gnutls_pubkey_t " pubkey ", const char * " label ", const gnutls_datum_t * " cid ", unsigned int " key_usage ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "gnutls_pubkey_t pubkey" 12 +The public key to copy +.IP "const char * label" 12 +The name to be used for the stored data +.IP "const gnutls_datum_t * cid" 12 +The CKA_ID to set for the object \-if NULL, the ID will be derived from the public key +.IP "unsigned int key_usage" 12 +One of GNUTLS_KEY_* +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_FLAG_* +.SH "DESCRIPTION" +This function will copy a public key object into a PKCS \fB11\fP token specified by +a URL. Valid flags to mark the key: \fBGNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_PRIVATE\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_MARK_CA\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_ALWAYS_AUTH\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_copy_secret_key.3 b/doc/manpages/gnutls_pkcs11_copy_secret_key.3 new file mode 100644 index 0000000..4351a69 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_copy_secret_key.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_copy_secret_key" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_secret_key \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_copy_secret_key(const char * " token_url ", gnutls_datum_t * " key ", const char * " label ", unsigned int " key_usage ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "gnutls_datum_t * key" 12 +The raw key +.IP "const char * label" 12 +A name to be used for the stored data +.IP "unsigned int key_usage" 12 +One of GNUTLS_KEY_* +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_FLAG_* +.SH "DESCRIPTION" +This function will copy a raw secret (symmetric) key into a PKCS \fB11\fP +token specified by a URL. The key can be marked as sensitive or not. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_copy_x509_crt.3 b/doc/manpages/gnutls_pkcs11_copy_x509_crt.3 new file mode 100644 index 0000000..435bd46 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_copy_x509_crt.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_copy_x509_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_x509_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_copy_x509_crt(const char * " token_url ", gnutls_x509_crt_t " crt ", const char * " label ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "gnutls_x509_crt_t crt" 12 +A certificate +.IP "const char * label" 12 +A name to be used for the stored data +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_FLAG_* +.SH "DESCRIPTION" +This function will copy a certificate into a PKCS \fB11\fP token specified by +a URL. The certificate can be marked as trusted or not. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_copy_x509_crt2.3 b/doc/manpages/gnutls_pkcs11_copy_x509_crt2.3 new file mode 100644 index 0000000..668ded4 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_copy_x509_crt2.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_copy_x509_crt2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_x509_crt2 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_copy_x509_crt2(const char * " token_url ", gnutls_x509_crt_t " crt ", const char * " label ", const gnutls_datum_t * " cid ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "gnutls_x509_crt_t crt" 12 +The certificate to copy +.IP "const char * label" 12 +The name to be used for the stored data +.IP "const gnutls_datum_t * cid" 12 +The CKA_ID to set for the object \-if NULL, the ID will be derived from the public key +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_FLAG_* +.SH "DESCRIPTION" +This function will copy a certificate into a PKCS \fB11\fP token specified by +a URL. Valid flags to mark the certificate: \fBGNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_PRIVATE\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_MARK_CA\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_ALWAYS_AUTH\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_copy_x509_privkey.3 b/doc/manpages/gnutls_pkcs11_copy_x509_privkey.3 new file mode 100644 index 0000000..6da9375 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_copy_x509_privkey.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_copy_x509_privkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_x509_privkey \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_copy_x509_privkey(const char * " token_url ", gnutls_x509_privkey_t " key ", const char * " label ", unsigned int " key_usage ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "gnutls_x509_privkey_t key" 12 +A private key +.IP "const char * label" 12 +A name to be used for the stored data +.IP "unsigned int key_usage" 12 +One of GNUTLS_KEY_* +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +This function will copy a private key into a PKCS \fB11\fP token specified by +a URL. + +Since 3.6.3 the objects are marked as sensitive by default unless +\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_NOT_SENSITIVE\fP is specified. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_copy_x509_privkey2.3 b/doc/manpages/gnutls_pkcs11_copy_x509_privkey2.3 new file mode 100644 index 0000000..647ce01 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_copy_x509_privkey2.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_copy_x509_privkey2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_x509_privkey2 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_copy_x509_privkey2(const char * " token_url ", gnutls_x509_privkey_t " key ", const char * " label ", const gnutls_datum_t * " cid ", unsigned int " key_usage ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "gnutls_x509_privkey_t key" 12 +A private key +.IP "const char * label" 12 +A name to be used for the stored data +.IP "const gnutls_datum_t * cid" 12 +The CKA_ID to set for the object \-if NULL, the ID will be derived from the public key +.IP "unsigned int key_usage" 12 +One of GNUTLS_KEY_* +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +This function will copy a private key into a PKCS \fB11\fP token specified by +a URL. + +Since 3.6.3 the objects are marked as sensitive by default unless +\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_NOT_SENSITIVE\fP is specified. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_crt_is_known.3 b/doc/manpages/gnutls_pkcs11_crt_is_known.3 new file mode 100644 index 0000000..ca3e5f3 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_crt_is_known.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_crt_is_known" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_crt_is_known \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "unsigned gnutls_pkcs11_crt_is_known(const char * " url ", gnutls_x509_crt_t " cert ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +A PKCS 11 url identifying a token +.IP "gnutls_x509_crt_t cert" 12 +is the certificate to find issuer for +.IP "unsigned int flags" 12 +Use zero or flags from \fBGNUTLS_PKCS11_OBJ_FLAG\fP. +.SH "DESCRIPTION" +This function will check whether the provided certificate is stored +in the specified token. This is useful in combination with +\fBGNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_TRUSTED\fP or +\fBGNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_DISTRUSTED\fP, +to check whether a CA is present or a certificate is blacklisted in +a trust PKCS \fB11\fP module. + +This function can be used with a \fIurl\fP of "pkcs11:", and in that case all modules +will be searched. To restrict the modules to the marked as trusted in p11\-kit +use the \fBGNUTLS_PKCS11_OBJ_FLAG_PRESENT_IN_TRUSTED_MODULE\fP flag. + +Note that the flag \fBGNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_DISTRUSTED\fP is +specific to p11\-kit trust modules. +.SH "RETURNS" +If the certificate exists non\-zero is returned, otherwise zero. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_deinit.3 b/doc/manpages/gnutls_pkcs11_deinit.3 new file mode 100644 index 0000000..cb709e4 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_deinit.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "void gnutls_pkcs11_deinit( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +This function will deinitialize the PKCS 11 subsystem in gnutls. +This function is only needed if you need to deinitialize the +subsystem without calling \fBgnutls_global_deinit()\fP. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_delete_url.3 b/doc/manpages/gnutls_pkcs11_delete_url.3 new file mode 100644 index 0000000..21f9258 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_delete_url.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_delete_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_delete_url \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_delete_url(const char * " object_url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * object_url" 12 +The URL of the object to delete. +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +This function will delete objects matching the given URL. +Note that not all tokens support the delete operation. +.SH "RETURNS" +On success, the number of objects deleted is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_get_pin_function.3 b/doc/manpages/gnutls_pkcs11_get_pin_function.3 new file mode 100644 index 0000000..1896cf1 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_get_pin_function.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_get_pin_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_get_pin_function \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "gnutls_pin_callback_t gnutls_pkcs11_get_pin_function(void ** " userdata ");" +.SH ARGUMENTS +.IP "void ** userdata" 12 +data to be supplied to callback +.SH "DESCRIPTION" +This function will return the callback function set using +\fBgnutls_pkcs11_set_pin_function()\fP. +.SH "RETURNS" +The function set or NULL otherwise. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_get_raw_issuer.3 b/doc/manpages/gnutls_pkcs11_get_raw_issuer.3 new file mode 100644 index 0000000..868b138 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_get_raw_issuer.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_get_raw_issuer" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_get_raw_issuer \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_get_raw_issuer(const char * " url ", gnutls_x509_crt_t " cert ", gnutls_datum_t * " issuer ", gnutls_x509_crt_fmt_t " fmt ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +A PKCS 11 url identifying a token +.IP "gnutls_x509_crt_t cert" 12 +is the certificate to find issuer for +.IP "gnutls_datum_t * issuer" 12 +Will hold the issuer if any in an allocated buffer. +.IP "gnutls_x509_crt_fmt_t fmt" 12 +The format of the exported issuer. +.IP "unsigned int flags" 12 +Use zero or flags from \fBGNUTLS_PKCS11_OBJ_FLAG\fP. +.SH "DESCRIPTION" +This function will return the issuer of a given certificate, if it +is stored in the token. By default only marked as trusted issuers +are returned. If any issuer should be returned specify +\fBGNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_ANY\fP in \fIflags\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.2.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_get_raw_issuer_by_dn.3 b/doc/manpages/gnutls_pkcs11_get_raw_issuer_by_dn.3 new file mode 100644 index 0000000..0afe167 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_get_raw_issuer_by_dn.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_get_raw_issuer_by_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_get_raw_issuer_by_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_get_raw_issuer_by_dn(const char * " url ", const gnutls_datum_t * " dn ", gnutls_datum_t * " issuer ", gnutls_x509_crt_fmt_t " fmt ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +A PKCS 11 url identifying a token +.IP "const gnutls_datum_t * dn" 12 +is the DN to search for +.IP "gnutls_datum_t * issuer" 12 +Will hold the issuer if any in an allocated buffer. +.IP "gnutls_x509_crt_fmt_t fmt" 12 +The format of the exported issuer. +.IP "unsigned int flags" 12 +Use zero or flags from \fBGNUTLS_PKCS11_OBJ_FLAG\fP. +.SH "DESCRIPTION" +This function will return the certificate with the given DN, if it +is stored in the token. By default only marked as trusted issuers +are returned. If any issuer should be returned specify +\fBGNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_ANY\fP in \fIflags\fP . + +The name of the function includes issuer because it can +be used to discover issuers of certificates. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_get_raw_issuer_by_subject_key_id.3 b/doc/manpages/gnutls_pkcs11_get_raw_issuer_by_subject_key_id.3 new file mode 100644 index 0000000..a461f61 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_get_raw_issuer_by_subject_key_id.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_get_raw_issuer_by_subject_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_get_raw_issuer_by_subject_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_get_raw_issuer_by_subject_key_id(const char * " url ", const gnutls_datum_t * " dn ", const gnutls_datum_t * " spki ", gnutls_datum_t * " issuer ", gnutls_x509_crt_fmt_t " fmt ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +A PKCS 11 url identifying a token +.IP "const gnutls_datum_t * dn" 12 +is the DN to search for (may be \fBNULL\fP) +.IP "const gnutls_datum_t * spki" 12 +is the subject key ID to search for +.IP "gnutls_datum_t * issuer" 12 +Will hold the issuer if any in an allocated buffer. +.IP "gnutls_x509_crt_fmt_t fmt" 12 +The format of the exported issuer. +.IP "unsigned int flags" 12 +Use zero or flags from \fBGNUTLS_PKCS11_OBJ_FLAG\fP. +.SH "DESCRIPTION" +This function will return the certificate with the given DN and \fIspki\fP , if it +is stored in the token. By default only marked as trusted issuers +are returned. If any issuer should be returned specify +\fBGNUTLS_PKCS11_OBJ_FLAG_RETRIEVE_ANY\fP in \fIflags\fP . + +The name of the function includes issuer because it can +be used to discover issuers of certificates. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_init.3 b/doc/manpages/gnutls_pkcs11_init.3 new file mode 100644 index 0000000..e961559 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_init.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_init \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_init(unsigned int " flags ", const char * " deprecated_config_file ");" +.SH ARGUMENTS +.IP "unsigned int flags" 12 +An ORed sequence of \fBGNUTLS_PKCS11_FLAG_\fP* +.IP "const char * deprecated_config_file" 12 +either NULL or the location of a deprecated +configuration file +.SH "DESCRIPTION" +This function will initialize the PKCS 11 subsystem in gnutls. It will +read configuration files if \fBGNUTLS_PKCS11_FLAG_AUTO\fP is used or allow +you to independently load PKCS 11 modules using \fBgnutls_pkcs11_add_provider()\fP +if \fBGNUTLS_PKCS11_FLAG_MANUAL\fP is specified. + +You don't need to call this function since GnuTLS 3.3.0 because it is being called +during the first request PKCS 11 operation. That call will assume the \fBGNUTLS_PKCS11_FLAG_AUTO\fP +flag. If another flags are required then it must be called independently +prior to any PKCS 11 operation. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_deinit.3 b/doc/manpages/gnutls_pkcs11_obj_deinit.3 new file mode 100644 index 0000000..648fa22 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "void gnutls_pkcs11_obj_deinit(gnutls_pkcs11_obj_t " obj ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +The type to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a certificate structure. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_export.3 b/doc/manpages/gnutls_pkcs11_obj_export.3 new file mode 100644 index 0000000..72dff61 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_export.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_export \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_export(gnutls_pkcs11_obj_t " obj ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +Holds the object +.IP "void * output_data" 12 +will contain the object data +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the PKCS11 object data. It is normal for +data to be inaccessible and in that case \fBGNUTLS_E_INVALID_REQUEST\fP +will be returned. + +If the buffer provided is not long enough to hold the output, then +*output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will +be returned. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_export2.3 b/doc/manpages/gnutls_pkcs11_obj_export2.3 new file mode 100644 index 0000000..fb9e9f1 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_export2.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_export2(gnutls_pkcs11_obj_t " obj ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +Holds the object +.IP "gnutls_datum_t * out" 12 +will contain the object data +.SH "DESCRIPTION" +This function will export the PKCS11 object data. It is normal for +data to be inaccessible and in that case \fBGNUTLS_E_INVALID_REQUEST\fP +will be returned. + +The output buffer is allocated using \fBgnutls_malloc()\fP. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_export3.3 b/doc/manpages/gnutls_pkcs11_obj_export3.3 new file mode 100644 index 0000000..83ed060 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_export3.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_export3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_export3 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_export3(gnutls_pkcs11_obj_t " obj ", gnutls_x509_crt_fmt_t " fmt ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +Holds the object +.IP "gnutls_x509_crt_fmt_t fmt" 12 +The format of the exported data +.IP "gnutls_datum_t * out" 12 +will contain the object data +.SH "DESCRIPTION" +This function will export the PKCS11 object data. It is normal for +data to be inaccessible and in that case \fBGNUTLS_E_INVALID_REQUEST\fP +will be returned. + +The output buffer is allocated using \fBgnutls_malloc()\fP. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH "SINCE" +3.2.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_export_url.3 b/doc/manpages/gnutls_pkcs11_obj_export_url.3 new file mode 100644 index 0000000..e1564f5 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_export_url.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_export_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_export_url \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_export_url(gnutls_pkcs11_obj_t " obj ", gnutls_pkcs11_url_type_t " detailed ", char ** " url ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +Holds the PKCS 11 certificate +.IP "gnutls_pkcs11_url_type_t detailed" 12 +non zero if a detailed URL is required +.IP "char ** url" 12 +will contain an allocated url +.SH "DESCRIPTION" +This function will export a URL identifying the given object. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_flags_get_str.3 b/doc/manpages/gnutls_pkcs11_obj_flags_get_str.3 new file mode 100644 index 0000000..acf61fe --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_flags_get_str.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_flags_get_str" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_flags_get_str \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "char * gnutls_pkcs11_obj_flags_get_str(unsigned int " flags ");" +.SH ARGUMENTS +.IP "unsigned int flags" 12 +holds the flags +.SH "DESCRIPTION" +This function given an or\-sequence of \fBGNUTLS_PKCS11_OBJ_FLAG_MARK\fP, +will return an allocated string with its description. The string +needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +If flags is zero \fBNULL\fP is returned, otherwise an allocated string. +.SH "SINCE" +3.3.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_get_exts.3 b/doc/manpages/gnutls_pkcs11_obj_get_exts.3 new file mode 100644 index 0000000..95b54a2 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_get_exts.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_get_exts" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_get_exts \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_get_exts(gnutls_pkcs11_obj_t " obj ", gnutls_x509_ext_st ** " exts ", unsigned int * " exts_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +should contain a \fBgnutls_pkcs11_obj_t\fP type +.IP "gnutls_x509_ext_st ** exts" 12 +a pointer to a \fBgnutls_x509_ext_st\fP pointer +.IP "unsigned int * exts_size" 12 +will be updated with the number of \fIexts\fP +.IP "unsigned int flags" 12 +Or sequence of \fBGNUTLS_PKCS11_OBJ_\fP* flags +.SH "DESCRIPTION" +This function will return information about attached extensions +that associate to the provided object (which should be a certificate). +The extensions are the attached p11\-kit trust module extensions. + +Each element of \fIexts\fP must be deinitialized using \fBgnutls_x509_ext_deinit()\fP +while \fIexts\fP should be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error code on error. +.SH "SINCE" +3.3.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_get_flags.3 b/doc/manpages/gnutls_pkcs11_obj_get_flags.3 new file mode 100644 index 0000000..0a4b62c --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_get_flags.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_get_flags" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_get_flags \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_get_flags(gnutls_pkcs11_obj_t " obj ", unsigned int * " oflags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +The pkcs11 object +.IP "unsigned int * oflags" 12 +Will hold the output flags +.SH "DESCRIPTION" +This function will return the flags of the object. +The \fIoflags\fP will be flags from \fBgnutls_pkcs11_obj_flags\fP. That is, +the \fBGNUTLS_PKCS11_OBJ_FLAG_MARK_\fP* flags. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_get_info.3 b/doc/manpages/gnutls_pkcs11_obj_get_info.3 new file mode 100644 index 0000000..eddc8fa --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_get_info.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_get_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_get_info \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_get_info(gnutls_pkcs11_obj_t " obj ", gnutls_pkcs11_obj_info_t " itype ", void * " output ", size_t * " output_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +should contain a \fBgnutls_pkcs11_obj_t\fP type +.IP "gnutls_pkcs11_obj_info_t itype" 12 +Denotes the type of information requested +.IP "void * output" 12 +where output will be stored +.IP "size_t * output_size" 12 +contains the maximum size of the output buffer and will be +overwritten with the actual size. +.SH "DESCRIPTION" +This function will return information about the PKCS11 certificate +such as the label, id as well as token information where the key is +stored. + +When output is text, a null terminated string is written to \fIoutput\fP and its +string length is written to \fIoutput_size\fP (without null terminator). If the +buffer is too small, \fIoutput_size\fP will contain the expected buffer size +(with null terminator for text) and return \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP. + +In versions previously to 3.6.0 this function included the null terminator +to \fIoutput_size\fP . After 3.6.0 the output size doesn't include the terminator character. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error code on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_get_ptr.3 b/doc/manpages/gnutls_pkcs11_obj_get_ptr.3 new file mode 100644 index 0000000..f451ace --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_get_ptr.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_get_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_get_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_get_ptr(gnutls_pkcs11_obj_t " obj ", void ** " ptr ", void ** " session ", void ** " ohandle ", unsigned long * " slot_id ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +should contain a \fBgnutls_pkcs11_obj_t\fP type +.IP "void ** ptr" 12 +will contain the CK_FUNCTION_LIST_PTR pointer (may be \fBNULL\fP) +.IP "void ** session" 12 +will contain the CK_SESSION_HANDLE of the object +.IP "void ** ohandle" 12 +will contain the CK_OBJECT_HANDLE of the object +.IP "unsigned long * slot_id" 12 +the identifier of the slot (may be \fBNULL\fP) +.IP "unsigned int flags" 12 +Or sequence of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +Obtains the PKCS\fB11\fP session handles of an object. \fIsession\fP and \fIohandle\fP must be deinitialized by the caller. The returned pointers are +independent of the \fIobj\fP lifetime. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error code +on error. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_get_type.3 b/doc/manpages/gnutls_pkcs11_obj_get_type.3 new file mode 100644 index 0000000..be50965 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_get_type.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_get_type" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_get_type \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "gnutls_pkcs11_obj_type_t gnutls_pkcs11_obj_get_type(gnutls_pkcs11_obj_t " obj ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +Holds the PKCS 11 object +.SH "DESCRIPTION" +This function will return the type of the object being +stored in the structure. +.SH "RETURNS" +The type of the object +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_import_url.3 b/doc/manpages/gnutls_pkcs11_obj_import_url.3 new file mode 100644 index 0000000..e929ca1 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_import_url.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_import_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_import_url \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_import_url(gnutls_pkcs11_obj_t " obj ", const char * " url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +The structure to store the object +.IP "const char * url" 12 +a PKCS 11 url identifying the key +.IP "unsigned int flags" 12 +Or sequence of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +This function will "import" a PKCS 11 URL identifying an object (e.g. certificate) +to the \fBgnutls_pkcs11_obj_t\fP type. This does not involve any +parsing (such as X.509 or OpenPGP) since the \fBgnutls_pkcs11_obj_t\fP is +format agnostic. Only data are transferred. + +If the flag \fBGNUTLS_PKCS11_OBJ_FLAG_OVERWRITE_TRUSTMOD_EXT\fP is specified +any certificate read, will have its extensions overwritten by any +stapled extensions in the trust module. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_init.3 b/doc/manpages/gnutls_pkcs11_obj_init.3 new file mode 100644 index 0000000..801ec33 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_init \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_init(gnutls_pkcs11_obj_t * " obj ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t * obj" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a pkcs11 certificate structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_list_import_url3.3 b/doc/manpages/gnutls_pkcs11_obj_list_import_url3.3 new file mode 100644 index 0000000..fdde5bb --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_list_import_url3.3 @@ -0,0 +1,63 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_list_import_url3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_list_import_url3 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_list_import_url3(gnutls_pkcs11_obj_t * " p_list ", unsigned int * " n_list ", const char * " url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t * p_list" 12 +An uninitialized object list (may be \fBNULL\fP) +.IP "unsigned int * n_list" 12 +Initially should hold the maximum size of the list. Will contain the actual size. +.IP "const char * url" 12 +A PKCS 11 url identifying a set of objects +.IP "unsigned int flags" 12 +Or sequence of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +This function will initialize and set values to an object list +by using all objects identified by a PKCS 11 URL. + +This function will enumerate all the objects specified by the PKCS\fB11\fP URL +provided. It expects an already allocated \fIp_list\fP which has * \fIn_list\fP elements, +and that value will be updated to the actual number of present objects. The + \fIp_list\fP objects will be initialized and set by this function. +To obtain a list of all available objects use a \fIurl\fP of 'pkcs11:'. + +All returned objects must be deinitialized using \fBgnutls_pkcs11_obj_deinit()\fP. + +The supported in this function \fIflags\fP are \fBGNUTLS_PKCS11_OBJ_FLAG_LOGIN\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_LOGIN_SO\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_PRESENT_IN_TRUSTED_MODULE\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_CRT\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_PUBKEY\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_PRIVKEY\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_WITH_PRIVKEY\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_MARK_CA\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED\fP, and since 3.5.1 the \fBGNUTLS_PKCS11_OBJ_FLAG_OVERWRITE_TRUSTMOD_EXT\fP. + +On versions of GnuTLS prior to 3.4.0 the equivalent function was +\fBgnutls_pkcs11_obj_list_import_url()\fP. That is also available on this version +as a macro which maps to this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_list_import_url4.3 b/doc/manpages/gnutls_pkcs11_obj_list_import_url4.3 new file mode 100644 index 0000000..b7b6e81 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_list_import_url4.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_list_import_url4" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_list_import_url4 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_list_import_url4(gnutls_pkcs11_obj_t ** " p_list ", unsigned int * " n_list ", const char * " url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t ** p_list" 12 +An uninitialized object list (may be NULL) +.IP "unsigned int * n_list" 12 +It will contain the size of the list. +.IP "const char * url" 12 +A PKCS 11 url identifying a set of objects +.IP "unsigned int flags" 12 +Or sequence of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +This function will enumerate all the objects specified by the PKCS\fB11\fP URL +provided. It will initialize and set values to the object pointer list ( \fIp_list\fP ) +provided. To obtain a list of all available objects use a \fIurl\fP of 'pkcs11:'. + +All returned objects must be deinitialized using \fBgnutls_pkcs11_obj_deinit()\fP, +and \fIp_list\fP must be deinitialized using \fBgnutls_free()\fP. + +The supported in this function \fIflags\fP are \fBGNUTLS_PKCS11_OBJ_FLAG_LOGIN\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_LOGIN_SO\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_PRESENT_IN_TRUSTED_MODULE\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_CRT\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_PUBKEY\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_PRIVKEY\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_WITH_PRIVKEY\fP, \fBGNUTLS_PKCS11_OBJ_FLAG_MARK_CA\fP, +\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_TRUSTED\fP, and since 3.5.1 the \fBGNUTLS_PKCS11_OBJ_FLAG_OVERWRITE_TRUSTMOD_EXT\fP. + +On versions of GnuTLS prior to 3.4.0 the equivalent function was +\fBgnutls_pkcs11_obj_list_import_url2()\fP. That is also available on this version +as a macro which maps to this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_set_info.3 b/doc/manpages/gnutls_pkcs11_obj_set_info.3 new file mode 100644 index 0000000..797f6b2 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_set_info.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_set_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_set_info \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_obj_set_info(gnutls_pkcs11_obj_t " obj ", gnutls_pkcs11_obj_info_t " itype ", const void * " data ", size_t " data_size ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +should contain a \fBgnutls_pkcs11_obj_t\fP type +.IP "gnutls_pkcs11_obj_info_t itype" 12 +Denotes the type of information to be set +.IP "const void * data" 12 +the data to set +.IP "size_t data_size" 12 +the size of data +.IP "unsigned flags" 12 +Or sequence of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +This function will set attributes on the provided object. +Available options for \fIitype\fP are \fBGNUTLS_PKCS11_OBJ_LABEL\fP, +\fBGNUTLS_PKCS11_OBJ_ID_HEX\fP, and \fBGNUTLS_PKCS11_OBJ_ID\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error code on error. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_obj_set_pin_function.3 b/doc/manpages/gnutls_pkcs11_obj_set_pin_function.3 new file mode 100644 index 0000000..57e8ca5 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_set_pin_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_set_pin_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_set_pin_function \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "void gnutls_pkcs11_obj_set_pin_function(gnutls_pkcs11_obj_t " obj ", gnutls_pin_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +The object structure +.IP "gnutls_pin_callback_t fn" 12 +the callback +.IP "void * userdata" 12 +data associated with the callback +.SH "DESCRIPTION" +This function will set a callback function to be used when +required to access the object. This function overrides the global +set using \fBgnutls_pkcs11_set_pin_function()\fP. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_cpy.3 b/doc/manpages/gnutls_pkcs11_privkey_cpy.3 new file mode 100644 index 0000000..8df1dab --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_cpy.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_cpy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_cpy \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_cpy(gnutls_pkcs11_privkey_t " dst ", gnutls_pkcs11_privkey_t " src ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t dst" 12 +The destination key, which should be initialized. +.IP "gnutls_pkcs11_privkey_t src" 12 +The source key +.SH "DESCRIPTION" +This function will copy a private key from source to destination +key. Destination has to be initialized. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_deinit.3 b/doc/manpages/gnutls_pkcs11_privkey_deinit.3 new file mode 100644 index 0000000..e8e43dd --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "void gnutls_pkcs11_privkey_deinit(gnutls_pkcs11_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t key" 12 +the key to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a private key structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_export_pubkey.3 b/doc/manpages/gnutls_pkcs11_privkey_export_pubkey.3 new file mode 100644 index 0000000..186f4c0 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_export_pubkey.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_export_pubkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_export_pubkey \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_export_pubkey(gnutls_pkcs11_privkey_t " pkey ", gnutls_x509_crt_fmt_t " fmt ", gnutls_datum_t * " data ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t pkey" 12 +The private key +.IP "gnutls_x509_crt_fmt_t fmt" 12 +the format of output params. PEM or DER. +.IP "gnutls_datum_t * data" 12 +will hold the public key +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will extract the public key (modulus and public +exponent) from the private key specified by the \fIurl\fP private key. +This public key will be stored in \fIpubkey\fP in the format specified +by \fIfmt\fP . \fIpubkey\fP should be deinitialized using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_export_url.3 b/doc/manpages/gnutls_pkcs11_privkey_export_url.3 new file mode 100644 index 0000000..3f93971 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_export_url.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_export_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_export_url \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_export_url(gnutls_pkcs11_privkey_t " key ", gnutls_pkcs11_url_type_t " detailed ", char ** " url ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t key" 12 +Holds the PKCS 11 key +.IP "gnutls_pkcs11_url_type_t detailed" 12 +non zero if a detailed URL is required +.IP "char ** url" 12 +will contain an allocated url +.SH "DESCRIPTION" +This function will export a URL identifying the given key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_generate.3 b/doc/manpages/gnutls_pkcs11_privkey_generate.3 new file mode 100644 index 0000000..dc5dd9f --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_generate.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_generate" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_generate \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_generate(const char * " url ", gnutls_pk_algorithm_t " pk ", unsigned int " bits ", const char * " label ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +a token URL +.IP "gnutls_pk_algorithm_t pk" 12 +the public key algorithm +.IP "unsigned int bits" 12 +the security bits +.IP "const char * label" 12 +a label +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will generate a private key in the specified +by the \fIurl\fP token. The private key will be generate within +the token and will not be exportable. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_generate2.3 b/doc/manpages/gnutls_pkcs11_privkey_generate2.3 new file mode 100644 index 0000000..cd20096 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_generate2.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_generate2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_generate2 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_generate2(const char * " url ", gnutls_pk_algorithm_t " pk ", unsigned int " bits ", const char * " label ", gnutls_x509_crt_fmt_t " fmt ", gnutls_datum_t * " pubkey ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +a token URL +.IP "gnutls_pk_algorithm_t pk" 12 +the public key algorithm +.IP "unsigned int bits" 12 +the security bits +.IP "const char * label" 12 +a label +.IP "gnutls_x509_crt_fmt_t fmt" 12 +the format of output params. PEM or DER +.IP "gnutls_datum_t * pubkey" 12 +will hold the public key (may be \fBNULL\fP) +.IP "unsigned int flags" 12 +zero or an OR'ed sequence of \fBGNUTLS_PKCS11_OBJ_FLAGs\fP +.SH "DESCRIPTION" +This function will generate a private key in the specified +by the \fIurl\fP token. The private key will be generate within +the token and will not be exportable. This function will +store the DER\-encoded public key in the SubjectPublicKeyInfo format +in \fIpubkey\fP . The \fIpubkey\fP should be deinitialized using \fBgnutls_free()\fP. + +Note that when generating an elliptic curve key, the curve +can be substituted in the place of the bits parameter using the +\fBGNUTLS_CURVE_TO_BITS()\fP macro. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_generate3.3 b/doc/manpages/gnutls_pkcs11_privkey_generate3.3 new file mode 100644 index 0000000..c400c93 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_generate3.3 @@ -0,0 +1,65 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_generate3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_generate3 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_generate3(const char * " url ", gnutls_pk_algorithm_t " pk ", unsigned int " bits ", const char * " label ", const gnutls_datum_t * " cid ", gnutls_x509_crt_fmt_t " fmt ", gnutls_datum_t * " pubkey ", unsigned int " key_usage ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +a token URL +.IP "gnutls_pk_algorithm_t pk" 12 +the public key algorithm +.IP "unsigned int bits" 12 +the security bits +.IP "const char * label" 12 +a label +.IP "const gnutls_datum_t * cid" 12 +The CKA_ID to use for the new object +.IP "gnutls_x509_crt_fmt_t fmt" 12 +the format of output params. PEM or DER +.IP "gnutls_datum_t * pubkey" 12 +will hold the public key (may be \fBNULL\fP) +.IP "unsigned int key_usage" 12 +One of GNUTLS_KEY_* +.IP "unsigned int flags" 12 +zero or an OR'ed sequence of \fBGNUTLS_PKCS11_OBJ_FLAGs\fP +.SH "DESCRIPTION" +This function will generate a private key in the specified +by the \fIurl\fP token. The private key will be generate within +the token and will not be exportable. This function will +store the DER\-encoded public key in the SubjectPublicKeyInfo format +in \fIpubkey\fP . The \fIpubkey\fP should be deinitialized using \fBgnutls_free()\fP. + +Note that when generating an elliptic curve key, the curve +can be substituted in the place of the bits parameter using the +\fBGNUTLS_CURVE_TO_BITS()\fP macro. + +Since 3.6.3 the objects are marked as sensitive by default unless +\fBGNUTLS_PKCS11_OBJ_FLAG_MARK_NOT_SENSITIVE\fP is specified. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_get_info.3 b/doc/manpages/gnutls_pkcs11_privkey_get_info.3 new file mode 100644 index 0000000..4c900aa --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_get_info.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_get_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_get_info \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_get_info(gnutls_pkcs11_privkey_t " pkey ", gnutls_pkcs11_obj_info_t " itype ", void * " output ", size_t * " output_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t pkey" 12 +should contain a \fBgnutls_pkcs11_privkey_t\fP type +.IP "gnutls_pkcs11_obj_info_t itype" 12 +Denotes the type of information requested +.IP "void * output" 12 +where output will be stored +.IP "size_t * output_size" 12 +contains the maximum size of the output and will be overwritten with actual +.SH "DESCRIPTION" +This function will return information about the PKCS 11 private key such +as the label, id as well as token information where the key is stored. When +output is text it returns null terminated string although \fBoutput_size\fP contains +the size of the actual data only. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_get_pk_algorithm.3 b/doc/manpages/gnutls_pkcs11_privkey_get_pk_algorithm.3 new file mode 100644 index 0000000..d601640 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_get_pk_algorithm.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_get_pk_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_get_pk_algorithm(gnutls_pkcs11_privkey_t " key ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t key" 12 +should contain a \fBgnutls_pkcs11_privkey_t\fP type +.IP "unsigned int * bits" 12 +if bits is non null it will hold the size of the parameters' in bits +.SH "DESCRIPTION" +This function will return the public key algorithm of a private +key. +.SH "RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_import_url.3 b/doc/manpages/gnutls_pkcs11_privkey_import_url.3 new file mode 100644 index 0000000..d92811a --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_import_url.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_import_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_import_url \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_import_url(gnutls_pkcs11_privkey_t " pkey ", const char * " url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t pkey" 12 +The private key +.IP "const char * url" 12 +a PKCS 11 url identifying the key +.IP "unsigned int flags" 12 +Or sequence of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +This function will "import" a PKCS 11 URL identifying a private +key to the \fBgnutls_pkcs11_privkey_t\fP type. In reality since +in most cases keys cannot be exported, the private key structure +is being associated with the available operations on the token. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_init.3 b/doc/manpages/gnutls_pkcs11_privkey_init.3 new file mode 100644 index 0000000..ec98315 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_init.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_init \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_privkey_init(gnutls_pkcs11_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t * key" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize an private key structure. This +structure can be used for accessing an underlying PKCS\fB11\fP object. + +In versions of GnuTLS later than 3.5.11 the object is protected +using locks and a single \fBgnutls_pkcs11_privkey_t\fP can be re\-used +by many threads. However, for performance it is recommended to utilize +one object per key per thread. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_set_pin_function.3 b/doc/manpages/gnutls_pkcs11_privkey_set_pin_function.3 new file mode 100644 index 0000000..72c633c --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_set_pin_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_set_pin_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_set_pin_function \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "void gnutls_pkcs11_privkey_set_pin_function(gnutls_pkcs11_privkey_t " key ", gnutls_pin_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t key" 12 +The private key +.IP "gnutls_pin_callback_t fn" 12 +the callback +.IP "void * userdata" 12 +data associated with the callback +.SH "DESCRIPTION" +This function will set a callback function to be used when +required to access the object. This function overrides the global +set using \fBgnutls_pkcs11_set_pin_function()\fP. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_privkey_status.3 b/doc/manpages/gnutls_pkcs11_privkey_status.3 new file mode 100644 index 0000000..134d8ff --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_status.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_status \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "unsigned gnutls_pkcs11_privkey_status(gnutls_pkcs11_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t key" 12 +Holds the key +.SH "DESCRIPTION" +Checks the status of the private key token. +.SH "RETURNS" +this function will return non\-zero if the token +holding the private key is still available (inserted), and zero otherwise. +.SH "SINCE" +3.1.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_reinit.3 b/doc/manpages/gnutls_pkcs11_reinit.3 new file mode 100644 index 0000000..80e374e --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_reinit.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_reinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_reinit \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_reinit( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +This function will reinitialize the PKCS 11 subsystem in gnutls. +This is required by PKCS 11 when an application uses \fBfork()\fP. The +reinitialization function must be called on the child. + +Note that since GnuTLS 3.3.0, the reinitialization of the PKCS \fB11\fP +subsystem occurs automatically after fork. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_set_pin_function.3 b/doc/manpages/gnutls_pkcs11_set_pin_function.3 new file mode 100644 index 0000000..a07d05a --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_set_pin_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_set_pin_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_set_pin_function \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "void gnutls_pkcs11_set_pin_function(gnutls_pin_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_pin_callback_t fn" 12 +The PIN callback, a \fBgnutls_pin_callback_t()\fP function. +.IP "void * userdata" 12 +data to be supplied to callback +.SH "DESCRIPTION" +This function will set a callback function to be used when a PIN is +required for PKCS 11 operations. See +\fBgnutls_pin_callback_t()\fP on how the callback should behave. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_set_token_function.3 b/doc/manpages/gnutls_pkcs11_set_token_function.3 new file mode 100644 index 0000000..ee0b208 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_set_token_function.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_set_token_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_set_token_function \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "void gnutls_pkcs11_set_token_function(gnutls_pkcs11_token_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_token_callback_t fn" 12 +The token callback +.IP "void * userdata" 12 +data to be supplied to callback +.SH "DESCRIPTION" +This function will set a callback function to be used when a token +needs to be inserted to continue PKCS 11 operations. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_token_check_mechanism.3 b/doc/manpages/gnutls_pkcs11_token_check_mechanism.3 new file mode 100644 index 0000000..d88c273 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_check_mechanism.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_check_mechanism" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_check_mechanism \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "unsigned gnutls_pkcs11_token_check_mechanism(const char * " url ", unsigned long " mechanism ", void * " ptr ", unsigned " psize ", unsigned " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +should contain a PKCS 11 URL +.IP "unsigned long mechanism" 12 +The PKCS \fB11\fP mechanism ID +.IP "void * ptr" 12 +if set it should point to a CK_MECHANISM_INFO struct +.IP "unsigned psize" 12 +the size of CK_MECHANISM_INFO struct (for safety) +.IP "unsigned flags" 12 +must be zero +.SH "DESCRIPTION" +This function will return whether a mechanism is supported +by the given token. If the mechanism is supported and + \fIptr\fP is set, it will be updated with the token information. +.SH "RETURNS" +Non\-zero if the mechanism is supported or zero otherwise. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_token_get_flags.3 b/doc/manpages/gnutls_pkcs11_token_get_flags.3 new file mode 100644 index 0000000..6d7536f --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_flags.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_flags" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_flags \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_token_get_flags(const char * " url ", unsigned int * " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +should contain a PKCS 11 URL +.IP "unsigned int * flags" 12 +The output flags (GNUTLS_PKCS11_TOKEN_*) +.SH "DESCRIPTION" +This function will return information about the PKCS 11 token flags. + +The supported flags are: \fBGNUTLS_PKCS11_TOKEN_HW\fP and \fBGNUTLS_PKCS11_TOKEN_TRUSTED\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error code on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_token_get_info.3 b/doc/manpages/gnutls_pkcs11_token_get_info.3 new file mode 100644 index 0000000..b984e83 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_info.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_info \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_token_get_info(const char * " url ", gnutls_pkcs11_token_info_t " ttype ", void * " output ", size_t * " output_size ");" +.SH ARGUMENTS +.IP "const char * url" 12 +should contain a PKCS 11 URL +.IP "gnutls_pkcs11_token_info_t ttype" 12 +Denotes the type of information requested +.IP "void * output" 12 +where output will be stored +.IP "size_t * output_size" 12 +contains the maximum size of the output buffer and will be +overwritten with the actual size. +.SH "DESCRIPTION" +This function will return information about the PKCS 11 token such +as the label, id, etc. + +When output is text, a null terminated string is written to \fIoutput\fP and its +string length is written to \fIoutput_size\fP (without null terminator). If the +buffer is too small, \fIoutput_size\fP will contain the expected buffer size +(with null terminator for text) and return \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error code +on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_token_get_mechanism.3 b/doc/manpages/gnutls_pkcs11_token_get_mechanism.3 new file mode 100644 index 0000000..aea2275 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_mechanism.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_mechanism" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_mechanism \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_token_get_mechanism(const char * " url ", unsigned int " idx ", unsigned long * " mechanism ");" +.SH ARGUMENTS +.IP "const char * url" 12 +should contain a PKCS 11 URL +.IP "unsigned int idx" 12 +The index of the mechanism +.IP "unsigned long * mechanism" 12 +The PKCS \fB11\fP mechanism ID +.SH "DESCRIPTION" +This function will return the names of the supported mechanisms +by the token. It should be called with an increasing index until +it return GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error code on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_token_get_ptr.3 b/doc/manpages/gnutls_pkcs11_token_get_ptr.3 new file mode 100644 index 0000000..2b24afb --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_ptr.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_token_get_ptr(const char * " url ", void ** " ptr ", unsigned long * " slot_id ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * url" 12 +should contain a PKCS\fB11\fP URL identifying a token +.IP "void ** ptr" 12 +will contain the CK_FUNCTION_LIST_PTR pointer +.IP "unsigned long * slot_id" 12 +will contain the slot_id (may be \fBNULL\fP) +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will return the function pointer of the specified +token by the URL. The returned pointers are valid until +gnutls is deinitialized, c.f. \fB_global_deinit()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error code +on error. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_token_get_random.3 b/doc/manpages/gnutls_pkcs11_token_get_random.3 new file mode 100644 index 0000000..bc31e38 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_random.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_random" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_random \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_token_get_random(const char * " token_url ", void * " rnddata ", size_t " len ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "void * rnddata" 12 +A pointer to the memory area to be filled with random data +.IP "size_t len" 12 +The number of bytes of randomness to request +.SH "DESCRIPTION" +This function will get random data from the given token. +It will store rnddata and fill the memory pointed to by rnddata with +len random bytes from the token. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_token_get_url.3 b/doc/manpages/gnutls_pkcs11_token_get_url.3 new file mode 100644 index 0000000..a08819f --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_url.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_url \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_token_get_url(unsigned int " seq ", gnutls_pkcs11_url_type_t " detailed ", char ** " url ");" +.SH ARGUMENTS +.IP "unsigned int seq" 12 +sequence number starting from 0 +.IP "gnutls_pkcs11_url_type_t detailed" 12 +non zero if a detailed URL is required +.IP "char ** url" 12 +will contain an allocated url +.SH "DESCRIPTION" +This function will return the URL for each token available +in system. The url has to be released using \fBgnutls_free()\fP +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if the sequence number +exceeds the available tokens, otherwise a negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_token_init.3 b/doc/manpages/gnutls_pkcs11_token_init.3 new file mode 100644 index 0000000..0c3061d --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_init.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_init \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_token_init(const char * " token_url ", const char * " so_pin ", const char * " label ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "const char * so_pin" 12 +Security Officer's PIN +.IP "const char * label" 12 +A name to be used for the token +.SH "DESCRIPTION" +This function will initialize (format) a token. If the token is +at a factory defaults state the security officer's PIN given will be +set to be the default. Otherwise it should match the officer's PIN. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_token_set_pin.3 b/doc/manpages/gnutls_pkcs11_token_set_pin.3 new file mode 100644 index 0000000..68de452 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_set_pin.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_set_pin" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_set_pin \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_pkcs11_token_set_pin(const char * " token_url ", const char * " oldpin ", const char * " newpin ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * token_url" 12 +A PKCS \fB11\fP URL specifying a token +.IP "const char * oldpin" 12 +old user's PIN +.IP "const char * newpin" 12 +new user's PIN +.IP "unsigned int flags" 12 +one of \fBgnutls_pin_flag_t\fP. +.SH "DESCRIPTION" +This function will modify or set a user or administrator's PIN for +the given token. If it is called to set a PIN for first time +the oldpin must be \fBNULL\fP. When setting the admin's PIN with the +\fBGNUTLS_PIN_SO\fP flag, the \fIoldpin\fP value must be provided (this requirement +is relaxed after GnuTLS 3.6.5 since which the PIN will be requested if missing). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs11_type_get_name.3 b/doc/manpages/gnutls_pkcs11_type_get_name.3 new file mode 100644 index 0000000..143f275 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_type_get_name.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_type_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_type_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "const char * gnutls_pkcs11_type_get_name(gnutls_pkcs11_obj_type_t " type ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_type_t type" 12 +Holds the PKCS 11 object type, a \fBgnutls_pkcs11_obj_type_t\fP. +.SH "DESCRIPTION" +This function will return a human readable description of the +PKCS11 object type \fIobj\fP . It will return "Unknown" for unknown +types. +.SH "RETURNS" +human readable string labeling the PKCS11 object type + \fItype\fP . +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_decrypt.3 b/doc/manpages/gnutls_pkcs12_bag_decrypt.3 new file mode 100644 index 0000000..2e33ce9 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_decrypt.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_decrypt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_decrypt \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_decrypt(gnutls_pkcs12_bag_t " bag ", const char * " pass ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "const char * pass" 12 +The password used for encryption, must be ASCII. +.SH "DESCRIPTION" +This function will decrypt the given encrypted bag and return 0 on +success. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_deinit.3 b/doc/manpages/gnutls_pkcs12_bag_deinit.3 new file mode 100644 index 0000000..d9af2ee --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "void gnutls_pkcs12_bag_deinit(gnutls_pkcs12_bag_t " bag ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will deinitialize a PKCS12 Bag structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_enc_info.3 b/doc/manpages/gnutls_pkcs12_bag_enc_info.3 new file mode 100644 index 0000000..b728e09 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_enc_info.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_enc_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_enc_info \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_enc_info(gnutls_pkcs12_bag_t " bag ", unsigned int * " schema ", unsigned int * " cipher ", void * " salt ", unsigned int * " salt_size ", unsigned int * " iter_count ", char ** " oid ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "unsigned int * schema" 12 +indicate the schema as one of \fBgnutls_pkcs_encrypt_flags_t\fP +.IP "unsigned int * cipher" 12 +the cipher used as \fBgnutls_cipher_algorithm_t\fP +.IP "void * salt" 12 +PBKDF2 salt (if non\-NULL then \fIsalt_size\fP initially holds its size) +.IP "unsigned int * salt_size" 12 +PBKDF2 salt size +.IP "unsigned int * iter_count" 12 +PBKDF2 iteration count +.IP "char ** oid" 12 +if non\-NULL it will contain an allocated null\-terminated variable with the OID +.SH "DESCRIPTION" +This function will provide information on the encryption algorithms used +in an encrypted bag. If the structure algorithms +are unknown the code \fBGNUTLS_E_UNKNOWN_CIPHER_TYPE\fP will be returned, +and only \fIoid\fP , will be set. That is, \fIoid\fP will be set on encrypted bags +whether supported or not. It must be deinitialized using \fBgnutls_free()\fP. +The other variables are only set on supported structures. +.SH "RETURNS" +\fBGNUTLS_E_INVALID_REQUEST\fP if the provided bag isn't encrypted, +\fBGNUTLS_E_UNKNOWN_CIPHER_TYPE\fP if the structure's encryption isn't supported, or +another negative error code in case of a failure. Zero on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_encrypt.3 b/doc/manpages/gnutls_pkcs12_bag_encrypt.3 new file mode 100644 index 0000000..6f4e113 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_encrypt.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_encrypt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_encrypt \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_encrypt(gnutls_pkcs12_bag_t " bag ", const char * " pass ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "const char * pass" 12 +The password used for encryption, must be ASCII +.IP "unsigned int flags" 12 +should be one of \fBgnutls_pkcs_encrypt_flags_t\fP elements bitwise or'd +.SH "DESCRIPTION" +This function will encrypt the given bag. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_get_count.3 b/doc/manpages/gnutls_pkcs12_bag_get_count.3 new file mode 100644 index 0000000..c466137 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_count.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_count" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_count \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_get_count(gnutls_pkcs12_bag_t " bag ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.SH "DESCRIPTION" +This function will return the number of the elements within the bag. +.SH "RETURNS" +Number of elements in bag, or an negative error code on +error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_get_data.3 b/doc/manpages/gnutls_pkcs12_bag_get_data.3 new file mode 100644 index 0000000..a078552 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_data.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_data \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_get_data(gnutls_pkcs12_bag_t " bag ", unsigned " indx ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "unsigned indx" 12 +The element of the bag to get the data from +.IP "gnutls_datum_t * data" 12 +where the bag's data will be. Should be treated as constant. +.SH "DESCRIPTION" +This function will return the bag's data. The data is a constant +that is stored into the bag. Should not be accessed after the bag +is deleted. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_get_friendly_name.3 b/doc/manpages/gnutls_pkcs12_bag_get_friendly_name.3 new file mode 100644 index 0000000..87f7b8b --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_friendly_name.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_friendly_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_friendly_name \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_get_friendly_name(gnutls_pkcs12_bag_t " bag ", unsigned " indx ", char ** " name ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "unsigned indx" 12 +The bag's element to add the id +.IP "char ** name" 12 +will hold a pointer to the name (to be treated as const) +.SH "DESCRIPTION" +This function will return the friendly name, of the specified bag +element. The key ID is usually used to distinguish the local +private key and the certificate pair. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_get_key_id.3 b/doc/manpages/gnutls_pkcs12_bag_get_key_id.3 new file mode 100644 index 0000000..153ec54 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_key_id.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_get_key_id(gnutls_pkcs12_bag_t " bag ", unsigned " indx ", gnutls_datum_t * " id ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "unsigned indx" 12 +The bag's element to add the id +.IP "gnutls_datum_t * id" 12 +where the ID will be copied (to be treated as const) +.SH "DESCRIPTION" +This function will return the key ID, of the specified bag element. +The key ID is usually used to distinguish the local private key and +the certificate pair. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_get_type.3 b/doc/manpages/gnutls_pkcs12_bag_get_type.3 new file mode 100644 index 0000000..0e0237c --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_type.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_type" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_type \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_get_type(gnutls_pkcs12_bag_t " bag ", unsigned " indx ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "unsigned indx" 12 +The element of the bag to get the type +.SH "DESCRIPTION" +This function will return the bag's type. +.SH "RETURNS" +On error a negative error value or one of the \fBgnutls_pkcs12_bag_type_t\fP enumerations. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_init.3 b/doc/manpages/gnutls_pkcs12_bag_init.3 new file mode 100644 index 0000000..361aa3f --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_init \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_init(gnutls_pkcs12_bag_t * " bag ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t * bag" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a PKCS12 bag structure. PKCS12 Bags +usually contain private keys, lists of X.509 Certificates and X.509 +Certificate revocation lists. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_set_crl.3 b/doc/manpages/gnutls_pkcs12_bag_set_crl.3 new file mode 100644 index 0000000..a13fb47 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_crl.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_crl" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_crl \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_set_crl(gnutls_pkcs12_bag_t " bag ", gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "gnutls_x509_crl_t crl" 12 +the CRL to be copied. +.SH "DESCRIPTION" +This function will insert the given CRL into the +bag. This is just a wrapper over \fBgnutls_pkcs12_bag_set_data()\fP. +.SH "RETURNS" +the index of the added bag on success, or a negative error code +on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_set_crt.3 b/doc/manpages/gnutls_pkcs12_bag_set_crt.3 new file mode 100644 index 0000000..4e90ce2 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_crt.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_set_crt(gnutls_pkcs12_bag_t " bag ", gnutls_x509_crt_t " crt ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "gnutls_x509_crt_t crt" 12 +the certificate to be copied. +.SH "DESCRIPTION" +This function will insert the given certificate into the +bag. This is just a wrapper over \fBgnutls_pkcs12_bag_set_data()\fP. +.SH "RETURNS" +the index of the added bag on success, or a negative +value on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_set_data.3 b/doc/manpages/gnutls_pkcs12_bag_set_data.3 new file mode 100644 index 0000000..fb63f04 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_data.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_data \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_set_data(gnutls_pkcs12_bag_t " bag ", gnutls_pkcs12_bag_type_t " type ", const gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "gnutls_pkcs12_bag_type_t type" 12 +The data's type +.IP "const gnutls_datum_t * data" 12 +the data to be copied. +.SH "DESCRIPTION" +This function will insert the given data of the given type into +the bag. +.SH "RETURNS" +the index of the added bag on success, or a negative +value on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_set_friendly_name.3 b/doc/manpages/gnutls_pkcs12_bag_set_friendly_name.3 new file mode 100644 index 0000000..0c6c38b --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_friendly_name.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_friendly_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_friendly_name \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_set_friendly_name(gnutls_pkcs12_bag_t " bag ", unsigned " indx ", const char * " name ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "unsigned indx" 12 +The bag's element to add the id +.IP "const char * name" 12 +the name +.SH "DESCRIPTION" +This function will add the given key friendly name, to the +specified, by the index, bag element. The name will be encoded as +a 'Friendly name' bag attribute, which is usually used to set a +user name to the local private key and the certificate pair. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_set_key_id.3 b/doc/manpages/gnutls_pkcs12_bag_set_key_id.3 new file mode 100644 index 0000000..b6a8424 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_key_id.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_set_key_id(gnutls_pkcs12_bag_t " bag ", unsigned " indx ", const gnutls_datum_t * " id ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "unsigned indx" 12 +The bag's element to add the id +.IP "const gnutls_datum_t * id" 12 +the ID +.SH "DESCRIPTION" +This function will add the given key ID, to the specified, by the +index, bag element. The key ID will be encoded as a 'Local key +identifier' bag attribute, which is usually used to distinguish +the local private key and the certificate pair. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_bag_set_privkey.3 b/doc/manpages/gnutls_pkcs12_bag_set_privkey.3 new file mode 100644 index 0000000..0cbe5fb --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_privkey.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_privkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_privkey \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_bag_set_privkey(gnutls_pkcs12_bag_t " bag ", gnutls_x509_privkey_t " privkey ", const char * " password ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "gnutls_x509_privkey_t privkey" 12 +the private key to be copied. +.IP "const char * password" 12 +the password to protect the key with (may be \fBNULL\fP) +.IP "unsigned flags" 12 +should be one of \fBgnutls_pkcs_encrypt_flags_t\fP elements bitwise or'd +.SH "DESCRIPTION" +This function will insert the given private key into the +bag. This is just a wrapper over \fBgnutls_pkcs12_bag_set_data()\fP. +.SH "RETURNS" +the index of the added bag on success, or a negative +value on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_deinit.3 b/doc/manpages/gnutls_pkcs12_deinit.3 new file mode 100644 index 0000000..341d107 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "void gnutls_pkcs12_deinit(gnutls_pkcs12_t " pkcs12 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +The type to be initialized +.SH "DESCRIPTION" +This function will deinitialize a PKCS12 type. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_export.3 b/doc/manpages/gnutls_pkcs12_export.3 new file mode 100644 index 0000000..e36b123 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_export.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_export \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_export(gnutls_pkcs12_t " pkcs12 ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +A pkcs12 type +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "void * output_data" 12 +will contain a structure PEM or DER encoded +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the pkcs12 structure to DER or PEM format. + +If the buffer provided is not long enough to hold the output, then +*output_data_size will be updated and GNUTLS_E_SHORT_MEMORY_BUFFER +will be returned. + +If the structure is PEM encoded, it will have a header +of "BEGIN PKCS12". +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_export2.3 b/doc/manpages/gnutls_pkcs12_export2.3 new file mode 100644 index 0000000..127dfc0 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_export2.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_export2(gnutls_pkcs12_t " pkcs12 ", gnutls_x509_crt_fmt_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +A pkcs12 type +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "gnutls_datum_t * out" 12 +will contain a structure PEM or DER encoded +.SH "DESCRIPTION" +This function will export the pkcs12 structure to DER or PEM format. + +The output buffer is allocated using \fBgnutls_malloc()\fP. + +If the structure is PEM encoded, it will have a header +of "BEGIN PKCS12". +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_generate_mac.3 b/doc/manpages/gnutls_pkcs12_generate_mac.3 new file mode 100644 index 0000000..8761ff0 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_generate_mac.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_generate_mac" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_generate_mac \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_generate_mac(gnutls_pkcs12_t " pkcs12 ", const char * " pass ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +A pkcs12 type +.IP "const char * pass" 12 +The password for the MAC +.SH "DESCRIPTION" +This function will generate a MAC for the PKCS12 structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_generate_mac2.3 b/doc/manpages/gnutls_pkcs12_generate_mac2.3 new file mode 100644 index 0000000..6ac407c --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_generate_mac2.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_generate_mac2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_generate_mac2 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_generate_mac2(gnutls_pkcs12_t " pkcs12 ", gnutls_mac_algorithm_t " mac ", const char * " pass ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +A pkcs12 type +.IP "gnutls_mac_algorithm_t mac" 12 +the MAC algorithm to use +.IP "const char * pass" 12 +The password for the MAC +.SH "DESCRIPTION" +This function will generate a MAC for the PKCS12 structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_get_bag.3 b/doc/manpages/gnutls_pkcs12_get_bag.3 new file mode 100644 index 0000000..3d57b57 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_get_bag.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_get_bag" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_get_bag \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_get_bag(gnutls_pkcs12_t " pkcs12 ", int " indx ", gnutls_pkcs12_bag_t " bag ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +A pkcs12 type +.IP "int indx" 12 +contains the index of the bag to extract +.IP "gnutls_pkcs12_bag_t bag" 12 +An initialized bag, where the contents of the bag will be copied +.SH "DESCRIPTION" +This function will return a Bag from the PKCS12 structure. + +After the last Bag has been read +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_import.3 b/doc/manpages/gnutls_pkcs12_import.3 new file mode 100644 index 0000000..8ba782c --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_import.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_import \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_import(gnutls_pkcs12_t " pkcs12 ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +The data to store the parsed PKCS12. +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded PKCS12. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM +.IP "unsigned int flags" 12 +an ORed sequence of gnutls_privkey_pkcs8_flags +.SH "DESCRIPTION" +This function will convert the given DER or PEM encoded PKCS12 +to the native gnutls_pkcs12_t format. The output will be stored in 'pkcs12'. + +If the PKCS12 is PEM encoded it should have a header of "PKCS12". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_init.3 b/doc/manpages/gnutls_pkcs12_init.3 new file mode 100644 index 0000000..59d047a --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_init \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_init(gnutls_pkcs12_t * " pkcs12 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t * pkcs12" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a PKCS12 type. PKCS12 structures +usually contain lists of X.509 Certificates and X.509 Certificate +revocation lists. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_mac_info.3 b/doc/manpages/gnutls_pkcs12_mac_info.3 new file mode 100644 index 0000000..8657c0f --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_mac_info.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_mac_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_mac_info \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_mac_info(gnutls_pkcs12_t " pkcs12 ", unsigned int * " mac ", void * " salt ", unsigned int * " salt_size ", unsigned int * " iter_count ", char ** " oid ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +A pkcs12 type +.IP "unsigned int * mac" 12 +the MAC algorithm used as \fBgnutls_mac_algorithm_t\fP +.IP "void * salt" 12 +the salt used for string to key (if non\-NULL then \fIsalt_size\fP initially holds its size) +.IP "unsigned int * salt_size" 12 +string to key salt size +.IP "unsigned int * iter_count" 12 +string to key iteration count +.IP "char ** oid" 12 +if non\-NULL it will contain an allocated null\-terminated variable with the OID +.SH "DESCRIPTION" +This function will provide information on the MAC algorithm used +in a PKCS \fB12\fP structure. If the structure algorithms +are unknown the code \fBGNUTLS_E_UNKNOWN_HASH_ALGORITHM\fP will be returned, +and only \fIoid\fP , will be set. That is, \fIoid\fP will be set on structures +with a MAC whether supported or not. It must be deinitialized using \fBgnutls_free()\fP. +The other variables are only set on supported structures. +.SH "RETURNS" +\fBGNUTLS_E_INVALID_REQUEST\fP if the provided structure doesn't contain a MAC, +\fBGNUTLS_E_UNKNOWN_HASH_ALGORITHM\fP if the structure's MAC isn't supported, or +another negative error code in case of a failure. Zero on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_set_bag.3 b/doc/manpages/gnutls_pkcs12_set_bag.3 new file mode 100644 index 0000000..0c735a4 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_set_bag.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_set_bag" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_set_bag \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_set_bag(gnutls_pkcs12_t " pkcs12 ", gnutls_pkcs12_bag_t " bag ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +should contain a gnutls_pkcs12_t type +.IP "gnutls_pkcs12_bag_t bag" 12 +An initialized bag +.SH "DESCRIPTION" +This function will insert a Bag into the PKCS12 structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_simple_parse.3 b/doc/manpages/gnutls_pkcs12_simple_parse.3 new file mode 100644 index 0000000..5dec2a0 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_simple_parse.3 @@ -0,0 +1,83 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_simple_parse" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_simple_parse \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_simple_parse(gnutls_pkcs12_t " p12 ", const char * " password ", gnutls_x509_privkey_t * " key ", gnutls_x509_crt_t ** " chain ", unsigned int * " chain_len ", gnutls_x509_crt_t ** " extra_certs ", unsigned int * " extra_certs_len ", gnutls_x509_crl_t * " crl ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t p12" 12 +A pkcs12 type +.IP "const char * password" 12 +optional password used to decrypt the structure, bags and keys. +.IP "gnutls_x509_privkey_t * key" 12 +a structure to store the parsed private key. +.IP "gnutls_x509_crt_t ** chain" 12 +the corresponding to key certificate chain (may be \fBNULL\fP) +.IP "unsigned int * chain_len" 12 +will be updated with the number of additional (may be \fBNULL\fP) +.IP "gnutls_x509_crt_t ** extra_certs" 12 +optional pointer to receive an array of additional +certificates found in the PKCS12 structure (may be \fBNULL\fP). +.IP "unsigned int * extra_certs_len" 12 +will be updated with the number of additional +certs (may be \fBNULL\fP). +.IP "gnutls_x509_crl_t * crl" 12 +an optional structure to store the parsed CRL (may be \fBNULL\fP). +.IP "unsigned int flags" 12 +should be zero or one of GNUTLS_PKCS12_SP_* +.SH "DESCRIPTION" +This function parses a PKCS12 structure in \fIpkcs12\fP and extracts the +private key, the corresponding certificate chain, any additional +certificates and a CRL. The structures in \fIkey\fP , \fIchain\fP \fIcrl\fP , and \fIextra_certs\fP must not be initialized. + +The \fIextra_certs\fP and \fIextra_certs_len\fP parameters are optional +and both may be set to \fBNULL\fP. If either is non\-\fBNULL\fP, then both must +be set. The value for \fIextra_certs\fP is allocated +using \fBgnutls_malloc()\fP. + +Encrypted PKCS12 bags and PKCS8 private keys are supported, but +only with password based security and the same password for all +operations. + +Note that a PKCS12 structure may contain many keys and/or certificates, +and there is no way to identify which key/certificate pair you want. +For this reason this function is useful for PKCS12 files that contain +only one key/certificate pair and/or one CRL. + +If the provided structure has encrypted fields but no password +is provided then this function returns \fBGNUTLS_E_DECRYPTION_FAILED\fP. + +Note that normally the chain constructed does not include self signed +certificates, to comply with TLS' requirements. If, however, the flag +\fBGNUTLS_PKCS12_SP_INCLUDE_SELF_SIGNED\fP is specified then +self signed certificates will be included in the chain. + +Prior to using this function the PKCS \fB12\fP structure integrity must +be verified using \fBgnutls_pkcs12_verify_mac()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs12_verify_mac.3 b/doc/manpages/gnutls_pkcs12_verify_mac.3 new file mode 100644 index 0000000..7a038b2 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_verify_mac.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_verify_mac" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_verify_mac \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs12.h> +.sp +.BI "int gnutls_pkcs12_verify_mac(gnutls_pkcs12_t " pkcs12 ", const char * " pass ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +should contain a gnutls_pkcs12_t type +.IP "const char * pass" 12 +The password for the MAC +.SH "DESCRIPTION" +This function will verify the MAC for the PKCS12 structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_add_attr.3 b/doc/manpages/gnutls_pkcs7_add_attr.3 new file mode 100644 index 0000000..05cd592 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_add_attr.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_add_attr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_add_attr \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_add_attr(gnutls_pkcs7_attrs_t * " list ", const char * " oid ", gnutls_datum_t * " data ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_attrs_t * list" 12 +A list of existing attributes or pointer to \fBNULL\fP for the first one +.IP "const char * oid" 12 +the OID of the attribute to be set +.IP "gnutls_datum_t * data" 12 +the raw (DER\-encoded) data of the attribute to be set +.IP "unsigned flags" 12 +zero or \fBGNUTLS_PKCS7_ATTR_ENCODE_OCTET_STRING\fP +.SH "DESCRIPTION" +This function will set a PKCS \fB7\fP attribute in the provided list. +If this function fails, the previous list would be deallocated. + +Note that any attributes set with this function must either be +DER or BER encoded, unless a special flag is present. +.SH "RETURNS" +On success, the new list head, otherwise \fBNULL\fP. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_attrs_deinit.3 b/doc/manpages/gnutls_pkcs7_attrs_deinit.3 new file mode 100644 index 0000000..db385f4 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_attrs_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_attrs_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_attrs_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "void gnutls_pkcs7_attrs_deinit(gnutls_pkcs7_attrs_t " list ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_attrs_t list" 12 +A list of existing attributes +.SH "DESCRIPTION" +This function will clear a PKCS \fB7\fP attribute list. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_deinit.3 b/doc/manpages/gnutls_pkcs7_deinit.3 new file mode 100644 index 0000000..02efff8 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "void gnutls_pkcs7_deinit(gnutls_pkcs7_t " pkcs7 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +the type to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a PKCS7 type. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_delete_crl.3 b/doc/manpages/gnutls_pkcs7_delete_crl.3 new file mode 100644 index 0000000..f432efd --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_delete_crl.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_delete_crl" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_delete_crl \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_delete_crl(gnutls_pkcs7_t " pkcs7 ", int " indx ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "int indx" 12 +the index of the crl to delete +.SH "DESCRIPTION" +This function will delete a crl from a PKCS7 or RFC2630 crl set. +Index starts from 0. Returns 0 on success. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_delete_crt.3 b/doc/manpages/gnutls_pkcs7_delete_crt.3 new file mode 100644 index 0000000..15a1f40 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_delete_crt.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_delete_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_delete_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_delete_crt(gnutls_pkcs7_t " pkcs7 ", int " indx ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "int indx" 12 +the index of the certificate to delete +.SH "DESCRIPTION" +This function will delete a certificate from a PKCS7 or RFC2630 +certificate set. Index starts from 0. Returns 0 on success. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_export.3 b/doc/manpages/gnutls_pkcs7_export.3 new file mode 100644 index 0000000..e78be14 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_export.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_export \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_export(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "void * output_data" 12 +will contain a structure PEM or DER encoded +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the pkcs7 structure to DER or PEM format. + +If the buffer provided is not long enough to hold the output, then +* \fIoutput_data_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP +will be returned. + +If the structure is PEM encoded, it will have a header +of "BEGIN PKCS7". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_export2.3 b/doc/manpages/gnutls_pkcs7_export2.3 new file mode 100644 index 0000000..96f9739 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_export2.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_export2(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_crt_fmt_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "gnutls_datum_t * out" 12 +will contain a structure PEM or DER encoded +.SH "DESCRIPTION" +This function will export the pkcs7 structure to DER or PEM format. + +The output buffer is allocated using \fBgnutls_malloc()\fP. + +If the structure is PEM encoded, it will have a header +of "BEGIN PKCS7". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_attr.3 b/doc/manpages/gnutls_pkcs7_get_attr.3 new file mode 100644 index 0000000..45485ea --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_attr.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_attr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_attr \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_attr(gnutls_pkcs7_attrs_t " list ", unsigned " idx ", char ** " oid ", gnutls_datum_t * " data ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_attrs_t list" 12 +A list of existing attributes or \fBNULL\fP for the first one +.IP "unsigned idx" 12 +the index of the attribute to get +.IP "char ** oid" 12 +the OID of the attribute (read\-only) +.IP "gnutls_datum_t * data" 12 +the raw data of the attribute +.IP "unsigned flags" 12 +zero or \fBGNUTLS_PKCS7_ATTR_ENCODE_OCTET_STRING\fP +.SH "DESCRIPTION" +This function will get a PKCS \fB7\fP attribute from the provided list. +The OID is a constant string, but data will be allocated and must be +deinitialized by the caller. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned +if there are no data in the current index. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_crl_count.3 b/doc/manpages/gnutls_pkcs7_get_crl_count.3 new file mode 100644 index 0000000..2e9f704 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crl_count.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crl_count" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crl_count \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_crl_count(gnutls_pkcs7_t " pkcs7 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.SH "DESCRIPTION" +This function will return the number of certificates in the PKCS7 +or RFC2630 crl set. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_crl_raw.3 b/doc/manpages/gnutls_pkcs7_get_crl_raw.3 new file mode 100644 index 0000000..e1b8388 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crl_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crl_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crl_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_crl_raw(gnutls_pkcs7_t " pkcs7 ", unsigned " indx ", void * " crl ", size_t * " crl_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "unsigned indx" 12 +contains the index of the crl to extract +.IP "void * crl" 12 +the contents of the crl will be copied there (may be null) +.IP "size_t * crl_size" 12 +should hold the size of the crl +.SH "DESCRIPTION" +This function will return a crl of the PKCS7 or RFC2630 crl set. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. If the provided buffer is not long enough, +then \fIcrl_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is +returned. After the last crl has been read +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_crl_raw2.3 b/doc/manpages/gnutls_pkcs7_get_crl_raw2.3 new file mode 100644 index 0000000..e14f3d6 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crl_raw2.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crl_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crl_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_crl_raw2(gnutls_pkcs7_t " pkcs7 ", unsigned " indx ", gnutls_datum_t * " crl ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "unsigned indx" 12 +contains the index of the crl to extract +.IP "gnutls_datum_t * crl" 12 +will contain the contents of the CRL in an allocated buffer +.SH "DESCRIPTION" +This function will return a DER encoded CRL of the PKCS7 or RFC2630 crl set. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. After the last crl has been read +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_crt_count.3 b/doc/manpages/gnutls_pkcs7_get_crt_count.3 new file mode 100644 index 0000000..c88284d --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crt_count.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crt_count" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crt_count \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_crt_count(gnutls_pkcs7_t " pkcs7 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP type +.SH "DESCRIPTION" +This function will return the number of certificates in the PKCS7 +or RFC2630 certificate set. +.SH "RETURNS" +On success, a positive number is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_crt_raw.3 b/doc/manpages/gnutls_pkcs7_get_crt_raw.3 new file mode 100644 index 0000000..4fece1b --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crt_raw.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crt_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crt_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_crt_raw(gnutls_pkcs7_t " pkcs7 ", unsigned " indx ", void * " certificate ", size_t * " certificate_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a gnutls_pkcs7_t type +.IP "unsigned indx" 12 +contains the index of the certificate to extract +.IP "void * certificate" 12 +the contents of the certificate will be copied +there (may be null) +.IP "size_t * certificate_size" 12 +should hold the size of the certificate +.SH "DESCRIPTION" +This function will return a certificate of the PKCS7 or RFC2630 +certificate set. + +After the last certificate has been read +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. If the provided buffer is not long enough, +then \fIcertificate_size\fP is updated and +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_crt_raw2.3 b/doc/manpages/gnutls_pkcs7_get_crt_raw2.3 new file mode 100644 index 0000000..51ece1e --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crt_raw2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crt_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crt_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_crt_raw2(gnutls_pkcs7_t " pkcs7 ", unsigned " indx ", gnutls_datum_t * " cert ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a gnutls_pkcs7_t type +.IP "unsigned indx" 12 +contains the index of the certificate to extract +.IP "gnutls_datum_t * cert" 12 +will hold the contents of the certificate; must be deallocated with \fBgnutls_free()\fP +.SH "DESCRIPTION" +This function will return a certificate of the PKCS7 or RFC2630 +certificate set. + +After the last certificate has been read +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. If the provided buffer is not long enough, +then \fIcertificate_size\fP is updated and +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_embedded_data.3 b/doc/manpages/gnutls_pkcs7_get_embedded_data.3 new file mode 100644 index 0000000..5b43cc5 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_embedded_data.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_embedded_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_embedded_data \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_embedded_data(gnutls_pkcs7_t " pkcs7 ", unsigned " flags ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a gnutls_pkcs7_t type +.IP "unsigned flags" 12 +must be zero or \fBGNUTLS_PKCS7_EDATA_GET_RAW\fP +.IP "gnutls_datum_t * data" 12 +will hold the embedded data in the provided structure +.SH "DESCRIPTION" +This function will return the data embedded in the signature of +the PKCS7 structure. If no data are available then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. + +The returned data must be de\-allocated using \fBgnutls_free()\fP. + +Note, that this function returns the exact same data that are +authenticated. If the \fBGNUTLS_PKCS7_EDATA_GET_RAW\fP flag is provided, +the returned data will be including the wrapping tag/value as +they are encoded in the structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_embedded_data_oid.3 b/doc/manpages/gnutls_pkcs7_get_embedded_data_oid.3 new file mode 100644 index 0000000..3ea9c72 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_embedded_data_oid.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_embedded_data_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_embedded_data_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "const char * gnutls_pkcs7_get_embedded_data_oid(gnutls_pkcs7_t " pkcs7 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a gnutls_pkcs7_t type +.SH "DESCRIPTION" +This function will return the OID of the data embedded in the signature of +the PKCS7 structure. If no data are available then \fBNULL\fP will be +returned. The returned value will be valid during the lifetime +of the \fIpkcs7\fP structure. +.SH "RETURNS" +On success, a pointer to an OID string, \fBNULL\fP on error. +.SH "SINCE" +3.5.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_signature_count.3 b/doc/manpages/gnutls_pkcs7_get_signature_count.3 new file mode 100644 index 0000000..d8b8db3 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_signature_count.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_signature_count" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_signature_count \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_signature_count(gnutls_pkcs7_t " pkcs7 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP type +.SH "DESCRIPTION" +This function will return the number of signatures in the PKCS7 +structure. +.SH "RETURNS" +On success, a positive number is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_get_signature_info.3 b/doc/manpages/gnutls_pkcs7_get_signature_info.3 new file mode 100644 index 0000000..d1b7cbc --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_signature_info.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_signature_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_signature_info \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_get_signature_info(gnutls_pkcs7_t " pkcs7 ", unsigned " idx ", gnutls_pkcs7_signature_info_st * " info ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP type +.IP "unsigned idx" 12 +the index of the signature info to check +.IP "gnutls_pkcs7_signature_info_st * info" 12 +will contain the output signature +.SH "DESCRIPTION" +This function will return information about the signature identified +by idx in the provided PKCS \fB7\fP structure. The information should be +deinitialized using \fBgnutls_pkcs7_signature_info_deinit()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_import.3 b/doc/manpages/gnutls_pkcs7_import.3 new file mode 100644 index 0000000..232ec58 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_import.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_import \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_import(gnutls_pkcs7_t " pkcs7 ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The data to store the parsed PKCS7. +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded PKCS7. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM +.SH "DESCRIPTION" +This function will convert the given DER or PEM encoded PKCS7 to +the native \fBgnutls_pkcs7_t\fP format. The output will be stored in + \fIpkcs7\fP . Any signed data that may be present inside the \fIpkcs7\fP structure, like certificates set by \fBgnutls_pkcs7_set_crt()\fP, will +be freed and overwritten by this function. + +If the PKCS7 is PEM encoded it should have a header of "PKCS7". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_init.3 b/doc/manpages/gnutls_pkcs7_init.3 new file mode 100644 index 0000000..95cbf11 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_init \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_init(gnutls_pkcs7_t * " pkcs7 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t * pkcs7" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a PKCS7 structure. PKCS7 structures +usually contain lists of X.509 Certificates and X.509 Certificate +revocation lists. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_print.3 b/doc/manpages/gnutls_pkcs7_print.3 new file mode 100644 index 0000000..75afc0f --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_print.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_print \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_print(gnutls_pkcs7_t " pkcs7 ", gnutls_certificate_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The PKCS7 struct to be printed +.IP "gnutls_certificate_print_formats_t format" 12 +Indicate the format to use +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with null terminated string. +.SH "DESCRIPTION" +This function will pretty print a signed PKCS \fB7\fP structure, suitable for +display to a human. + +Currently the supported formats are \fBGNUTLS_CRT_PRINT_FULL\fP and +\fBGNUTLS_CRT_PRINT_COMPACT\fP. + +The output \fIout\fP needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_print_signature_info.3 b/doc/manpages/gnutls_pkcs7_print_signature_info.3 new file mode 100644 index 0000000..6e71286 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_print_signature_info.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_print_signature_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_print_signature_info \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_print_signature_info(gnutls_pkcs7_signature_info_st * " info ", gnutls_certificate_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_signature_info_st * info" 12 +The PKCS7 signature info struct to be printed +.IP "gnutls_certificate_print_formats_t format" 12 +Indicate the format to use +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with null terminated string. +.SH "DESCRIPTION" +This function will pretty print a PKCS \fB7\fP signature info structure, suitable +for display to a human. + +Currently the supported formats are \fBGNUTLS_CRT_PRINT_FULL\fP and +\fBGNUTLS_CRT_PRINT_COMPACT\fP. + +The output \fIout\fP needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.14 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_set_crl.3 b/doc/manpages/gnutls_pkcs7_set_crl.3 new file mode 100644 index 0000000..62e05db --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_set_crl.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_set_crl" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_set_crl \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_set_crl(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "gnutls_x509_crl_t crl" 12 +the DER encoded crl to be added +.SH "DESCRIPTION" +This function will add a parsed CRL to the PKCS7 or RFC2630 crl +set. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_set_crl_raw.3 b/doc/manpages/gnutls_pkcs7_set_crl_raw.3 new file mode 100644 index 0000000..7ecda59 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_set_crl_raw.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_set_crl_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_set_crl_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_set_crl_raw(gnutls_pkcs7_t " pkcs7 ", const gnutls_datum_t * " crl ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "const gnutls_datum_t * crl" 12 +the DER encoded crl to be added +.SH "DESCRIPTION" +This function will add a crl to the PKCS7 or RFC2630 crl set. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_set_crt.3 b/doc/manpages/gnutls_pkcs7_set_crt.3 new file mode 100644 index 0000000..239e485 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_set_crt.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_set_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_set_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_set_crt(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_crt_t " crt ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "gnutls_x509_crt_t crt" 12 +the certificate to be copied. +.SH "DESCRIPTION" +This function will add a parsed certificate to the PKCS7 or +RFC2630 certificate set. This is a wrapper function over +\fBgnutls_pkcs7_set_crt_raw()\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_set_crt_raw.3 b/doc/manpages/gnutls_pkcs7_set_crt_raw.3 new file mode 100644 index 0000000..879a8f8 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_set_crt_raw.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_set_crt_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_set_crt_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_set_crt_raw(gnutls_pkcs7_t " pkcs7 ", const gnutls_datum_t * " crt ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The pkcs7 type +.IP "const gnutls_datum_t * crt" 12 +the DER encoded certificate to be added +.SH "DESCRIPTION" +This function will add a certificate to the PKCS7 or RFC2630 +certificate set. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_sign.3 b/doc/manpages/gnutls_pkcs7_sign.3 new file mode 100644 index 0000000..0085ec9 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_sign.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_sign" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_sign \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_sign(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_crt_t " signer ", gnutls_privkey_t " signer_key ", const gnutls_datum_t * " data ", gnutls_pkcs7_attrs_t " signed_attrs ", gnutls_pkcs7_attrs_t " unsigned_attrs ", gnutls_digest_algorithm_t " dig ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP type +.IP "gnutls_x509_crt_t signer" 12 +the certificate to sign the structure +.IP "gnutls_privkey_t signer_key" 12 +the key to sign the structure +.IP "const gnutls_datum_t * data" 12 +The data to be signed or \fBNULL\fP if the data are already embedded +.IP "gnutls_pkcs7_attrs_t signed_attrs" 12 +Any additional attributes to be included in the signed ones (or \fBNULL\fP) +.IP "gnutls_pkcs7_attrs_t unsigned_attrs" 12 +Any additional attributes to be included in the unsigned ones (or \fBNULL\fP) +.IP "gnutls_digest_algorithm_t dig" 12 +The digest algorithm to use for signing +.IP "unsigned flags" 12 +Should be zero or one of \fBGNUTLS_PKCS7\fP flags +.SH "DESCRIPTION" +This function will add a signature in the provided PKCS \fB7\fP structure +for the provided data. Multiple signatures can be made with different +signers. + +The available flags are: +\fBGNUTLS_PKCS7_EMBED_DATA\fP, \fBGNUTLS_PKCS7_INCLUDE_TIME\fP, \fBGNUTLS_PKCS7_INCLUDE_CERT\fP, +and \fBGNUTLS_PKCS7_WRITE_SPKI\fP. They are explained in the \fBgnutls_pkcs7_sign_flags\fP +definition. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_signature_info_deinit.3 b/doc/manpages/gnutls_pkcs7_signature_info_deinit.3 new file mode 100644 index 0000000..51efbad --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_signature_info_deinit.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_signature_info_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_signature_info_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "void gnutls_pkcs7_signature_info_deinit(gnutls_pkcs7_signature_info_st * " info ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_signature_info_st * info" 12 +should point to a \fBgnutls_pkcs7_signature_info_st\fP structure +.SH "DESCRIPTION" +This function will deinitialize any allocated value in the +provided \fBgnutls_pkcs7_signature_info_st\fP. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_verify.3 b/doc/manpages/gnutls_pkcs7_verify.3 new file mode 100644 index 0000000..098d9f4 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_verify.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_verify" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_verify \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_verify(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_trust_list_t " tl ", gnutls_typed_vdata_st * " vdata ", unsigned int " vdata_size ", unsigned " idx ", const gnutls_datum_t * " data ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP type +.IP "gnutls_x509_trust_list_t tl" 12 +A list of trusted certificates +.IP "gnutls_typed_vdata_st * vdata" 12 +an array of typed data +.IP "unsigned int vdata_size" 12 +the number of data elements +.IP "unsigned idx" 12 +the index of the signature info to check +.IP "const gnutls_datum_t * data" 12 +The data to be verified or \fBNULL\fP +.IP "unsigned flags" 12 +Zero or an OR list of \fBgnutls_certificate_verify_flags\fP +.SH "DESCRIPTION" +This function will verify the provided data against the signature +present in the SignedData of the PKCS \fB7\fP structure. If the data +provided are NULL then the data in the encapsulatedContent field +will be used instead. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. A verification error results to a +\fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP and the lack of encapsulated data +to verify to a \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs7_verify_direct.3 b/doc/manpages/gnutls_pkcs7_verify_direct.3 new file mode 100644 index 0000000..5437e70 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_verify_direct.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_verify_direct" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_verify_direct \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs7.h> +.sp +.BI "int gnutls_pkcs7_verify_direct(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_crt_t " signer ", unsigned " idx ", const gnutls_datum_t * " data ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP type +.IP "gnutls_x509_crt_t signer" 12 +the certificate believed to have signed the structure +.IP "unsigned idx" 12 +the index of the signature info to check +.IP "const gnutls_datum_t * data" 12 +The data to be verified or \fBNULL\fP +.IP "unsigned flags" 12 +Zero or an OR list of \fBgnutls_certificate_verify_flags\fP +.SH "DESCRIPTION" +This function will verify the provided data against the signature +present in the SignedData of the PKCS \fB7\fP structure. If the data +provided are NULL then the data in the encapsulatedContent field +will be used instead. + +Note that, unlike \fBgnutls_pkcs7_verify()\fP this function does not +verify the key purpose of the signer. It is expected for the caller +to verify the intended purpose of the \fBsigner\fP \-e.g., via \fBgnutls_x509_crt_get_key_purpose_oid()\fP, +or \fBgnutls_x509_crt_check_key_purpose()\fP. + +Note also, that since GnuTLS 3.5.6 this function introduces checks in the +end certificate ( \fIsigner\fP ), including time checks and key usage checks. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. A verification error results to a +\fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP and the lack of encapsulated data +to verify to a \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs8_info.3 b/doc/manpages/gnutls_pkcs8_info.3 new file mode 100644 index 0000000..5876645 --- /dev/null +++ b/doc/manpages/gnutls_pkcs8_info.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs8_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs8_info \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_pkcs8_info(const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int * " schema ", unsigned int * " cipher ", void * " salt ", unsigned int * " salt_size ", unsigned int * " iter_count ", char ** " oid ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * data" 12 +Holds the PKCS \fB8\fP data +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of the PKCS \fB8\fP data +.IP "unsigned int * schema" 12 +indicate the schema as one of \fBgnutls_pkcs_encrypt_flags_t\fP +.IP "unsigned int * cipher" 12 +the cipher used as \fBgnutls_cipher_algorithm_t\fP +.IP "void * salt" 12 +PBKDF2 salt (if non\-NULL then \fIsalt_size\fP initially holds its size) +.IP "unsigned int * salt_size" 12 +PBKDF2 salt size +.IP "unsigned int * iter_count" 12 +PBKDF2 iteration count +.IP "char ** oid" 12 +if non\-NULL it will contain an allocated null\-terminated variable with the OID +.SH "DESCRIPTION" +This function will provide information on the algorithms used +in a particular PKCS \fB8\fP structure. If the structure algorithms +are unknown the code \fBGNUTLS_E_UNKNOWN_CIPHER_TYPE\fP will be returned, +and only \fIoid\fP , will be set. That is, \fIoid\fP will be set on encrypted PKCS \fB8\fP +structures whether supported or not. It must be deinitialized using \fBgnutls_free()\fP. +The other variables are only set on supported structures. +.SH "RETURNS" +\fBGNUTLS_E_INVALID_REQUEST\fP if the provided structure isn't an encrypted key, +\fBGNUTLS_E_UNKNOWN_CIPHER_TYPE\fP if the structure's encryption isn't supported, or +another negative error code in case of a failure. Zero on success. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs_schema_get_name.3 b/doc/manpages/gnutls_pkcs_schema_get_name.3 new file mode 100644 index 0000000..9bb43a4 --- /dev/null +++ b/doc/manpages/gnutls_pkcs_schema_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs_schema_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs_schema_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "const char * gnutls_pkcs_schema_get_name(unsigned int " schema ");" +.SH ARGUMENTS +.IP "unsigned int schema" 12 +Holds the PKCS \fB12\fP or PBES2 schema (\fBgnutls_pkcs_encrypt_flags_t\fP) +.SH "DESCRIPTION" +This function will return a human readable description of the +PKCS12 or PBES2 schema. +.SH "RETURNS" +a constraint string or \fBNULL\fP on error. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pkcs_schema_get_oid.3 b/doc/manpages/gnutls_pkcs_schema_get_oid.3 new file mode 100644 index 0000000..14b4dc7 --- /dev/null +++ b/doc/manpages/gnutls_pkcs_schema_get_oid.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs_schema_get_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs_schema_get_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "const char * gnutls_pkcs_schema_get_oid(unsigned int " schema ");" +.SH ARGUMENTS +.IP "unsigned int schema" 12 +Holds the PKCS \fB12\fP or PBES2 schema (\fBgnutls_pkcs_encrypt_flags_t\fP) +.SH "DESCRIPTION" +This function will return the object identifier of the +PKCS12 or PBES2 schema. +.SH "RETURNS" +a constraint string or \fBNULL\fP on error. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_prf.3 b/doc/manpages/gnutls_prf.3 new file mode 100644 index 0000000..2d67eec --- /dev/null +++ b/doc/manpages/gnutls_prf.3 @@ -0,0 +1,69 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_prf" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_prf \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_prf(gnutls_session_t " session ", size_t " label_size ", const char * " label ", int " server_random_first ", size_t " extra_size ", const char * " extra ", size_t " outsize ", char * " out ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t label_size" 12 +length of the \fIlabel\fP variable. +.IP "const char * label" 12 +label used in PRF computation, typically a short string. +.IP "int server_random_first" 12 +non\-zero if server random field should be first in seed +.IP "size_t extra_size" 12 +length of the \fIextra\fP variable. +.IP "const char * extra" 12 +optional extra data to seed the PRF with. +.IP "size_t outsize" 12 +size of pre\-allocated output buffer to hold the output. +.IP "char * out" 12 +pre\-allocated buffer to hold the generated data. +.SH "DESCRIPTION" +Applies the TLS Pseudo\-Random\-Function (PRF) on the master secret +and the provided data, seeded with the client and server random fields. +For the key expansion specified in RFC5705 see \fBgnutls_prf_rfc5705()\fP. + +The \fIlabel\fP variable usually contains a string denoting the purpose +for the generated data. The \fIserver_random_first\fP indicates whether +the client random field or the server random field should be first +in the seed. Non\-zero indicates that the server random field is first, +0 that the client random field is first. + +The \fIextra\fP variable can be used to add more data to the seed, after +the random variables. It can be used to make sure the +generated output is strongly connected to some additional data +(e.g., a string used in user authentication). + +The output is placed in \fIout\fP , which must be pre\-allocated. +.SH "NOTE" +This function produces identical output with \fBgnutls_prf_rfc5705()\fP +when \fIserver_random_first\fP is set to 0 and \fIextra\fP is \fBNULL\fP. Under TLS1.3 +this function will only operate when these conditions are true, or otherwise +return \fBGNUTLS_E_INVALID_REQUEST\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_prf_early.3 b/doc/manpages/gnutls_prf_early.3 new file mode 100644 index 0000000..3ed2101 --- /dev/null +++ b/doc/manpages/gnutls_prf_early.3 @@ -0,0 +1,68 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_prf_early" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_prf_early \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_prf_early(gnutls_session_t " session ", size_t " label_size ", const char * " label ", size_t " context_size ", const char * " context ", size_t " outsize ", char * " out ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t label_size" 12 +length of the \fIlabel\fP variable. +.IP "const char * label" 12 +label used in PRF computation, typically a short string. +.IP "size_t context_size" 12 +length of the \fIextra\fP variable. +.IP "const char * context" 12 +optional extra data to seed the PRF with. +.IP "size_t outsize" 12 +size of pre\-allocated output buffer to hold the output. +.IP "char * out" 12 +pre\-allocated buffer to hold the generated data. +.SH "DESCRIPTION" +This function is similar to \fBgnutls_prf_rfc5705()\fP, but only works in +TLS 1.3 or later to export early keying material. + +Note that the keying material is only available after the +ClientHello message is processed and before the application traffic +keys are established. Therefore this function shall be called in a +handshake hook function for \fBGNUTLS_HANDSHAKE_CLIENT_HELLO\fP. + +The \fIlabel\fP variable usually contains a string denoting the purpose +for the generated data. + +The \fIcontext\fP variable can be used to add more data to the seed, after +the random variables. It can be used to make sure the +generated output is strongly connected to some additional data +(e.g., a string used in user authentication). + +The output is placed in \fIout\fP , which must be pre\-allocated. + +Note that, to provide the RFC5705 context, the \fIcontext\fP variable +must be non\-null. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "SINCE" +3.6.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_prf_hash_get.3 b/doc/manpages/gnutls_prf_hash_get.3 new file mode 100644 index 0000000..adacb38 --- /dev/null +++ b/doc/manpages/gnutls_prf_hash_get.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_prf_hash_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_prf_hash_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_digest_algorithm_t gnutls_prf_hash_get(const gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "const gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the currently used hash algorithm. In TLS 1.3, the hash +algorithm is used for both the key derivation function and +handshake message authentication code. In TLS 1.2, it matches the +hash algorithm used for PRF. +.SH "RETURNS" +the currently used hash algorithm, a +\fBgnutls_digest_algorithm_t\fP value. +.SH "SINCE" +3.6.13 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_prf_raw.3 b/doc/manpages/gnutls_prf_raw.3 new file mode 100644 index 0000000..5018a94 --- /dev/null +++ b/doc/manpages/gnutls_prf_raw.3 @@ -0,0 +1,67 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_prf_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_prf_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_prf_raw(gnutls_session_t " session ", size_t " label_size ", const char * " label ", size_t " seed_size ", const char * " seed ", size_t " outsize ", char * " out ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t label_size" 12 +length of the \fIlabel\fP variable. +.IP "const char * label" 12 +label used in PRF computation, typically a short string. +.IP "size_t seed_size" 12 +length of the \fIseed\fP variable. +.IP "const char * seed" 12 +optional extra data to seed the PRF with. +.IP "size_t outsize" 12 +size of pre\-allocated output buffer to hold the output. +.IP "char * out" 12 +pre\-allocated buffer to hold the generated data. +.SH "DESCRIPTION" +Apply the TLS Pseudo\-Random\-Function (PRF) on the master secret +and the provided data. + +The \fIlabel\fP variable usually contains a string denoting the purpose +for the generated data. The \fIseed\fP usually contains data such as the +client and server random, perhaps together with some additional +data that is added to guarantee uniqueness of the output for a +particular purpose. + +Because the output is not guaranteed to be unique for a particular +session unless \fIseed\fP includes the client random and server random +fields (the PRF would output the same data on another connection +resumed from the first one), it is not recommended to use this +function directly. The \fBgnutls_prf()\fP function seeds the PRF with the +client and server random fields directly, and is recommended if you +want to generate pseudo random data unique for each session. +.SH "NOTE" +This function will only operate under TLS versions prior to 1.3. +In TLS1.3 the use of PRF is replaced with HKDF and the generic +exporters like \fBgnutls_prf_rfc5705()\fP should be used instead. Under +TLS1.3 this function returns \fBGNUTLS_E_INVALID_REQUEST\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_prf_rfc5705.3 b/doc/manpages/gnutls_prf_rfc5705.3 new file mode 100644 index 0000000..40d741c --- /dev/null +++ b/doc/manpages/gnutls_prf_rfc5705.3 @@ -0,0 +1,70 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_prf_rfc5705" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_prf_rfc5705 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_prf_rfc5705(gnutls_session_t " session ", size_t " label_size ", const char * " label ", size_t " context_size ", const char * " context ", size_t " outsize ", char * " out ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t label_size" 12 +length of the \fIlabel\fP variable. +.IP "const char * label" 12 +label used in PRF computation, typically a short string. +.IP "size_t context_size" 12 +length of the \fIextra\fP variable. +.IP "const char * context" 12 +optional extra data to seed the PRF with. +.IP "size_t outsize" 12 +size of pre\-allocated output buffer to hold the output. +.IP "char * out" 12 +pre\-allocated buffer to hold the generated data. +.SH "DESCRIPTION" +Exports keying material from TLS/DTLS session to an application, as +specified in RFC5705. + +In the TLS versions prior to 1.3, it applies the TLS +Pseudo\-Random\-Function (PRF) on the master secret and the provided +data, seeded with the client and server random fields. + +In TLS 1.3, it applies HKDF on the exporter master secret derived +from the master secret. + +The \fIlabel\fP variable usually contains a string denoting the purpose +for the generated data. + +The \fIcontext\fP variable can be used to add more data to the seed, after +the random variables. It can be used to make sure the +generated output is strongly connected to some additional data +(e.g., a string used in user authentication). + +The output is placed in \fIout\fP , which must be pre\-allocated. + +Note that, to provide the RFC5705 context, the \fIcontext\fP variable +must be non\-null. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "SINCE" +3.4.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_certificate_type_list.3 b/doc/manpages/gnutls_priority_certificate_type_list.3 new file mode 100644 index 0000000..5467684 --- /dev/null +++ b/doc/manpages/gnutls_priority_certificate_type_list.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_certificate_type_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_certificate_type_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_certificate_type_list(gnutls_priority_t " pcache ", const unsigned int ** " list ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list +.SH "DESCRIPTION" +Get a list of available certificate types in the priority +structure. + +As of version 3.6.4 this function is an alias for +gnutls_priority_certificate_type_list2 with the target parameter +set to: +\- GNUTLS_CTYPE_SERVER, if the \fBSERVER_PRECEDENCE\fP option is set +\- GNUTLS_CTYPE_CLIENT, otherwise. +.SH "RETURNS" +the number of certificate types, or an error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_certificate_type_list2.3 b/doc/manpages/gnutls_priority_certificate_type_list2.3 new file mode 100644 index 0000000..553f53b --- /dev/null +++ b/doc/manpages/gnutls_priority_certificate_type_list2.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_certificate_type_list2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_certificate_type_list2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_certificate_type_list2(gnutls_priority_t " pcache ", const unsigned int ** " list ", gnutls_ctype_target_t " target ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list. +.IP "gnutls_ctype_target_t target" 12 +is a \fBgnutls_ctype_target_t\fP type. Valid arguments are +GNUTLS_CTYPE_CLIENT and GNUTLS_CTYPE_SERVER +.SH "DESCRIPTION" +Get a list of available certificate types for the given target +in the priority structure. +.SH "RETURNS" +the number of certificate types, or an error code. +.SH "SINCE" +3.6.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_cipher_list.3 b/doc/manpages/gnutls_priority_cipher_list.3 new file mode 100644 index 0000000..b8ae7d6 --- /dev/null +++ b/doc/manpages/gnutls_priority_cipher_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_cipher_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_cipher_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_cipher_list(gnutls_priority_t " pcache ", const unsigned int ** " list ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list +.SH "DESCRIPTION" +Get a list of available ciphers in the priority +structure. +.SH "RETURNS" +the number of items, or an error code. +.SH "SINCE" +3.2.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_compression_list.3 b/doc/manpages/gnutls_priority_compression_list.3 new file mode 100644 index 0000000..0d07dda --- /dev/null +++ b/doc/manpages/gnutls_priority_compression_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_compression_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_compression_list \- API function +.SH SYNOPSIS +.B #include <gnutls/compat.h> +.sp +.BI "int gnutls_priority_compression_list(gnutls_priority_t " pcache ", const unsigned int ** " list ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list +.SH "DESCRIPTION" +Get a list of available compression method in the priority +structure. +.SH "RETURNS" +the number of methods, or an error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_deinit.3 b/doc/manpages/gnutls_priority_deinit.3 new file mode 100644 index 0000000..8752dd6 --- /dev/null +++ b/doc/manpages/gnutls_priority_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_priority_deinit(gnutls_priority_t " priority_cache ");" +.SH ARGUMENTS +.IP "gnutls_priority_t priority_cache" 12 +is a \fBgnutls_priority_t\fP type. +.SH "DESCRIPTION" +Deinitializes the priority cache. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_ecc_curve_list.3 b/doc/manpages/gnutls_priority_ecc_curve_list.3 new file mode 100644 index 0000000..dad2729 --- /dev/null +++ b/doc/manpages/gnutls_priority_ecc_curve_list.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_ecc_curve_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_ecc_curve_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_ecc_curve_list(gnutls_priority_t " pcache ", const unsigned int ** " list ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list +.SH "DESCRIPTION" +Get a list of available elliptic curves in the priority +structure. +.SH "DEPRECATED" +This function has been replaced by +\fBgnutls_priority_group_list()\fP since 3.6.0. +.SH "RETURNS" +the number of items, or an error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_get_cipher_suite_index.3 b/doc/manpages/gnutls_priority_get_cipher_suite_index.3 new file mode 100644 index 0000000..49719b3 --- /dev/null +++ b/doc/manpages/gnutls_priority_get_cipher_suite_index.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_get_cipher_suite_index" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_get_cipher_suite_index \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_get_cipher_suite_index(gnutls_priority_t " pcache ", unsigned int " idx ", unsigned int * " sidx ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "unsigned int idx" 12 +is an index number. +.IP "unsigned int * sidx" 12 +internal index of cipher suite to get information about. +.SH "DESCRIPTION" +Provides the internal ciphersuite index to be used with +\fBgnutls_cipher_suite_info()\fP. The index \fIidx\fP provided is an +index kept at the priorities structure. It might be that a valid +priorities index does not correspond to a ciphersuite and in +that case \fBGNUTLS_E_UNKNOWN_CIPHER_SUITE\fP will be returned. +Once the last available index is crossed then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "RETURNS" +On success it returns \fBGNUTLS_E_SUCCESS\fP (0), or a negative error value otherwise. +.SH "SINCE" +3.0.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_group_list.3 b/doc/manpages/gnutls_priority_group_list.3 new file mode 100644 index 0000000..d353c56 --- /dev/null +++ b/doc/manpages/gnutls_priority_group_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_group_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_group_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_group_list(gnutls_priority_t " pcache ", const unsigned int ** " list ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list +.SH "DESCRIPTION" +Get a list of available groups in the priority +structure. +.SH "RETURNS" +the number of items, or an error code. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_init.3 b/doc/manpages/gnutls_priority_init.3 new file mode 100644 index 0000000..ffba75d --- /dev/null +++ b/doc/manpages/gnutls_priority_init.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_init \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_init(gnutls_priority_t * " priority_cache ", const char * " priorities ", const char ** " err_pos ");" +.SH ARGUMENTS +.IP "gnutls_priority_t * priority_cache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const char * priorities" 12 +is a string describing priorities (may be \fBNULL\fP) +.IP "const char ** err_pos" 12 +In case of an error this will have the position in the string the error occurred +.SH "DESCRIPTION" +For applications that do not modify their crypto settings per release, consider +using \fBgnutls_priority_init2()\fP with \fBGNUTLS_PRIORITY_INIT_DEF_APPEND\fP flag +instead. We suggest to use centralized crypto settings handled by the GnuTLS +library, and applications modifying the default settings to their needs. + +This function is identical to \fBgnutls_priority_init2()\fP with zero +flags. + +A \fBNULL\fP \fIpriorities\fP string indicates the default priorities to be +used (this is available since GnuTLS 3.3.0). +.SH "RETURNS" +On syntax error \fBGNUTLS_E_INVALID_REQUEST\fP is returned, +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_init2.3 b/doc/manpages/gnutls_priority_init2.3 new file mode 100644 index 0000000..64a0c9c --- /dev/null +++ b/doc/manpages/gnutls_priority_init2.3 @@ -0,0 +1,129 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_init2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_init2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_init2(gnutls_priority_t * " priority_cache ", const char * " priorities ", const char ** " err_pos ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_priority_t * priority_cache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const char * priorities" 12 +is a string describing priorities (may be \fBNULL\fP) +.IP "const char ** err_pos" 12 +In case of an error this will have the position in the string the error occurred +.IP "unsigned flags" 12 +zero or \fBGNUTLS_PRIORITY_INIT_DEF_APPEND\fP +.SH "DESCRIPTION" +Sets priorities for the ciphers, key exchange methods, and macs. +The \fIpriority_cache\fP should be deinitialized +using \fBgnutls_priority_deinit()\fP. + +The \fBpriorities\fP option allows you to specify a colon +separated list of the cipher priorities to enable. +Some keywords are defined to provide quick access +to common preferences. + +When \fIflags\fP is set to \fBGNUTLS_PRIORITY_INIT_DEF_APPEND\fP then the \fIpriorities\fP specified will be appended to the default options. + +Unless there is a special need, use the "NORMAL" keyword to +apply a reasonable security level, or "NORMAL:%COMPAT" for compatibility. + +"PERFORMANCE" means all the "secure" ciphersuites are enabled, +limited to 128 bit ciphers and sorted by terms of speed +performance. + +"LEGACY" the NORMAL settings for GnuTLS 3.2.x or earlier. There is +no verification profile set, and the allowed DH primes are considered +weak today. + +"NORMAL" means all "secure" ciphersuites. The 256\-bit ciphers are +included as a fallback only. The ciphers are sorted by security +margin. + +"PFS" means all "secure" ciphersuites that support perfect forward secrecy. +The 256\-bit ciphers are included as a fallback only. +The ciphers are sorted by security margin. + +"SECURE128" means all "secure" ciphersuites of security level 128\-bit +or more. + +"SECURE192" means all "secure" ciphersuites of security level 192\-bit +or more. + +"SUITEB128" means all the NSA SuiteB ciphersuites with security level +of 128. + +"SUITEB192" means all the NSA SuiteB ciphersuites with security level +of 192. + +"NONE" means nothing is enabled. This disables everything, including protocols. + +"@KEYWORD1,KEYWORD2,..." The system administrator imposed settings. +The provided keyword(s) will be expanded from a configuration\-time +provided file \- default is: /etc/gnutls/config. +Any attributes that follow it, will be appended to the expanded +string. If multiple keywords are provided, separated by commas, +then the first keyword that exists in the configuration file +will be used. At least one of the keywords must exist, or this +function will return an error. Typical usage would be to specify +an application specified keyword first, followed by "SYSTEM" as +a default fallback. e.g., " \fILIBVIRT\fP ,SYSTEM:!\-VERS\-SSL3.0" will +first try to find a config file entry matching "LIBVIRT", but if +that does not exist will use the entry for "SYSTEM". If "SYSTEM" +does not exist either, an error will be returned. In all cases, +the SSL3.0 protocol will be disabled. The system priority file +entries should be formatted as "KEYWORD=VALUE", e.g., +"SYSTEM=NORMAL:+ARCFOUR\-128". + +Special keywords are "!", "\-" and "+". +"!" or "\-" appended with an algorithm will remove this algorithm. +"+" appended with an algorithm will add this algorithm. + +Check the GnuTLS manual section "Priority strings" for detailed +information. +.SH "EXAMPLES" + +"NONE:+VERS\-TLS\-ALL:+MAC\-ALL:+RSA:+AES\-128\-CBC:+SIGN\-ALL:+COMP\-NULL" + +"NORMAL:+ARCFOUR\-128" means normal ciphers plus ARCFOUR\-128. + +"SECURE128:\-VERS\-SSL3.0" means that only secure ciphers are +and enabled, SSL3.0 is disabled. + +"NONE:+VERS\-TLS\-ALL:+AES\-128\-CBC:+RSA:+SHA1:+COMP\-NULL:+SIGN\-RSA\-SHA1", + +"NONE:+VERS\-TLS\-ALL:+AES\-128\-CBC:+ECDHE\-RSA:+SHA1:+COMP\-NULL:+SIGN\-RSA\-SHA1:+CURVE\-SECP256R1", + +"SECURE256:+SECURE128", + +Note that "NORMAL:%COMPAT" is the most compatible mode. + +A \fBNULL\fP \fIpriorities\fP string indicates the default priorities to be +used (this is available since GnuTLS 3.3.0). +.SH "RETURNS" +On syntax error \fBGNUTLS_E_INVALID_REQUEST\fP is returned, +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_kx_list.3 b/doc/manpages/gnutls_priority_kx_list.3 new file mode 100644 index 0000000..1a4bbee --- /dev/null +++ b/doc/manpages/gnutls_priority_kx_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_kx_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_kx_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_kx_list(gnutls_priority_t " pcache ", const unsigned int ** " list ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list +.SH "DESCRIPTION" +Get a list of available key exchange methods in the priority +structure. +.SH "RETURNS" +the number of items, or an error code. +.SH "SINCE" +3.2.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_mac_list.3 b/doc/manpages/gnutls_priority_mac_list.3 new file mode 100644 index 0000000..53ac428 --- /dev/null +++ b/doc/manpages/gnutls_priority_mac_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_mac_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_mac_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_mac_list(gnutls_priority_t " pcache ", const unsigned int ** " list ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list +.SH "DESCRIPTION" +Get a list of available MAC algorithms in the priority +structure. +.SH "RETURNS" +the number of items, or an error code. +.SH "SINCE" +3.2.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_protocol_list.3 b/doc/manpages/gnutls_priority_protocol_list.3 new file mode 100644 index 0000000..bb352a8 --- /dev/null +++ b/doc/manpages/gnutls_priority_protocol_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_protocol_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_protocol_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_protocol_list(gnutls_priority_t " pcache ", const unsigned int ** " list ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list +.SH "DESCRIPTION" +Get a list of available TLS version numbers in the priority +structure. +.SH "RETURNS" +the number of protocols, or an error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_set.3 b/doc/manpages/gnutls_priority_set.3 new file mode 100644 index 0000000..a05ad24 --- /dev/null +++ b/doc/manpages/gnutls_priority_set.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_set" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_set \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_set(gnutls_session_t " session ", gnutls_priority_t " priority ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_priority_t priority" 12 +is a \fBgnutls_priority_t\fP type. +.SH "DESCRIPTION" +Sets the priorities to use on the ciphers, key exchange methods, +and macs. Note that this function is expected to be called once +per session; when called multiple times (e.g., before a re\-handshake, +the caller should make sure that any new settings are not incompatible +with the original session). +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_set_direct.3 b/doc/manpages/gnutls_priority_set_direct.3 new file mode 100644 index 0000000..4bb7143 --- /dev/null +++ b/doc/manpages/gnutls_priority_set_direct.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_set_direct" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_set_direct \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_set_direct(gnutls_session_t " session ", const char * " priorities ", const char ** " err_pos ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const char * priorities" 12 +is a string describing priorities +.IP "const char ** err_pos" 12 +In case of an error this will have the position in the string the error occurred +.SH "DESCRIPTION" +Sets the priorities to use on the ciphers, key exchange methods, +and macs. This function avoids keeping a +priority cache and is used to directly set string priorities to a +TLS session. For documentation check the \fBgnutls_priority_init()\fP. + +To use a reasonable default, consider using \fBgnutls_set_default_priority()\fP, +or \fBgnutls_set_default_priority_append()\fP instead of this function. +.SH "RETURNS" +On syntax error \fBGNUTLS_E_INVALID_REQUEST\fP is returned, +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_sign_list.3 b/doc/manpages/gnutls_priority_sign_list.3 new file mode 100644 index 0000000..412cb18 --- /dev/null +++ b/doc/manpages/gnutls_priority_sign_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_sign_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_sign_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_priority_sign_list(gnutls_priority_t " pcache ", const unsigned int ** " list ");" +.SH ARGUMENTS +.IP "gnutls_priority_t pcache" 12 +is a \fBgnutls_priority_t\fP type. +.IP "const unsigned int ** list" 12 +will point to an integer list +.SH "DESCRIPTION" +Get a list of available signature algorithms in the priority +structure. +.SH "RETURNS" +the number of algorithms, or an error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_priority_string_list.3 b/doc/manpages/gnutls_priority_string_list.3 new file mode 100644 index 0000000..09ddde6 --- /dev/null +++ b/doc/manpages/gnutls_priority_string_list.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_string_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_priority_string_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_priority_string_list(unsigned " iter ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "unsigned iter" 12 +an integer counter starting from zero +.IP "unsigned int flags" 12 +one of \fBGNUTLS_PRIORITY_LIST_INIT_KEYWORDS\fP, \fBGNUTLS_PRIORITY_LIST_SPECIAL\fP +.SH "DESCRIPTION" +Can be used to iterate all available priority strings. +Due to internal implementation details, there are cases where this +function can return the empty string. In that case that string should be ignored. +When no strings are available it returns \fBNULL\fP. +.SH "RETURNS" +a priority string +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_decrypt_data.3 b/doc/manpages/gnutls_privkey_decrypt_data.3 new file mode 100644 index 0000000..a1b0405 --- /dev/null +++ b/doc/manpages/gnutls_privkey_decrypt_data.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_decrypt_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_decrypt_data \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_decrypt_data(gnutls_privkey_t " key ", unsigned int " flags ", const gnutls_datum_t * " ciphertext ", gnutls_datum_t * " plaintext ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the key +.IP "unsigned int flags" 12 +zero for now +.IP "const gnutls_datum_t * ciphertext" 12 +holds the data to be decrypted +.IP "gnutls_datum_t * plaintext" 12 +will contain the decrypted data, allocated with \fBgnutls_malloc()\fP +.SH "DESCRIPTION" +This function will decrypt the given data using the algorithm +supported by the private key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_decrypt_data2.3 b/doc/manpages/gnutls_privkey_decrypt_data2.3 new file mode 100644 index 0000000..b04505b --- /dev/null +++ b/doc/manpages/gnutls_privkey_decrypt_data2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_decrypt_data2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_decrypt_data2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_decrypt_data2(gnutls_privkey_t " key ", unsigned int " flags ", const gnutls_datum_t * " ciphertext ", unsigned char * " plaintext ", size_t " plaintext_size ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the key +.IP "unsigned int flags" 12 +zero for now +.IP "const gnutls_datum_t * ciphertext" 12 +holds the data to be decrypted +.IP "unsigned char * plaintext" 12 +a preallocated buffer that will be filled with the plaintext +.IP "size_t plaintext_size" 12 +in/out size of the plaintext +.SH "DESCRIPTION" +This function will decrypt the given data using the algorithm +supported by the private key. Unlike with \fBgnutls_privkey_decrypt_data()\fP +this function operates in constant time and constant memory access. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_deinit.3 b/doc/manpages/gnutls_privkey_deinit.3 new file mode 100644 index 0000000..b3bd156 --- /dev/null +++ b/doc/manpages/gnutls_privkey_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "void gnutls_privkey_deinit(gnutls_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +The key to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a private key structure. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_dsa_raw.3 b/doc/manpages/gnutls_privkey_export_dsa_raw.3 new file mode 100644 index 0000000..f83f56b --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_dsa_raw.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_dsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_dsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_dsa_raw(gnutls_privkey_t " key ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ", gnutls_datum_t * " x ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the public key +.IP "gnutls_datum_t * p" 12 +will hold the p +.IP "gnutls_datum_t * q" 12 +will hold the q +.IP "gnutls_datum_t * g" 12 +will hold the g +.IP "gnutls_datum_t * y" 12 +will hold the y +.IP "gnutls_datum_t * x" 12 +will hold the x +.SH "DESCRIPTION" +This function will export the DSA private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_dsa_raw2.3 b/doc/manpages/gnutls_privkey_export_dsa_raw2.3 new file mode 100644 index 0000000..112f1af --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_dsa_raw2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_dsa_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_dsa_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_dsa_raw2(gnutls_privkey_t " key ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ", gnutls_datum_t * " x ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the public key +.IP "gnutls_datum_t * p" 12 +will hold the p +.IP "gnutls_datum_t * q" 12 +will hold the q +.IP "gnutls_datum_t * g" 12 +will hold the g +.IP "gnutls_datum_t * y" 12 +will hold the y +.IP "gnutls_datum_t * x" 12 +will hold the x +.IP "unsigned int flags" 12 +flags from \fBgnutls_abstract_export_flags_t\fP +.SH "DESCRIPTION" +This function will export the DSA private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_ecc_raw.3 b/doc/manpages/gnutls_privkey_export_ecc_raw.3 new file mode 100644 index 0000000..496d1cc --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_ecc_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_ecc_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_ecc_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_ecc_raw(gnutls_privkey_t " key ", gnutls_ecc_curve_t * " curve ", gnutls_datum_t * " x ", gnutls_datum_t * " y ", gnutls_datum_t * " k ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the public key +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve +.IP "gnutls_datum_t * x" 12 +will hold the x\-coordinate +.IP "gnutls_datum_t * y" 12 +will hold the y\-coordinate +.IP "gnutls_datum_t * k" 12 +will hold the private key +.SH "DESCRIPTION" +This function will export the ECC private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +In EdDSA curves the \fIy\fP parameter will be \fBNULL\fP and the other parameters +will be in the native format for the curve. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_ecc_raw2.3 b/doc/manpages/gnutls_privkey_export_ecc_raw2.3 new file mode 100644 index 0000000..55220dd --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_ecc_raw2.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_ecc_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_ecc_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_ecc_raw2(gnutls_privkey_t " key ", gnutls_ecc_curve_t * " curve ", gnutls_datum_t * " x ", gnutls_datum_t * " y ", gnutls_datum_t * " k ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the public key +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve +.IP "gnutls_datum_t * x" 12 +will hold the x\-coordinate +.IP "gnutls_datum_t * y" 12 +will hold the y\-coordinate +.IP "gnutls_datum_t * k" 12 +will hold the private key +.IP "unsigned int flags" 12 +flags from \fBgnutls_abstract_export_flags_t\fP +.SH "DESCRIPTION" +This function will export the ECC private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +In EdDSA curves the \fIy\fP parameter will be \fBNULL\fP and the other parameters +will be in the native format for the curve. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_gost_raw2.3 b/doc/manpages/gnutls_privkey_export_gost_raw2.3 new file mode 100644 index 0000000..4a3dd48 --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_gost_raw2.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_gost_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_gost_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_gost_raw2(gnutls_privkey_t " key ", gnutls_ecc_curve_t * " curve ", gnutls_digest_algorithm_t * " digest ", gnutls_gost_paramset_t * " paramset ", gnutls_datum_t * " x ", gnutls_datum_t * " y ", gnutls_datum_t * " k ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the public key +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve +.IP "gnutls_digest_algorithm_t * digest" 12 +will hold the digest +.IP "gnutls_gost_paramset_t * paramset" 12 +will hold the GOST parameter set ID +.IP "gnutls_datum_t * x" 12 +will hold the x\-coordinate +.IP "gnutls_datum_t * y" 12 +will hold the y\-coordinate +.IP "gnutls_datum_t * k" 12 +will hold the private key +.IP "unsigned int flags" 12 +flags from \fBgnutls_abstract_export_flags_t\fP +.SH "DESCRIPTION" +This function will export the GOST private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "NOTE" +parameters will be stored with least significant byte first. On +version 3.6.3 this was incorrectly returned in big\-endian format. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_openpgp.3 b/doc/manpages/gnutls_privkey_export_openpgp.3 new file mode 100644 index 0000000..3b78110 --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_openpgp.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_openpgp" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_openpgp \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_openpgp(gnutls_privkey_t " pkey ", gnutls_openpgp_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "gnutls_openpgp_privkey_t * key" 12 +Location for the key to be exported. +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_pkcs11.3 b/doc/manpages/gnutls_privkey_export_pkcs11.3 new file mode 100644 index 0000000..d9cd64a --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_pkcs11.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_pkcs11" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_pkcs11 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_pkcs11(gnutls_privkey_t " pkey ", gnutls_pkcs11_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "gnutls_pkcs11_privkey_t * key" 12 +Location for the key to be exported. +.SH "DESCRIPTION" +Converts the given abstract private key to a \fBgnutls_pkcs11_privkey_t\fP +type. The key must be of type \fBGNUTLS_PRIVKEY_PKCS11\fP. The key +returned in \fIkey\fP must be deinitialized with +\fBgnutls_pkcs11_privkey_deinit()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_rsa_raw.3 b/doc/manpages/gnutls_privkey_export_rsa_raw.3 new file mode 100644 index 0000000..ff0b321 --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_rsa_raw.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_rsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_rsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_rsa_raw(gnutls_privkey_t " key ", gnutls_datum_t * " m ", gnutls_datum_t * " e ", gnutls_datum_t * " d ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " u ", gnutls_datum_t * " e1 ", gnutls_datum_t * " e2 ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the certificate +.IP "gnutls_datum_t * m" 12 +will hold the modulus +.IP "gnutls_datum_t * e" 12 +will hold the public exponent +.IP "gnutls_datum_t * d" 12 +will hold the private exponent +.IP "gnutls_datum_t * p" 12 +will hold the first prime (p) +.IP "gnutls_datum_t * q" 12 +will hold the second prime (q) +.IP "gnutls_datum_t * u" 12 +will hold the coefficient +.IP "gnutls_datum_t * e1" 12 +will hold e1 = d mod (p\-1) +.IP "gnutls_datum_t * e2" 12 +will hold e2 = d mod (q\-1) +.SH "DESCRIPTION" +This function will export the RSA private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. For +EdDSA keys, the \fIy\fP value should be \fBNULL\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_rsa_raw2.3 b/doc/manpages/gnutls_privkey_export_rsa_raw2.3 new file mode 100644 index 0000000..a08b3b6 --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_rsa_raw2.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_rsa_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_rsa_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_rsa_raw2(gnutls_privkey_t " key ", gnutls_datum_t * " m ", gnutls_datum_t * " e ", gnutls_datum_t * " d ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " u ", gnutls_datum_t * " e1 ", gnutls_datum_t * " e2 ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the certificate +.IP "gnutls_datum_t * m" 12 +will hold the modulus +.IP "gnutls_datum_t * e" 12 +will hold the public exponent +.IP "gnutls_datum_t * d" 12 +will hold the private exponent +.IP "gnutls_datum_t * p" 12 +will hold the first prime (p) +.IP "gnutls_datum_t * q" 12 +will hold the second prime (q) +.IP "gnutls_datum_t * u" 12 +will hold the coefficient +.IP "gnutls_datum_t * e1" 12 +will hold e1 = d mod (p\-1) +.IP "gnutls_datum_t * e2" 12 +will hold e2 = d mod (q\-1) +.IP "unsigned int flags" 12 +flags from \fBgnutls_abstract_export_flags_t\fP +.SH "DESCRIPTION" +This function will export the RSA private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_export_x509.3 b/doc/manpages/gnutls_privkey_export_x509.3 new file mode 100644 index 0000000..7ad0631 --- /dev/null +++ b/doc/manpages/gnutls_privkey_export_x509.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_export_x509" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_export_x509 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_export_x509(gnutls_privkey_t " pkey ", gnutls_x509_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "gnutls_x509_privkey_t * key" 12 +Location for the key to be exported. +.SH "DESCRIPTION" +Converts the given abstract private key to a \fBgnutls_x509_privkey_t\fP +type. The abstract key must be of type \fBGNUTLS_PRIVKEY_X509\fP. The input + \fIkey\fP must not be initialized. The key returned in \fIkey\fP should be deinitialized +using \fBgnutls_x509_privkey_deinit()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_generate.3 b/doc/manpages/gnutls_privkey_generate.3 new file mode 100644 index 0000000..9ffb0b6 --- /dev/null +++ b/doc/manpages/gnutls_privkey_generate.3 @@ -0,0 +1,63 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_generate" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_generate \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_generate(gnutls_privkey_t " pkey ", gnutls_pk_algorithm_t " algo ", unsigned int " bits ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +An initialized private key +.IP "gnutls_pk_algorithm_t algo" 12 +is one of the algorithms in \fBgnutls_pk_algorithm_t\fP. +.IP "unsigned int bits" 12 +the size of the parameters to generate +.IP "unsigned int flags" 12 +Must be zero or flags from \fBgnutls_privkey_flags_t\fP. +.SH "DESCRIPTION" +This function will generate a random private key. Note that this +function must be called on an initialized private key. + +The flag \fBGNUTLS_PRIVKEY_FLAG_PROVABLE\fP +instructs the key generation process to use algorithms like Shawe\-Taylor +(from FIPS PUB186\-4) which generate provable parameters out of a seed +for RSA and DSA keys. See \fBgnutls_privkey_generate2()\fP for more +information. + +Note that when generating an elliptic curve key, the curve +can be substituted in the place of the bits parameter using the +\fBGNUTLS_CURVE_TO_BITS()\fP macro. The input to the macro is any curve from +\fBgnutls_ecc_curve_t\fP. + +For DSA keys, if the subgroup size needs to be specified check +the \fBGNUTLS_SUBGROUP_TO_BITS()\fP macro. + +It is recommended to do not set the number of \fIbits\fP directly, use \fBgnutls_sec_param_to_pk_bits()\fP instead . + +See also \fBgnutls_privkey_generate2()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_generate2.3 b/doc/manpages/gnutls_privkey_generate2.3 new file mode 100644 index 0000000..71e9218 --- /dev/null +++ b/doc/manpages/gnutls_privkey_generate2.3 @@ -0,0 +1,72 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_generate2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_generate2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_generate2(gnutls_privkey_t " pkey ", gnutls_pk_algorithm_t " algo ", unsigned int " bits ", unsigned int " flags ", const gnutls_keygen_data_st * " data ", unsigned " data_size ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "gnutls_pk_algorithm_t algo" 12 +is one of the algorithms in \fBgnutls_pk_algorithm_t\fP. +.IP "unsigned int bits" 12 +the size of the modulus +.IP "unsigned int flags" 12 +Must be zero or flags from \fBgnutls_privkey_flags_t\fP. +.IP "const gnutls_keygen_data_st * data" 12 +Allow specifying \fBgnutls_keygen_data_st\fP types such as the seed to be used. +.IP "unsigned data_size" 12 +The number of \fIdata\fP available. +.SH "DESCRIPTION" +This function will generate a random private key. Note that this +function must be called on an initialized private key. + +The flag \fBGNUTLS_PRIVKEY_FLAG_PROVABLE\fP +instructs the key generation process to use algorithms like Shawe\-Taylor +(from FIPS PUB186\-4) which generate provable parameters out of a seed +for RSA and DSA keys. On DSA keys the PQG parameters are generated using the +seed, while on RSA the two primes. To specify an explicit seed +(by default a random seed is used), use the \fIdata\fP with a \fBGNUTLS_KEYGEN_SEED\fP +type. + +Note that when generating an elliptic curve key, the curve +can be substituted in the place of the bits parameter using the +\fBGNUTLS_CURVE_TO_BITS()\fP macro. + +To export the generated keys in memory or in files it is recommended to use the +PKCS\fB8\fP form as it can handle all key types, and can store additional parameters +such as the seed, in case of provable RSA or DSA keys. +Generated keys can be exported in memory using \fBgnutls_privkey_export_x509()\fP, +and then with \fBgnutls_x509_privkey_export2_pkcs8()\fP. + +If key generation is part of your application, avoid setting the number +of bits directly, and instead use \fBgnutls_sec_param_to_pk_bits()\fP. +That way the generated keys will adapt to the security levels +of the underlying GnuTLS library. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_get_pk_algorithm.3 b/doc/manpages/gnutls_privkey_get_pk_algorithm.3 new file mode 100644 index 0000000..2251f04 --- /dev/null +++ b/doc/manpages/gnutls_privkey_get_pk_algorithm.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_get_pk_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_get_pk_algorithm(gnutls_privkey_t " key ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +should contain a \fBgnutls_privkey_t\fP type +.IP "unsigned int * bits" 12 +If set will return the number of bits of the parameters (may be NULL) +.SH "DESCRIPTION" +This function will return the public key algorithm of a private +key and if possible will return a number of bits that indicates +the security parameter of the key. +.SH "RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or a negative error code on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_get_seed.3 b/doc/manpages/gnutls_privkey_get_seed.3 new file mode 100644 index 0000000..b992d41 --- /dev/null +++ b/doc/manpages/gnutls_privkey_get_seed.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_get_seed" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_get_seed \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_get_seed(gnutls_privkey_t " key ", gnutls_digest_algorithm_t * " digest ", void * " seed ", size_t * " seed_size ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +should contain a \fBgnutls_privkey_t\fP type +.IP "gnutls_digest_algorithm_t * digest" 12 +if non\-NULL it will contain the digest algorithm used for key generation (if applicable) +.IP "void * seed" 12 +where seed will be copied to +.IP "size_t * seed_size" 12 +originally holds the size of \fIseed\fP , will be updated with actual size +.SH "DESCRIPTION" +This function will return the seed that was used to generate the +given private key. That function will succeed only if the key was generated +as a provable key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_get_spki.3 b/doc/manpages/gnutls_privkey_get_spki.3 new file mode 100644 index 0000000..5d980a9 --- /dev/null +++ b/doc/manpages/gnutls_privkey_get_spki.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_get_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_get_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_get_spki(gnutls_privkey_t " privkey ", gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t privkey" 12 +a public key of type \fBgnutls_privkey_t\fP +.IP "gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_privkey_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will return the public key information if available. +The provided \fIspki\fP must be initialized. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_get_type.3 b/doc/manpages/gnutls_privkey_get_type.3 new file mode 100644 index 0000000..3973329 --- /dev/null +++ b/doc/manpages/gnutls_privkey_get_type.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_get_type" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_get_type \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "gnutls_privkey_type_t gnutls_privkey_get_type(gnutls_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +should contain a \fBgnutls_privkey_t\fP type +.SH "DESCRIPTION" +This function will return the type of the private key. This is +actually the type of the subsystem used to set this private key. +.SH "RETURNS" +a member of the \fBgnutls_privkey_type_t\fP enumeration on +success, or a negative error code on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_dsa_raw.3 b/doc/manpages/gnutls_privkey_import_dsa_raw.3 new file mode 100644 index 0000000..986e7b8 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_dsa_raw.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_dsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_dsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_dsa_raw(gnutls_privkey_t " key ", const gnutls_datum_t * " p ", const gnutls_datum_t * " q ", const gnutls_datum_t * " g ", const gnutls_datum_t * " y ", const gnutls_datum_t * " x ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +The structure to store the parsed key +.IP "const gnutls_datum_t * p" 12 +holds the p +.IP "const gnutls_datum_t * q" 12 +holds the q +.IP "const gnutls_datum_t * g" 12 +holds the g +.IP "const gnutls_datum_t * y" 12 +holds the y (optional) +.IP "const gnutls_datum_t * x" 12 +holds the x +.SH "DESCRIPTION" +This function will convert the given DSA raw parameters to the +native \fBgnutls_privkey_t\fP format. The output will be stored +in \fIkey\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_ecc_raw.3 b/doc/manpages/gnutls_privkey_import_ecc_raw.3 new file mode 100644 index 0000000..1b2d197 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_ecc_raw.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_ecc_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_ecc_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_ecc_raw(gnutls_privkey_t " key ", gnutls_ecc_curve_t " curve ", const gnutls_datum_t * " x ", const gnutls_datum_t * " y ", const gnutls_datum_t * " k ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +The key +.IP "gnutls_ecc_curve_t curve" 12 +holds the curve +.IP "const gnutls_datum_t * x" 12 +holds the x\-coordinate +.IP "const gnutls_datum_t * y" 12 +holds the y\-coordinate +.IP "const gnutls_datum_t * k" 12 +holds the k (private key) +.SH "DESCRIPTION" +This function will convert the given elliptic curve parameters to the +native \fBgnutls_privkey_t\fP format. The output will be stored +in \fIkey\fP . + +In EdDSA curves the \fIy\fP parameter should be \fBNULL\fP and the \fIx\fP and \fIk\fP parameters +must be in the native format for the curve. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_ext.3 b/doc/manpages/gnutls_privkey_import_ext.3 new file mode 100644 index 0000000..1a0f240 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_ext.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_ext" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_ext \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_ext(gnutls_privkey_t " pkey ", gnutls_pk_algorithm_t " pk ", void * " userdata ", gnutls_privkey_sign_func " sign_func ", gnutls_privkey_decrypt_func " decrypt_func ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "gnutls_pk_algorithm_t pk" 12 +The public key algorithm +.IP "void * userdata" 12 +private data to be provided to the callbacks +.IP "gnutls_privkey_sign_func sign_func" 12 +callback for signature operations +.IP "gnutls_privkey_decrypt_func decrypt_func" 12 +callback for decryption operations +.IP "unsigned int flags" 12 +Flags for the import +.SH "DESCRIPTION" +This function will associate the given callbacks with the +\fBgnutls_privkey_t\fP type. At least one of the two callbacks +must be non\-null. + +Note that the signing function is supposed to "raw" sign data, i.e., +without any hashing or preprocessing. In case of RSA the DigestInfo +will be provided, and the signing function is expected to do the PKCS \fB1\fP +1.5 padding and the exponentiation. + +See also \fBgnutls_privkey_import_ext3()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_ext2.3 b/doc/manpages/gnutls_privkey_import_ext2.3 new file mode 100644 index 0000000..083a4d5 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_ext2.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_ext2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_ext2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_ext2(gnutls_privkey_t " pkey ", gnutls_pk_algorithm_t " pk ", void * " userdata ", gnutls_privkey_sign_func " sign_fn ", gnutls_privkey_decrypt_func " decrypt_fn ", gnutls_privkey_deinit_func " deinit_fn ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "gnutls_pk_algorithm_t pk" 12 +The public key algorithm +.IP "void * userdata" 12 +private data to be provided to the callbacks +.IP "gnutls_privkey_sign_func sign_fn" 12 +callback for signature operations +.IP "gnutls_privkey_decrypt_func decrypt_fn" 12 +callback for decryption operations +.IP "gnutls_privkey_deinit_func deinit_fn" 12 +a deinitialization function +.IP "unsigned int flags" 12 +Flags for the import +.SH "DESCRIPTION" +This function will associate the given callbacks with the +\fBgnutls_privkey_t\fP type. At least one of the two callbacks +must be non\-null. If a deinitialization function is provided +then flags is assumed to contain \fBGNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE\fP. + +Note that the signing function is supposed to "raw" sign data, i.e., +without any hashing or preprocessing. In case of RSA the DigestInfo +will be provided, and the signing function is expected to do the PKCS \fB1\fP +1.5 padding and the exponentiation. + +See also \fBgnutls_privkey_import_ext3()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_ext3.3 b/doc/manpages/gnutls_privkey_import_ext3.3 new file mode 100644 index 0000000..8e7db2b --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_ext3.3 @@ -0,0 +1,62 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_ext3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_ext3 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_ext3(gnutls_privkey_t " pkey ", void * " userdata ", gnutls_privkey_sign_func " sign_fn ", gnutls_privkey_decrypt_func " decrypt_fn ", gnutls_privkey_deinit_func " deinit_fn ", gnutls_privkey_info_func " info_fn ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "void * userdata" 12 +private data to be provided to the callbacks +.IP "gnutls_privkey_sign_func sign_fn" 12 +callback for signature operations +.IP "gnutls_privkey_decrypt_func decrypt_fn" 12 +callback for decryption operations +.IP "gnutls_privkey_deinit_func deinit_fn" 12 +a deinitialization function +.IP "gnutls_privkey_info_func info_fn" 12 +returns info about the public key algorithm (should not be \fBNULL\fP) +.IP "unsigned int flags" 12 +Flags for the import +.SH "DESCRIPTION" +This function will associate the given callbacks with the +\fBgnutls_privkey_t\fP type. At least one of the two callbacks +must be non\-null. If a deinitialization function is provided +then flags is assumed to contain \fBGNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE\fP. + +Note that the signing function is supposed to "raw" sign data, i.e., +without any hashing or preprocessing. In case of RSA the DigestInfo +will be provided, and the signing function is expected to do the PKCS \fB1\fP +1.5 padding and the exponentiation. + +The \fIinfo_fn\fP must provide information on the algorithms supported by +this private key, and should support the flags \fBGNUTLS_PRIVKEY_INFO_PK_ALGO\fP and +\fBGNUTLS_PRIVKEY_INFO_SIGN_ALGO\fP. It must return \-1 on unknown flags. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_ext4.3 b/doc/manpages/gnutls_privkey_import_ext4.3 new file mode 100644 index 0000000..f1c479f --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_ext4.3 @@ -0,0 +1,80 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_ext4" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_ext4 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_ext4(gnutls_privkey_t " pkey ", void * " userdata ", gnutls_privkey_sign_data_func " sign_data_fn ", gnutls_privkey_sign_hash_func " sign_hash_fn ", gnutls_privkey_decrypt_func " decrypt_fn ", gnutls_privkey_deinit_func " deinit_fn ", gnutls_privkey_info_func " info_fn ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "void * userdata" 12 +private data to be provided to the callbacks +.IP "gnutls_privkey_sign_data_func sign_data_fn" 12 +callback for signature operations (may be \fBNULL\fP) +.IP "gnutls_privkey_sign_hash_func sign_hash_fn" 12 +callback for signature operations (may be \fBNULL\fP) +.IP "gnutls_privkey_decrypt_func decrypt_fn" 12 +callback for decryption operations (may be \fBNULL\fP) +.IP "gnutls_privkey_deinit_func deinit_fn" 12 +a deinitialization function +.IP "gnutls_privkey_info_func info_fn" 12 +returns info about the public key algorithm (should not be \fBNULL\fP) +.IP "unsigned int flags" 12 +Flags for the import +.SH "DESCRIPTION" +This function will associate the given callbacks with the +\fBgnutls_privkey_t\fP type. At least one of the callbacks +must be non\-null. If a deinitialization function is provided +then flags is assumed to contain \fBGNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE\fP. + +Note that in contrast with the signing function of +\fBgnutls_privkey_import_ext3()\fP, the signing functions provided to this +function take explicitly the signature algorithm as parameter and +different functions are provided to sign the data and hashes. + +The \fIsign_hash_fn\fP is to be called to sign pre\-hashed data. The input +to the callback is the output of the hash (such as SHA256) corresponding +to the signature algorithm. For RSA PKCS\fB1\fP signatures, the signature +algorithm can be set to \fBGNUTLS_SIGN_RSA_RAW\fP, and in that case the data +should be handled as if they were an RSA PKCS\fB1\fP DigestInfo structure. + +The \fIsign_data_fn\fP is to be called to sign data. The input data will be +he data to be signed (and hashed), with the provided signature +algorithm. This function is to be used for signature algorithms like +Ed25519 which cannot take pre\-hashed data as input. + +When both \fIsign_data_fn\fP and \fIsign_hash_fn\fP functions are provided they +must be able to operate on all the supported signature algorithms, +unless prohibited by the type of the algorithm (e.g., as with Ed25519). + +The \fIinfo_fn\fP must provide information on the signature algorithms supported by +this private key, and should support the flags \fBGNUTLS_PRIVKEY_INFO_PK_ALGO\fP, +\fBGNUTLS_PRIVKEY_INFO_HAVE_SIGN_ALGO\fP and \fBGNUTLS_PRIVKEY_INFO_PK_ALGO_BITS\fP. +It must return \-1 on unknown flags. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_gost_raw.3 b/doc/manpages/gnutls_privkey_import_gost_raw.3 new file mode 100644 index 0000000..6b98cc8 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_gost_raw.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_gost_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_gost_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_gost_raw(gnutls_privkey_t " key ", gnutls_ecc_curve_t " curve ", gnutls_digest_algorithm_t " digest ", gnutls_gost_paramset_t " paramset ", const gnutls_datum_t * " x ", const gnutls_datum_t * " y ", const gnutls_datum_t * " k ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +The key +.IP "gnutls_ecc_curve_t curve" 12 +holds the curve +.IP "gnutls_digest_algorithm_t digest" 12 +holds the digest +.IP "gnutls_gost_paramset_t paramset" 12 +holds the GOST parameter set ID +.IP "const gnutls_datum_t * x" 12 +holds the x\-coordinate +.IP "const gnutls_datum_t * y" 12 +holds the y\-coordinate +.IP "const gnutls_datum_t * k" 12 +holds the k (private key) +.SH "DESCRIPTION" +This function will convert the given GOST private key's parameters to the +native \fBgnutls_privkey_t\fP format. The output will be stored +in \fIkey\fP . \fIdigest\fP should be one of GNUTLS_DIG_GOSR_94, +GNUTLS_DIG_STREEBOG_256 or GNUTLS_DIG_STREEBOG_512. If \fIparamset\fP is set to +GNUTLS_GOST_PARAMSET_UNKNOWN default one will be selected depending on + \fIdigest\fP . +.SH "NOTE" +parameters should be stored with least significant byte first. On +version 3.6.3 big\-endian format was used incorrectly. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_openpgp.3 b/doc/manpages/gnutls_privkey_import_openpgp.3 new file mode 100644 index 0000000..b57fcd1 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_openpgp.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_openpgp" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_openpgp \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_openpgp(gnutls_privkey_t " pkey ", gnutls_openpgp_privkey_t " key ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "gnutls_openpgp_privkey_t key" 12 +The private key to be imported +.IP "unsigned int flags" 12 +Flags for the import +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_openpgp_raw.3 b/doc/manpages/gnutls_privkey_import_openpgp_raw.3 new file mode 100644 index 0000000..9b3e658 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_openpgp_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_openpgp_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_openpgp_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_openpgp_raw(gnutls_privkey_t " pkey ", const gnutls_datum_t * " data ", gnutls_openpgp_crt_fmt_t " format ", const gnutls_openpgp_keyid_t " keyid ", const char * " password ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "const gnutls_datum_t * data" 12 +The private key data to be imported +.IP "gnutls_openpgp_crt_fmt_t format" 12 +The format of the private key +.IP "const gnutls_openpgp_keyid_t keyid" 12 +The key id to use (optional) +.IP "const char * password" 12 +A password (optional) +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_pkcs11.3 b/doc/manpages/gnutls_privkey_import_pkcs11.3 new file mode 100644 index 0000000..f388396 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_pkcs11.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_pkcs11" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_pkcs11 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_pkcs11(gnutls_privkey_t " pkey ", gnutls_pkcs11_privkey_t " key ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "gnutls_pkcs11_privkey_t key" 12 +The private key to be imported +.IP "unsigned int flags" 12 +Flags for the import +.SH "DESCRIPTION" +This function will import the given private key to the abstract +\fBgnutls_privkey_t\fP type. + +The \fBgnutls_pkcs11_privkey_t\fP object must not be deallocated +during the lifetime of this structure. + + \fIflags\fP might be zero or one of \fBGNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE\fP +and \fBGNUTLS_PRIVKEY_IMPORT_COPY\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_pkcs11_url.3 b/doc/manpages/gnutls_privkey_import_pkcs11_url.3 new file mode 100644 index 0000000..e08f006 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_pkcs11_url.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_pkcs11_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_pkcs11_url \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_pkcs11_url(gnutls_privkey_t " key ", const char * " url ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +A key of type \fBgnutls_pubkey_t\fP +.IP "const char * url" 12 +A PKCS 11 url +.SH "DESCRIPTION" +This function will import a PKCS 11 private key to a \fBgnutls_private_key_t\fP +type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_rsa_raw.3 b/doc/manpages/gnutls_privkey_import_rsa_raw.3 new file mode 100644 index 0000000..282c137 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_rsa_raw.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_rsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_rsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_rsa_raw(gnutls_privkey_t " key ", const gnutls_datum_t * " m ", const gnutls_datum_t * " e ", const gnutls_datum_t * " d ", const gnutls_datum_t * " p ", const gnutls_datum_t * " q ", const gnutls_datum_t * " u ", const gnutls_datum_t * " e1 ", const gnutls_datum_t * " e2 ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +The structure to store the parsed key +.IP "const gnutls_datum_t * m" 12 +holds the modulus +.IP "const gnutls_datum_t * e" 12 +holds the public exponent +.IP "const gnutls_datum_t * d" 12 +holds the private exponent (optional) +.IP "const gnutls_datum_t * p" 12 +holds the first prime (p) +.IP "const gnutls_datum_t * q" 12 +holds the second prime (q) +.IP "const gnutls_datum_t * u" 12 +holds the coefficient (optional) +.IP "const gnutls_datum_t * e1" 12 +holds e1 = d mod (p\-1) (optional) +.IP "const gnutls_datum_t * e2" 12 +holds e2 = d mod (q\-1) (optional) +.SH "DESCRIPTION" +This function will convert the given RSA raw parameters to the +native \fBgnutls_privkey_t\fP format. The output will be stored in + \fIkey\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_tpm_raw.3 b/doc/manpages/gnutls_privkey_import_tpm_raw.3 new file mode 100644 index 0000000..00c7e4a --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_tpm_raw.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_tpm_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_tpm_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_tpm_raw(gnutls_privkey_t " pkey ", const gnutls_datum_t * " fdata ", gnutls_tpmkey_fmt_t " format ", const char * " srk_password ", const char * " key_password ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "const gnutls_datum_t * fdata" 12 +The TPM key to be imported +.IP "gnutls_tpmkey_fmt_t format" 12 +The format of the private key +.IP "const char * srk_password" 12 +The password for the SRK key (optional) +.IP "const char * key_password" 12 +A password for the key (optional) +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will import the given private key to the abstract +\fBgnutls_privkey_t\fP type. + +With respect to passwords the same as in \fBgnutls_privkey_import_tpm_url()\fP apply. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_tpm_url.3 b/doc/manpages/gnutls_privkey_import_tpm_url.3 new file mode 100644 index 0000000..339623b --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_tpm_url.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_tpm_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_tpm_url \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_tpm_url(gnutls_privkey_t " pkey ", const char * " url ", const char * " srk_password ", const char * " key_password ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "const char * url" 12 +The URL of the TPM key to be imported +.IP "const char * srk_password" 12 +The password for the SRK key (optional) +.IP "const char * key_password" 12 +A password for the key (optional) +.IP "unsigned int flags" 12 +One of the GNUTLS_PRIVKEY_* flags +.SH "DESCRIPTION" +This function will import the given private key to the abstract +\fBgnutls_privkey_t\fP type. + +Note that unless \fBGNUTLS_PRIVKEY_DISABLE_CALLBACKS\fP +is specified, if incorrect (or NULL) passwords are given +the PKCS11 callback functions will be used to obtain the +correct passwords. Otherwise if the SRK password is wrong +\fBGNUTLS_E_TPM_SRK_PASSWORD_ERROR\fP is returned and if the key password +is wrong or not provided then \fBGNUTLS_E_TPM_KEY_PASSWORD_ERROR\fP +is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_url.3 b/doc/manpages/gnutls_privkey_import_url.3 new file mode 100644 index 0000000..285acd3 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_url.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_url \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_url(gnutls_privkey_t " key ", const char * " url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +A key of type \fBgnutls_privkey_t\fP +.IP "const char * url" 12 +A PKCS 11 url +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will import a PKCS11 or TPM URL as a +private key. The supported URL types can be checked +using \fBgnutls_url_is_supported()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_x509.3 b/doc/manpages/gnutls_privkey_import_x509.3 new file mode 100644 index 0000000..b685bf2 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_x509.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_x509" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_x509 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_x509(gnutls_privkey_t " pkey ", gnutls_x509_privkey_t " key ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "gnutls_x509_privkey_t key" 12 +The private key to be imported +.IP "unsigned int flags" 12 +Flags for the import +.SH "DESCRIPTION" +This function will import the given private key to the abstract +\fBgnutls_privkey_t\fP type. + +The \fBgnutls_x509_privkey_t\fP object must not be deallocated +during the lifetime of this structure. + + \fIflags\fP might be zero or one of \fBGNUTLS_PRIVKEY_IMPORT_AUTO_RELEASE\fP +and \fBGNUTLS_PRIVKEY_IMPORT_COPY\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_import_x509_raw.3 b/doc/manpages/gnutls_privkey_import_x509_raw.3 new file mode 100644 index 0000000..8642ae8 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_x509_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_x509_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_x509_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_import_x509_raw(gnutls_privkey_t " pkey ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", const char * " password ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "const gnutls_datum_t * data" 12 +The private key data to be imported +.IP "gnutls_x509_crt_fmt_t format" 12 +The format of the private key +.IP "const char * password" 12 +A password (optional) +.IP "unsigned int flags" 12 +an ORed sequence of gnutls_pkcs_encrypt_flags_t +.SH "DESCRIPTION" +This function will import the given private key to the abstract +\fBgnutls_privkey_t\fP type. + +The supported formats are basic unencrypted key, PKCS8, PKCS12, +TSS2, and the openssl format. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_init.3 b/doc/manpages/gnutls_privkey_init.3 new file mode 100644 index 0000000..8507026 --- /dev/null +++ b/doc/manpages/gnutls_privkey_init.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_init \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_init(gnutls_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t * key" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a private key object. The object can +be used to generate, import, and perform cryptographic operations +on the associated private key. + +Note that when the underlying private key is a PKCS\fB11\fP key (i.e., +when imported with a PKCS\fB11\fP URI), the limitations of \fBgnutls_pkcs11_privkey_init()\fP +apply to this object as well. In versions of GnuTLS later than 3.5.11 the object +is protected using locks and a single \fBgnutls_privkey_t\fP can be re\-used +by many threads. However, for performance it is recommended to utilize +one object per key per thread. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_set_flags.3 b/doc/manpages/gnutls_privkey_set_flags.3 new file mode 100644 index 0000000..60255f5 --- /dev/null +++ b/doc/manpages/gnutls_privkey_set_flags.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_set_flags" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_set_flags \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "void gnutls_privkey_set_flags(gnutls_privkey_t " key ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +A key of type \fBgnutls_privkey_t\fP +.IP "unsigned int flags" 12 +flags from the \fBgnutls_privkey_flags\fP +.SH "DESCRIPTION" +This function will set flags for the specified private key, after +it is generated. Currently this is useful for the \fBGNUTLS_PRIVKEY_FLAG_EXPORT_COMPAT\fP +to allow exporting a "provable" private key in backwards compatible way. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_set_pin_function.3 b/doc/manpages/gnutls_privkey_set_pin_function.3 new file mode 100644 index 0000000..cb1a7c1 --- /dev/null +++ b/doc/manpages/gnutls_privkey_set_pin_function.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_set_pin_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_set_pin_function \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "void gnutls_privkey_set_pin_function(gnutls_privkey_t " key ", gnutls_pin_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +A key of type \fBgnutls_privkey_t\fP +.IP "gnutls_pin_callback_t fn" 12 +the callback +.IP "void * userdata" 12 +data associated with the callback +.SH "DESCRIPTION" +This function will set a callback function to be used when +required to access the object. This function overrides any other +global PIN functions. + +Note that this function must be called right after initialization +to have effect. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_set_spki.3 b/doc/manpages/gnutls_privkey_set_spki.3 new file mode 100644 index 0000000..aa5e9d7 --- /dev/null +++ b/doc/manpages/gnutls_privkey_set_spki.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_set_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_set_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_set_spki(gnutls_privkey_t " privkey ", const gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t privkey" 12 +a public key of type \fBgnutls_privkey_t\fP +.IP "const gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_privkey_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will set the public key information. +The provided \fIspki\fP must be initialized. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_sign_data.3 b/doc/manpages/gnutls_privkey_sign_data.3 new file mode 100644 index 0000000..cf26ab3 --- /dev/null +++ b/doc/manpages/gnutls_privkey_sign_data.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_sign_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_sign_data \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_sign_data(gnutls_privkey_t " signer ", gnutls_digest_algorithm_t " hash ", unsigned int " flags ", const gnutls_datum_t * " data ", gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t signer" 12 +Holds the key +.IP "gnutls_digest_algorithm_t hash" 12 +should be a digest algorithm +.IP "unsigned int flags" 12 +Zero or one of \fBgnutls_privkey_flags_t\fP +.IP "const gnutls_datum_t * data" 12 +holds the data to be signed +.IP "gnutls_datum_t * signature" 12 +will contain the signature allocated with \fBgnutls_malloc()\fP +.SH "DESCRIPTION" +This function will sign the given data using a signature algorithm +supported by the private key. Signature algorithms are always used +together with a hash functions. Different hash functions may be +used for the RSA algorithm, but only the SHA family for the DSA keys. + +You may use \fBgnutls_pubkey_get_preferred_hash_algorithm()\fP to determine +the hash algorithm. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_sign_data2.3 b/doc/manpages/gnutls_privkey_sign_data2.3 new file mode 100644 index 0000000..49f2d55 --- /dev/null +++ b/doc/manpages/gnutls_privkey_sign_data2.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_sign_data2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_sign_data2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_sign_data2(gnutls_privkey_t " signer ", gnutls_sign_algorithm_t " algo ", unsigned int " flags ", const gnutls_datum_t * " data ", gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t signer" 12 +Holds the key +.IP "gnutls_sign_algorithm_t algo" 12 +The signature algorithm used +.IP "unsigned int flags" 12 +Zero or one of \fBgnutls_privkey_flags_t\fP +.IP "const gnutls_datum_t * data" 12 +holds the data to be signed +.IP "gnutls_datum_t * signature" 12 +will contain the signature allocated with \fBgnutls_malloc()\fP +.SH "DESCRIPTION" +This function will sign the given data using the specified signature +algorithm. This function is an enhancement of \fBgnutls_privkey_sign_data()\fP, +as it allows utilizing a alternative signature algorithm where possible +(e.g, use an RSA key with RSA\-PSS). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_sign_hash.3 b/doc/manpages/gnutls_privkey_sign_hash.3 new file mode 100644 index 0000000..19692d5 --- /dev/null +++ b/doc/manpages/gnutls_privkey_sign_hash.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_sign_hash" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_sign_hash \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_sign_hash(gnutls_privkey_t " signer ", gnutls_digest_algorithm_t " hash_algo ", unsigned int " flags ", const gnutls_datum_t * " hash_data ", gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t signer" 12 +Holds the signer's key +.IP "gnutls_digest_algorithm_t hash_algo" 12 +The hash algorithm used +.IP "unsigned int flags" 12 +Zero or one of \fBgnutls_privkey_flags_t\fP +.IP "const gnutls_datum_t * hash_data" 12 +holds the data to be signed +.IP "gnutls_datum_t * signature" 12 +will contain newly allocated signature +.SH "DESCRIPTION" +This function will sign the given hashed data using a signature algorithm +supported by the private key. Signature algorithms are always used +together with a hash functions. Different hash functions may be +used for the RSA algorithm, but only SHA\-XXX for the DSA keys. + +You may use \fBgnutls_pubkey_get_preferred_hash_algorithm()\fP to determine +the hash algorithm. + +The flags may be \fBGNUTLS_PRIVKEY_SIGN_FLAG_TLS1_RSA\fP or \fBGNUTLS_PRIVKEY_SIGN_FLAG_RSA_PSS\fP. +In the former case this function will ignore \fIhash_algo\fP and perform a raw PKCS1 signature, +and in the latter an RSA\-PSS signature will be generated. + +Note that, not all algorithm support signing already hashed data. When +signing with Ed25519, \fBgnutls_privkey_sign_data()\fP should be used. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_sign_hash2.3 b/doc/manpages/gnutls_privkey_sign_hash2.3 new file mode 100644 index 0000000..05ba356 --- /dev/null +++ b/doc/manpages/gnutls_privkey_sign_hash2.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_sign_hash2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_sign_hash2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_sign_hash2(gnutls_privkey_t " signer ", gnutls_sign_algorithm_t " algo ", unsigned int " flags ", const gnutls_datum_t * " hash_data ", gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t signer" 12 +Holds the signer's key +.IP "gnutls_sign_algorithm_t algo" 12 +The signature algorithm used +.IP "unsigned int flags" 12 +Zero or one of \fBgnutls_privkey_flags_t\fP +.IP "const gnutls_datum_t * hash_data" 12 +holds the data to be signed +.IP "gnutls_datum_t * signature" 12 +will contain newly allocated signature +.SH "DESCRIPTION" +This function will sign the given hashed data using the specified signature +algorithm. This function is an enhancement of \fBgnutls_privkey_sign_hash()\fP, +as it allows utilizing a alternative signature algorithm where possible +(e.g, use an RSA key with RSA\-PSS). + +The flags may be \fBGNUTLS_PRIVKEY_SIGN_FLAG_TLS1_RSA\fP. +In that case this function will ignore \fIhash_algo\fP and perform a raw PKCS1 signature. +Note that this flag is supported since 3.6.9. + +Note also that, not all algorithm support signing already hashed data. When +signing with Ed25519, \fBgnutls_privkey_sign_data2()\fP should be used instead. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_status.3 b/doc/manpages/gnutls_privkey_status.3 new file mode 100644 index 0000000..7613f85 --- /dev/null +++ b/doc/manpages/gnutls_privkey_status.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_status \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_status(gnutls_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +Holds the key +.SH "DESCRIPTION" +Checks the status of the private key token. This function +is an actual wrapper over \fBgnutls_pkcs11_privkey_status()\fP, and +if the private key is a PKCS \fB11\fP token it will check whether +it is inserted or not. +.SH "RETURNS" +this function will return non\-zero if the token +holding the private key is still available (inserted), and zero otherwise. +.SH "SINCE" +3.1.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_verify_params.3 b/doc/manpages/gnutls_privkey_verify_params.3 new file mode 100644 index 0000000..2a8902e --- /dev/null +++ b/doc/manpages/gnutls_privkey_verify_params.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_verify_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_verify_params \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_verify_params(gnutls_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +should contain a \fBgnutls_privkey_t\fP type +.SH "DESCRIPTION" +This function will verify the private key parameters. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_privkey_verify_seed.3 b/doc/manpages/gnutls_privkey_verify_seed.3 new file mode 100644 index 0000000..a949278 --- /dev/null +++ b/doc/manpages/gnutls_privkey_verify_seed.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_verify_seed" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_verify_seed \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_privkey_verify_seed(gnutls_privkey_t " key ", gnutls_digest_algorithm_t " digest ", const void * " seed ", size_t " seed_size ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +should contain a \fBgnutls_privkey_t\fP type +.IP "gnutls_digest_algorithm_t digest" 12 +it contains the digest algorithm used for key generation (if applicable) +.IP "const void * seed" 12 +the seed of the key to be checked with +.IP "size_t seed_size" 12 +holds the size of \fIseed\fP +.SH "DESCRIPTION" +This function will verify that the given private key was generated from +the provided seed. +.SH "RETURNS" +In case of a verification failure \fBGNUTLS_E_PRIVKEY_VERIFICATION_ERROR\fP +is returned, and zero or positive code on success. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_protocol_get_id.3 b/doc/manpages/gnutls_protocol_get_id.3 new file mode 100644 index 0000000..899ba3a --- /dev/null +++ b/doc/manpages/gnutls_protocol_get_id.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_protocol_t gnutls_protocol_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a protocol name +.SH "DESCRIPTION" +The names are compared in a case insensitive way. +.SH "RETURNS" +an id of the specified protocol, or +\fBGNUTLS_VERSION_UNKNOWN\fP on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_protocol_get_name.3 b/doc/manpages/gnutls_protocol_get_name.3 new file mode 100644 index 0000000..51a85e0 --- /dev/null +++ b/doc/manpages/gnutls_protocol_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_protocol_get_name(gnutls_protocol_t " version ");" +.SH ARGUMENTS +.IP "gnutls_protocol_t version" 12 +is a (gnutls) version number +.SH "DESCRIPTION" +Convert a \fBgnutls_protocol_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified TLS +version (e.g., "TLS1.0"), or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_protocol_get_version.3 b/doc/manpages/gnutls_protocol_get_version.3 new file mode 100644 index 0000000..b02e5c2 --- /dev/null +++ b/doc/manpages/gnutls_protocol_get_version.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_get_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_get_version \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_protocol_t gnutls_protocol_get_version(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get TLS version, a \fBgnutls_protocol_t\fP value. +.SH "RETURNS" +The version of the currently used protocol. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_protocol_list.3 b/doc/manpages/gnutls_protocol_list.3 new file mode 100644 index 0000000..5e52072 --- /dev/null +++ b/doc/manpages/gnutls_protocol_list.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_protocol_t * gnutls_protocol_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get a list of supported protocols, e.g. SSL 3.0, TLS 1.0 etc. + +This function is not thread safe. +.SH "RETURNS" +a (0)\-terminated list of \fBgnutls_protocol_t\fP integers +indicating the available protocols. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_protocol_set_enabled.3 b/doc/manpages/gnutls_protocol_set_enabled.3 new file mode 100644 index 0000000..4344468 --- /dev/null +++ b/doc/manpages/gnutls_protocol_set_enabled.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_set_enabled" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_set_enabled \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_protocol_set_enabled(gnutls_protocol_t " version ", unsigned int " enabled ");" +.SH ARGUMENTS +.IP "gnutls_protocol_t version" 12 +is a (gnutls) version number +.IP "unsigned int enabled" 12 +whether to enable the protocol +.SH "DESCRIPTION" +Control the previous system\-wide setting that marked \fIversion\fP as +enabled or disabled. Calling this fuction is allowed +only if allowlisting mode is set in the configuration file, +and only if the system\-wide TLS priority string +has not been initialized yet. +The intended usage is to provide applications with a way +to expressly deviate from the distribution or site defaults +inherited from the configuration file. +The modification is composable with further modifications +performed through the priority string mechanism. + +This function is not thread\-safe and is intended to be called +in the main thread at the beginning of the process execution. +.SH "RETURNS" +0 on success or negative error code otherwise. +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_allocate_client_credentials.3 b/doc/manpages/gnutls_psk_allocate_client_credentials.3 new file mode 100644 index 0000000..a90e5b6 --- /dev/null +++ b/doc/manpages/gnutls_psk_allocate_client_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_allocate_client_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_allocate_client_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_psk_allocate_client_credentials(gnutls_psk_client_credentials_t * " sc ");" +.SH ARGUMENTS +.IP "gnutls_psk_client_credentials_t * sc" 12 +is a pointer to a \fBgnutls_psk_server_credentials_t\fP type. +.SH "DESCRIPTION" +Allocate a gnutls_psk_client_credentials_t structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_allocate_server_credentials.3 b/doc/manpages/gnutls_psk_allocate_server_credentials.3 new file mode 100644 index 0000000..bef4c38 --- /dev/null +++ b/doc/manpages/gnutls_psk_allocate_server_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_allocate_server_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_allocate_server_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_psk_allocate_server_credentials(gnutls_psk_server_credentials_t * " sc ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t * sc" 12 +is a pointer to a \fBgnutls_psk_server_credentials_t\fP type. +.SH "DESCRIPTION" +Allocate a gnutls_psk_server_credentials_t structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_client_get_hint.3 b/doc/manpages/gnutls_psk_client_get_hint.3 new file mode 100644 index 0000000..06cc4d7 --- /dev/null +++ b/doc/manpages/gnutls_psk_client_get_hint.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_client_get_hint" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_client_get_hint \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_psk_client_get_hint(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +The PSK identity hint may give the client help in deciding which +username to use. This should only be called in case of PSK +authentication and in case of a client. +.SH "NOTE" +there is no hint in TLS 1.3, so this function will return \fBNULL\fP +if TLS 1.3 has been negotiated. +.SH "RETURNS" +the identity hint of the peer, or \fBNULL\fP in case of an error or if TLS 1.3 is being used. +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_free_client_credentials.3 b/doc/manpages/gnutls_psk_free_client_credentials.3 new file mode 100644 index 0000000..a9c5e82 --- /dev/null +++ b/doc/manpages/gnutls_psk_free_client_credentials.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_free_client_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_free_client_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_psk_free_client_credentials(gnutls_psk_client_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_psk_client_credentials_t sc" 12 +is a \fBgnutls_psk_client_credentials_t\fP type. +.SH "DESCRIPTION" +Free a gnutls_psk_client_credentials_t structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_free_server_credentials.3 b/doc/manpages/gnutls_psk_free_server_credentials.3 new file mode 100644 index 0000000..f5bf913 --- /dev/null +++ b/doc/manpages/gnutls_psk_free_server_credentials.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_free_server_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_free_server_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_psk_free_server_credentials(gnutls_psk_server_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t sc" 12 +is a \fBgnutls_psk_server_credentials_t\fP type. +.SH "DESCRIPTION" +Free a gnutls_psk_server_credentials_t structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_server_get_username.3 b/doc/manpages/gnutls_psk_server_get_username.3 new file mode 100644 index 0000000..5cd14f5 --- /dev/null +++ b/doc/manpages/gnutls_psk_server_get_username.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_server_get_username" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_server_get_username \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_psk_server_get_username(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +This should only be called in case of PSK authentication and in +case of a server. + +The returned pointer should be considered constant (do not free) and valid +for the lifetime of the session. + +This function will return \fBNULL\fP if the username has embedded NULL bytes. +In that case, \fBgnutls_psk_server_get_username2()\fP should be used to retrieve the username. +.SH "RETURNS" +the username of the peer, or \fBNULL\fP in case of an error, +or if the username has embedded NULLs. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_server_get_username2.3 b/doc/manpages/gnutls_psk_server_get_username2.3 new file mode 100644 index 0000000..3bc260f --- /dev/null +++ b/doc/manpages/gnutls_psk_server_get_username2.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_server_get_username2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_server_get_username2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_psk_server_get_username2(gnutls_session_t " session ", gnutls_datum_t * " username ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "gnutls_datum_t * username" 12 +a datum that will be filled in by this function +.SH "DESCRIPTION" +Return a pointer to the username of the peer in the supplied datum. Does not +need to be null\-terminated. + +This should only be called in case of PSK authentication and in +case of a server. + +The returned pointer should be considered constant (do not free) and valid +for the lifetime of the session. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP, or a negative value in case of an error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_client_credentials.3 b/doc/manpages/gnutls_psk_set_client_credentials.3 new file mode 100644 index 0000000..6bd3af0 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_client_credentials.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_client_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_client_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_psk_set_client_credentials(gnutls_psk_client_credentials_t " res ", const char * " username ", const gnutls_datum_t * " key ", gnutls_psk_key_flags " flags ");" +.SH ARGUMENTS +.IP "gnutls_psk_client_credentials_t res" 12 +is a \fBgnutls_psk_client_credentials_t\fP type. +.IP "const char * username" 12 +is the user's zero\-terminated userid +.IP "const gnutls_datum_t * key" 12 +is the user's key +.IP "gnutls_psk_key_flags flags" 12 +indicate the format of the key, either +\fBGNUTLS_PSK_KEY_RAW\fP or \fBGNUTLS_PSK_KEY_HEX\fP. +.SH "DESCRIPTION" +This function sets the username and password, in a +gnutls_psk_client_credentials_t type. Those will be used in +PSK authentication. \fIusername\fP should be an ASCII string or UTF\-8 +string. In case of a UTF\-8 string it is recommended to be following +the PRECIS framework for usernames (rfc8265). The key can be either +in raw byte format or in Hex format (without the 0x prefix). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_client_credentials2.3 b/doc/manpages/gnutls_psk_set_client_credentials2.3 new file mode 100644 index 0000000..f8d074a --- /dev/null +++ b/doc/manpages/gnutls_psk_set_client_credentials2.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_client_credentials2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_client_credentials2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_psk_set_client_credentials2(gnutls_psk_client_credentials_t " res ", const gnutls_datum_t * " username ", const gnutls_datum_t * " key ", gnutls_psk_key_flags " flags ");" +.SH ARGUMENTS +.IP "gnutls_psk_client_credentials_t res" 12 +is a \fBgnutls_psk_client_credentials_t\fP type. +.IP "const gnutls_datum_t * username" 12 +is the userid +.IP "const gnutls_datum_t * key" 12 +is the user's key +.IP "gnutls_psk_key_flags flags" 12 +indicate the format of the key, either +\fBGNUTLS_PSK_KEY_RAW\fP or \fBGNUTLS_PSK_KEY_HEX\fP. +.SH "DESCRIPTION" +This function is identical to \fBgnutls_psk_set_client_credentials()\fP, +except that it allows a non\-null\-terminated username to be introduced. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_client_credentials_function.3 b/doc/manpages/gnutls_psk_set_client_credentials_function.3 new file mode 100644 index 0000000..17b5925 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_client_credentials_function.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_client_credentials_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_client_credentials_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_psk_set_client_credentials_function(gnutls_psk_client_credentials_t " cred ", gnutls_psk_client_credentials_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_psk_client_credentials_t cred" 12 +is a \fBgnutls_psk_server_credentials_t\fP type. +.IP "gnutls_psk_client_credentials_function * func" 12 +is the callback function +.SH "DESCRIPTION" +This function can be used to set a callback to retrieve the username and +password for client PSK authentication. +The callback's function form is: +int (*callback)(gnutls_session_t, char** username, +gnutls_datum_t* key); + +The \fIusername\fP and \fIkey\fP \->data must be allocated using \fBgnutls_malloc()\fP. +The \fIusername\fP should be an ASCII string or UTF\-8 +string. In case of a UTF\-8 string it is recommended to be following +the PRECIS framework for usernames (rfc8265). + +The callback function will be called once per handshake. + +The callback function should return 0 on success. +\-1 indicates an error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_client_credentials_function2.3 b/doc/manpages/gnutls_psk_set_client_credentials_function2.3 new file mode 100644 index 0000000..3db9515 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_client_credentials_function2.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_client_credentials_function2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_client_credentials_function2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_psk_set_client_credentials_function2(gnutls_psk_client_credentials_t " cred ", gnutls_psk_client_credentials_function2 * " func ");" +.SH ARGUMENTS +.IP "gnutls_psk_client_credentials_t cred" 12 +is a \fBgnutls_psk_server_credentials_t\fP type. +.IP "gnutls_psk_client_credentials_function2 * func" 12 +is the callback function +.SH "DESCRIPTION" +This function can be used to set a callback to retrieve the username and +password for client PSK authentication. +The callback's function form is: +int (*callback)(gnutls_session_t, gnutls_datum_t* username, +gnutls_datum_t* key); + +This callback function has the same semantics as that of \fBgnutls_psk_set_client_credentials_function()\fP, +but it allows non\-string usernames to be used. + +The \fIusername\fP and \fIkey\fP \->data must be allocated using \fBgnutls_malloc()\fP. +The \fIusername\fP should be an ASCII string or UTF\-8 +string. In case of a UTF\-8 string it is recommended to be following +the PRECIS framework for usernames (rfc8265). + +The callback function will be called once per handshake. + +The callback function should return 0 on success. +\-1 indicates an error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_params_function.3 b/doc/manpages/gnutls_psk_set_params_function.3 new file mode 100644 index 0000000..bc91c62 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_params_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_params_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_params_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_psk_set_params_function(gnutls_psk_server_credentials_t " res ", gnutls_params_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t res" 12 +is a gnutls_psk_server_credentials_t type +.IP "gnutls_params_function * func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback in order for the server to get +the Diffie\-Hellman or RSA parameters for PSK authentication. The +callback should return \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_server_credentials_file.3 b/doc/manpages/gnutls_psk_set_server_credentials_file.3 new file mode 100644 index 0000000..921d118 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_credentials_file.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_credentials_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_credentials_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_psk_set_server_credentials_file(gnutls_psk_server_credentials_t " res ", const char * " password_file ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t res" 12 +is a \fBgnutls_psk_server_credentials_t\fP type. +.IP "const char * password_file" 12 +is the PSK password file (passwd.psk) +.SH "DESCRIPTION" +This function sets the password file, in a +\fBgnutls_psk_server_credentials_t\fP type. This password file +holds usernames and keys and will be used for PSK authentication. + +Each entry in the file consists of a username, followed by a colon +(':') and a hex\-encoded key. If the username contains a colon or +any other special character, it can be hex\-encoded preceded by a +'#'. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_server_credentials_function.3 b/doc/manpages/gnutls_psk_set_server_credentials_function.3 new file mode 100644 index 0000000..d6c804c --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_credentials_function.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_credentials_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_credentials_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_psk_set_server_credentials_function(gnutls_psk_server_credentials_t " cred ", gnutls_psk_server_credentials_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t cred" 12 +is a \fBgnutls_psk_server_credentials_t\fP type. +.IP "gnutls_psk_server_credentials_function * func" 12 +is the callback function +.SH "DESCRIPTION" +This function can be used to set a callback to retrieve the user's PSK credentials. +The callback's function form is: +int (*callback)(gnutls_session_t, const char* username, +gnutls_datum_t* key); + + \fIusername\fP contains the actual username. +The \fIkey\fP must be filled in using the \fBgnutls_malloc()\fP. + +In case the callback returned a negative number then gnutls will +assume that the username does not exist. + +The callback function will only be called once per handshake. The +callback function should return 0 on success, while \-1 indicates +an error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_server_credentials_function2.3 b/doc/manpages/gnutls_psk_set_server_credentials_function2.3 new file mode 100644 index 0000000..4ba17e8 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_credentials_function2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_credentials_function2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_credentials_function2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_psk_set_server_credentials_function2(gnutls_psk_server_credentials_t " cred ", gnutls_psk_server_credentials_function2 " func ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t cred" 12 +is a \fBgnutls_psk_server_credentials_t\fP type. +.IP "gnutls_psk_server_credentials_function2 func" 12 +is the callback function +.SH "DESCRIPTION" +This function can be used to set a callback to retrieve the user's PSK credentials. +The callback's function form is: +int (*callback)(gnutls_session_t, const gnutls_datum_t* username, +gnutls_datum_t* key); + +This callback function has the same semantics as that of \fBgnutls_psk_set_server_credentials_function()\fP, +but it allows non\-string usernames to be used. + + \fIusername\fP contains the actual username. +The \fIkey\fP must be filled in using the \fBgnutls_malloc()\fP. + +In case the callback returned a negative number then gnutls will +assume that the username does not exist. + +The callback function will only be called once per handshake. The +callback function should return 0 on success, while \-1 indicates +an error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_server_credentials_hint.3 b/doc/manpages/gnutls_psk_set_server_credentials_hint.3 new file mode 100644 index 0000000..49cd94b --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_credentials_hint.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_credentials_hint" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_credentials_hint \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_psk_set_server_credentials_hint(gnutls_psk_server_credentials_t " res ", const char * " hint ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t res" 12 +is a \fBgnutls_psk_server_credentials_t\fP type. +.IP "const char * hint" 12 +is the PSK identity hint string +.SH "DESCRIPTION" +This function sets the identity hint, in a +\fBgnutls_psk_server_credentials_t\fP type. This hint is sent to +the client to help it chose a good PSK credential (i.e., username +and password). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_server_dh_params.3 b/doc/manpages/gnutls_psk_set_server_dh_params.3 new file mode 100644 index 0000000..d15229d --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_dh_params.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_dh_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_dh_params \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_psk_set_server_dh_params(gnutls_psk_server_credentials_t " res ", gnutls_dh_params_t " dh_params ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t res" 12 +is a gnutls_psk_server_credentials_t type +.IP "gnutls_dh_params_t dh_params" 12 +is a structure that holds Diffie\-Hellman parameters. +.SH "DESCRIPTION" +This function will set the Diffie\-Hellman parameters for an +anonymous server to use. These parameters will be used in +Diffie\-Hellman exchange with PSK cipher suites. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_server_known_dh_params.3 b/doc/manpages/gnutls_psk_set_server_known_dh_params.3 new file mode 100644 index 0000000..57a8d10 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_known_dh_params.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_known_dh_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_known_dh_params \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_psk_set_server_known_dh_params(gnutls_psk_server_credentials_t " res ", gnutls_sec_param_t " sec_param ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t res" 12 +is a gnutls_psk_server_credentials_t type +.IP "gnutls_sec_param_t sec_param" 12 +is an option of the \fBgnutls_sec_param_t\fP enumeration +.SH "DESCRIPTION" +This function will set the Diffie\-Hellman parameters for a +PSK server to use. These parameters will be used in +Ephemeral Diffie\-Hellman cipher suites and will be selected from +the FFDHE set of RFC7919 according to the security level provided. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_psk_set_server_params_function.3 b/doc/manpages/gnutls_psk_set_server_params_function.3 new file mode 100644 index 0000000..35b2764 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_params_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_params_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_params_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_psk_set_server_params_function(gnutls_psk_server_credentials_t " res ", gnutls_params_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_psk_server_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP type +.IP "gnutls_params_function * func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback in order for the server to get +the Diffie\-Hellman parameters for PSK authentication. The callback +should return \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH "DEPRECATED" +This function is unnecessary and discouraged on GnuTLS 3.6.0 +or later. Since 3.6.0, DH parameters are negotiated +following RFC7919. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_deinit.3 b/doc/manpages/gnutls_pubkey_deinit.3 new file mode 100644 index 0000000..e330d5f --- /dev/null +++ b/doc/manpages/gnutls_pubkey_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "void gnutls_pubkey_deinit(gnutls_pubkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The key to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a public key structure. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_encrypt_data.3 b/doc/manpages/gnutls_pubkey_encrypt_data.3 new file mode 100644 index 0000000..14eb55a --- /dev/null +++ b/doc/manpages/gnutls_pubkey_encrypt_data.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_encrypt_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_encrypt_data \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_encrypt_data(gnutls_pubkey_t " key ", unsigned int " flags ", const gnutls_datum_t * " plaintext ", gnutls_datum_t * " ciphertext ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "unsigned int flags" 12 +should be 0 for now +.IP "const gnutls_datum_t * plaintext" 12 +The data to be encrypted +.IP "gnutls_datum_t * ciphertext" 12 +contains the encrypted data +.SH "DESCRIPTION" +This function will encrypt the given data, using the public +key. On success the \fIciphertext\fP will be allocated using \fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export.3 b/doc/manpages/gnutls_pubkey_export.3 new file mode 100644 index 0000000..4ec9097 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export(gnutls_pubkey_t " key ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the certificate +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "void * output_data" 12 +will contain a certificate PEM or DER encoded +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the public key to DER or PEM format. +The contents of the exported data is the SubjectPublicKeyInfo +X.509 structure. + +If the buffer provided is not long enough to hold the output, then +*output_data_size is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will +be returned. + +If the structure is PEM encoded, it will have a header +of "BEGIN CERTIFICATE". +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export2.3 b/doc/manpages/gnutls_pubkey_export2.3 new file mode 100644 index 0000000..586a84f --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export2.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export2(gnutls_pubkey_t " key ", gnutls_x509_crt_fmt_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the certificate +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "gnutls_datum_t * out" 12 +will contain a certificate PEM or DER encoded +.SH "DESCRIPTION" +This function will export the public key to DER or PEM format. +The contents of the exported data is the SubjectPublicKeyInfo +X.509 structure. + +The output buffer will be allocated using \fBgnutls_malloc()\fP. + +If the structure is PEM encoded, it will have a header +of "BEGIN CERTIFICATE". +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export_dsa_raw.3 b/doc/manpages/gnutls_pubkey_export_dsa_raw.3 new file mode 100644 index 0000000..5bdf7a8 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export_dsa_raw.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export_dsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export_dsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export_dsa_raw(gnutls_pubkey_t " key ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "gnutls_datum_t * p" 12 +will hold the p (may be \fBNULL\fP) +.IP "gnutls_datum_t * q" 12 +will hold the q (may be \fBNULL\fP) +.IP "gnutls_datum_t * g" 12 +will hold the g (may be \fBNULL\fP) +.IP "gnutls_datum_t * y" 12 +will hold the y (may be \fBNULL\fP) +.SH "DESCRIPTION" +This function will export the DSA public key's parameters found in +the given certificate. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +This function allows for \fBNULL\fP parameters since 3.4.1. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export_dsa_raw2.3 b/doc/manpages/gnutls_pubkey_export_dsa_raw2.3 new file mode 100644 index 0000000..3a272ad --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export_dsa_raw2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export_dsa_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export_dsa_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export_dsa_raw2(gnutls_pubkey_t " key ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "gnutls_datum_t * p" 12 +will hold the p (may be \fBNULL\fP) +.IP "gnutls_datum_t * q" 12 +will hold the q (may be \fBNULL\fP) +.IP "gnutls_datum_t * g" 12 +will hold the g (may be \fBNULL\fP) +.IP "gnutls_datum_t * y" 12 +will hold the y (may be \fBNULL\fP) +.IP "unsigned flags" 12 +flags from \fBgnutls_abstract_export_flags_t\fP +.SH "DESCRIPTION" +This function will export the DSA public key's parameters found in +the given certificate. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +This function allows for \fBNULL\fP parameters since 3.4.1. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export_ecc_raw.3 b/doc/manpages/gnutls_pubkey_export_ecc_raw.3 new file mode 100644 index 0000000..01262a6 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export_ecc_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export_ecc_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export_ecc_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export_ecc_raw(gnutls_pubkey_t " key ", gnutls_ecc_curve_t * " curve ", gnutls_datum_t * " x ", gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve (may be \fBNULL\fP) +.IP "gnutls_datum_t * x" 12 +will hold x\-coordinate (may be \fBNULL\fP) +.IP "gnutls_datum_t * y" 12 +will hold y\-coordinate (may be \fBNULL\fP) +.SH "DESCRIPTION" +This function will export the ECC public key's parameters found in +the given key. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +In EdDSA curves the \fIy\fP parameter will be \fBNULL\fP and the other parameters +will be in the native format for the curve. + +This function allows for \fBNULL\fP parameters since 3.4.1. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export_ecc_raw2.3 b/doc/manpages/gnutls_pubkey_export_ecc_raw2.3 new file mode 100644 index 0000000..6a215f2 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export_ecc_raw2.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export_ecc_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export_ecc_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export_ecc_raw2(gnutls_pubkey_t " key ", gnutls_ecc_curve_t * " curve ", gnutls_datum_t * " x ", gnutls_datum_t * " y ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve (may be \fBNULL\fP) +.IP "gnutls_datum_t * x" 12 +will hold x\-coordinate (may be \fBNULL\fP) +.IP "gnutls_datum_t * y" 12 +will hold y\-coordinate (may be \fBNULL\fP) +.IP "unsigned int flags" 12 +flags from \fBgnutls_abstract_export_flags_t\fP +.SH "DESCRIPTION" +This function will export the ECC public key's parameters found in +the given key. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +In EdDSA curves the \fIy\fP parameter will be \fBNULL\fP and the other parameters +will be in the native format for the curve. + +This function allows for \fBNULL\fP parameters since 3.4.1. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export_ecc_x962.3 b/doc/manpages/gnutls_pubkey_export_ecc_x962.3 new file mode 100644 index 0000000..356a958 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export_ecc_x962.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export_ecc_x962" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export_ecc_x962 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export_ecc_x962(gnutls_pubkey_t " key ", gnutls_datum_t * " parameters ", gnutls_datum_t * " ecpoint ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "gnutls_datum_t * parameters" 12 +DER encoding of an ANSI X9.62 parameters +.IP "gnutls_datum_t * ecpoint" 12 +DER encoding of ANSI X9.62 ECPoint +.SH "DESCRIPTION" +This function will export the ECC public key's parameters found in +the given certificate. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export_gost_raw2.3 b/doc/manpages/gnutls_pubkey_export_gost_raw2.3 new file mode 100644 index 0000000..ecde835 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export_gost_raw2.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export_gost_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export_gost_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export_gost_raw2(gnutls_pubkey_t " key ", gnutls_ecc_curve_t * " curve ", gnutls_digest_algorithm_t * " digest ", gnutls_gost_paramset_t * " paramset ", gnutls_datum_t * " x ", gnutls_datum_t * " y ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve (may be \fBNULL\fP) +.IP "gnutls_digest_algorithm_t * digest" 12 +will hold the curve (may be \fBNULL\fP) +.IP "gnutls_gost_paramset_t * paramset" 12 +will hold the parameters id (may be \fBNULL\fP) +.IP "gnutls_datum_t * x" 12 +will hold the x\-coordinate (may be \fBNULL\fP) +.IP "gnutls_datum_t * y" 12 +will hold the y\-coordinate (may be \fBNULL\fP) +.IP "unsigned int flags" 12 +flags from \fBgnutls_abstract_export_flags_t\fP +.SH "DESCRIPTION" +This function will export the GOST public key's parameters found in +the given key. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "NOTE" +parameters will be stored with least significant byte first. On +version 3.6.3 this was incorrectly returned in big\-endian format. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export_rsa_raw.3 b/doc/manpages/gnutls_pubkey_export_rsa_raw.3 new file mode 100644 index 0000000..0ebc3d1 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export_rsa_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export_rsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export_rsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export_rsa_raw(gnutls_pubkey_t " key ", gnutls_datum_t * " m ", gnutls_datum_t * " e ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the certificate +.IP "gnutls_datum_t * m" 12 +will hold the modulus (may be \fBNULL\fP) +.IP "gnutls_datum_t * e" 12 +will hold the public exponent (may be \fBNULL\fP) +.SH "DESCRIPTION" +This function will export the RSA public key's parameters found in +the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +This function allows for \fBNULL\fP parameters since 3.4.1. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_export_rsa_raw2.3 b/doc/manpages/gnutls_pubkey_export_rsa_raw2.3 new file mode 100644 index 0000000..b7c7a42 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_export_rsa_raw2.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_export_rsa_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export_rsa_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_export_rsa_raw2(gnutls_pubkey_t " key ", gnutls_datum_t * " m ", gnutls_datum_t * " e ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the certificate +.IP "gnutls_datum_t * m" 12 +will hold the modulus (may be \fBNULL\fP) +.IP "gnutls_datum_t * e" 12 +will hold the public exponent (may be \fBNULL\fP) +.IP "unsigned flags" 12 +flags from \fBgnutls_abstract_export_flags_t\fP +.SH "DESCRIPTION" +This function will export the RSA public key's parameters found in +the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +This function allows for \fBNULL\fP parameters since 3.4.1. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_get_key_id.3 b/doc/manpages/gnutls_pubkey_get_key_id.3 new file mode 100644 index 0000000..93dd04f --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_key_id.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_get_key_id(gnutls_pubkey_t " key ", unsigned int " flags ", unsigned char * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "unsigned int flags" 12 +should be one of the flags from \fBgnutls_keyid_flags_t\fP +.IP "unsigned char * output_data" 12 +will contain the key ID +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will return a unique ID that depends on the public +key parameters. This ID can be used in checking whether a +certificate corresponds to the given public key. + +If the buffer provided is not long enough to hold the output, then +*output_data_size is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will +be returned. The output will normally be a SHA\-1 hash output, +which is 20 bytes. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_get_key_usage.3 b/doc/manpages/gnutls_pubkey_get_key_usage.3 new file mode 100644 index 0000000..7c7c698 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_key_usage.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_key_usage" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_key_usage \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_get_key_usage(gnutls_pubkey_t " key ", unsigned int * " usage ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +should contain a \fBgnutls_pubkey_t\fP type +.IP "unsigned int * usage" 12 +If set will return the number of bits of the parameters (may be NULL) +.SH "DESCRIPTION" +This function will return the key usage of the public key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_get_openpgp_key_id.3 b/doc/manpages/gnutls_pubkey_get_openpgp_key_id.3 new file mode 100644 index 0000000..5e617ae --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_openpgp_key_id.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_openpgp_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_openpgp_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_get_openpgp_key_id(gnutls_pubkey_t " key ", unsigned int " flags ", unsigned char * " output_data ", size_t * " output_data_size ", unsigned int * " subkey ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "unsigned int flags" 12 +should be one of the flags from \fBgnutls_keyid_flags_t\fP +.IP "unsigned char * output_data" 12 +will contain the key ID +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.IP "unsigned int * subkey" 12 +ignored +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_get_pk_algorithm.3 b/doc/manpages/gnutls_pubkey_get_pk_algorithm.3 new file mode 100644 index 0000000..8a32fd2 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_pk_algorithm.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_pk_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_get_pk_algorithm(gnutls_pubkey_t " key ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +should contain a \fBgnutls_pubkey_t\fP type +.IP "unsigned int * bits" 12 +If set will return the number of bits of the parameters (may be NULL) +.SH "DESCRIPTION" +This function will return the public key algorithm of a public +key and if possible will return a number of bits that indicates +the security parameter of the key. +.SH "RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or a negative error code on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_get_preferred_hash_algorithm.3 b/doc/manpages/gnutls_pubkey_get_preferred_hash_algorithm.3 new file mode 100644 index 0000000..d87c927 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_preferred_hash_algorithm.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_preferred_hash_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_preferred_hash_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_get_preferred_hash_algorithm(gnutls_pubkey_t " key ", gnutls_digest_algorithm_t * " hash ", unsigned int * " mand ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the certificate +.IP "gnutls_digest_algorithm_t * hash" 12 +The result of the call with the hash algorithm used for signature +.IP "unsigned int * mand" 12 +If non zero it means that the algorithm MUST use this hash. May be NULL. +.SH "DESCRIPTION" +This function will read the certificate and return the appropriate digest +algorithm to use for signing with this certificate. Some certificates (i.e. +DSA might not be able to sign without the preferred algorithm). + +To get the signature algorithm instead of just the hash use \fBgnutls_pk_to_sign()\fP +with the algorithm of the certificate/key and the provided \fIhash\fP . +.SH "RETURNS" +the 0 if the hash algorithm is found. A negative error code is +returned on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_get_spki.3 b/doc/manpages/gnutls_pubkey_get_spki.3 new file mode 100644 index 0000000..5bf54ee --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_spki.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_get_spki(gnutls_pubkey_t " pubkey ", gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t pubkey" 12 +a public key of type \fBgnutls_pubkey_t\fP +.IP "gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_pubkey_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will return the public key information if available. +The provided \fIspki\fP must be initialized. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import.3 b/doc/manpages/gnutls_pubkey_import.3 new file mode 100644 index 0000000..564b0be --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import(gnutls_pubkey_t " key ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The public key. +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded certificate. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM +.SH "DESCRIPTION" +This function will import the provided public key in +a SubjectPublicKeyInfo X.509 structure to a native +\fBgnutls_pubkey_t\fP type. The output will be stored +in \fIkey\fP . If the public key is PEM encoded it should have a header +of "PUBLIC KEY". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_dsa_raw.3 b/doc/manpages/gnutls_pubkey_import_dsa_raw.3 new file mode 100644 index 0000000..910de9d --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_dsa_raw.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_dsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_dsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_dsa_raw(gnutls_pubkey_t " key ", const gnutls_datum_t * " p ", const gnutls_datum_t * " q ", const gnutls_datum_t * " g ", const gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The structure to store the parsed key +.IP "const gnutls_datum_t * p" 12 +holds the p +.IP "const gnutls_datum_t * q" 12 +holds the q +.IP "const gnutls_datum_t * g" 12 +holds the g +.IP "const gnutls_datum_t * y" 12 +holds the y +.SH "DESCRIPTION" +This function will convert the given DSA raw parameters to the +native \fBgnutls_pubkey_t\fP format. The output will be stored +in \fIkey\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_ecc_raw.3 b/doc/manpages/gnutls_pubkey_import_ecc_raw.3 new file mode 100644 index 0000000..8663390 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_ecc_raw.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_ecc_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_ecc_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_ecc_raw(gnutls_pubkey_t " key ", gnutls_ecc_curve_t " curve ", const gnutls_datum_t * " x ", const gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The structure to store the parsed key +.IP "gnutls_ecc_curve_t curve" 12 +holds the curve +.IP "const gnutls_datum_t * x" 12 +holds the x\-coordinate +.IP "const gnutls_datum_t * y" 12 +holds the y\-coordinate +.SH "DESCRIPTION" +This function will convert the given elliptic curve parameters to a +\fBgnutls_pubkey_t\fP. The output will be stored in \fIkey\fP . + +In EdDSA curves the \fIy\fP parameter should be \fBNULL\fP and the \fIx\fP parameter must +be the value in the native format for the curve. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_ecc_x962.3 b/doc/manpages/gnutls_pubkey_import_ecc_x962.3 new file mode 100644 index 0000000..3672ef8 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_ecc_x962.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_ecc_x962" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_ecc_x962 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_ecc_x962(gnutls_pubkey_t " key ", const gnutls_datum_t * " parameters ", const gnutls_datum_t * " ecpoint ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The structure to store the parsed key +.IP "const gnutls_datum_t * parameters" 12 +DER encoding of an ANSI X9.62 parameters +.IP "const gnutls_datum_t * ecpoint" 12 +DER encoding of ANSI X9.62 ECPoint +.SH "DESCRIPTION" +This function will convert the given elliptic curve parameters to a +\fBgnutls_pubkey_t\fP. The output will be stored in \fIkey\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_gost_raw.3 b/doc/manpages/gnutls_pubkey_import_gost_raw.3 new file mode 100644 index 0000000..2c0e843 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_gost_raw.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_gost_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_gost_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_gost_raw(gnutls_pubkey_t " key ", gnutls_ecc_curve_t " curve ", gnutls_digest_algorithm_t " digest ", gnutls_gost_paramset_t " paramset ", const gnutls_datum_t * " x ", const gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The structure to store the parsed key +.IP "gnutls_ecc_curve_t curve" 12 +holds the curve +.IP "gnutls_digest_algorithm_t digest" 12 +holds the digest +.IP "gnutls_gost_paramset_t paramset" 12 +holds the parameters id +.IP "const gnutls_datum_t * x" 12 +holds the x\-coordinate +.IP "const gnutls_datum_t * y" 12 +holds the y\-coordinate +.SH "DESCRIPTION" +This function will convert the given GOST public key's parameters to a +\fBgnutls_pubkey_t\fP. The output will be stored in \fIkey\fP . \fIdigest\fP should be +one of GNUTLS_DIG_GOSR_94, GNUTLS_DIG_STREEBOG_256 or +GNUTLS_DIG_STREEBOG_512. If \fIparamset\fP is set to GNUTLS_GOST_PARAMSET_UNKNOWN +default one will be selected depending on \fIdigest\fP . +.SH "NOTE" +parameters should be stored with least significant byte first. On +version 3.6.3 big\-endian format was used incorrectly. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_openpgp.3 b/doc/manpages/gnutls_pubkey_import_openpgp.3 new file mode 100644 index 0000000..f890618 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_openpgp.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_openpgp" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_openpgp \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_openpgp(gnutls_pubkey_t " key ", gnutls_openpgp_crt_t " crt ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The public key +.IP "gnutls_openpgp_crt_t crt" 12 +The certificate to be imported +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_openpgp_raw.3 b/doc/manpages/gnutls_pubkey_import_openpgp_raw.3 new file mode 100644 index 0000000..9d23219 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_openpgp_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_openpgp_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_openpgp_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_openpgp_raw(gnutls_pubkey_t " pkey ", const gnutls_datum_t * " data ", gnutls_openpgp_crt_fmt_t " format ", const gnutls_openpgp_keyid_t " keyid ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t pkey" 12 +The public key +.IP "const gnutls_datum_t * data" 12 +The public key data to be imported +.IP "gnutls_openpgp_crt_fmt_t format" 12 +The format of the public key +.IP "const gnutls_openpgp_keyid_t keyid" 12 +The key id to use (optional) +.IP "unsigned int flags" 12 +Should be zero +.SH "DESCRIPTION" +This function is no\-op. +.SH "RETURNS" +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_pkcs11.3 b/doc/manpages/gnutls_pubkey_import_pkcs11.3 new file mode 100644 index 0000000..816c0a9 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_pkcs11.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_pkcs11" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_pkcs11 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_pkcs11(gnutls_pubkey_t " key ", gnutls_pkcs11_obj_t " obj ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The public key +.IP "gnutls_pkcs11_obj_t obj" 12 +The parameters to be imported +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +Imports a public key from a pkcs11 key. This function will import +the given public key to the abstract \fBgnutls_pubkey_t\fP type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_privkey.3 b/doc/manpages/gnutls_pubkey_import_privkey.3 new file mode 100644 index 0000000..eb71f12 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_privkey.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_privkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_privkey \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_privkey(gnutls_pubkey_t " key ", gnutls_privkey_t " pkey ", unsigned int " usage ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The public key +.IP "gnutls_privkey_t pkey" 12 +The private key +.IP "unsigned int usage" 12 +GNUTLS_KEY_* key usage flags. +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +Imports the public key from a private. This function will import +the given public key to the abstract \fBgnutls_pubkey_t\fP type. + +Note that in certain keys this operation may not be possible, e.g., +in other than RSA PKCS\fB11\fP keys. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_rsa_raw.3 b/doc/manpages/gnutls_pubkey_import_rsa_raw.3 new file mode 100644 index 0000000..2758d1b --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_rsa_raw.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_rsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_rsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_rsa_raw(gnutls_pubkey_t " key ", const gnutls_datum_t * " m ", const gnutls_datum_t * " e ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The key +.IP "const gnutls_datum_t * m" 12 +holds the modulus +.IP "const gnutls_datum_t * e" 12 +holds the public exponent +.SH "DESCRIPTION" +This function will replace the parameters in the given structure. +The new parameters should be stored in the appropriate +gnutls_datum. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an negative error code. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_tpm_raw.3 b/doc/manpages/gnutls_pubkey_import_tpm_raw.3 new file mode 100644 index 0000000..c74d102 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_tpm_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_tpm_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_tpm_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_tpm_raw(gnutls_pubkey_t " pkey ", const gnutls_datum_t * " fdata ", gnutls_tpmkey_fmt_t " format ", const char * " srk_password ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t pkey" 12 +The public key +.IP "const gnutls_datum_t * fdata" 12 +The TPM key to be imported +.IP "gnutls_tpmkey_fmt_t format" 12 +The format of the private key +.IP "const char * srk_password" 12 +The password for the SRK key (optional) +.IP "unsigned int flags" 12 +One of the GNUTLS_PUBKEY_* flags +.SH "DESCRIPTION" +This function will import the public key from the provided TPM key +structure. + +With respect to passwords the same as in +\fBgnutls_pubkey_import_tpm_url()\fP apply. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_tpm_url.3 b/doc/manpages/gnutls_pubkey_import_tpm_url.3 new file mode 100644 index 0000000..de5e762 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_tpm_url.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_tpm_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_tpm_url \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_tpm_url(gnutls_pubkey_t " pkey ", const char * " url ", const char * " srk_password ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t pkey" 12 +The public key +.IP "const char * url" 12 +The URL of the TPM key to be imported +.IP "const char * srk_password" 12 +The password for the SRK key (optional) +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will import the given private key to the abstract +\fBgnutls_privkey_t\fP type. + +Note that unless \fBGNUTLS_PUBKEY_DISABLE_CALLBACKS\fP +is specified, if incorrect (or NULL) passwords are given +the PKCS11 callback functions will be used to obtain the +correct passwords. Otherwise if the SRK password is wrong +\fBGNUTLS_E_TPM_SRK_PASSWORD_ERROR\fP is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_url.3 b/doc/manpages/gnutls_pubkey_import_url.3 new file mode 100644 index 0000000..1e59aee --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_url.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_url \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_url(gnutls_pubkey_t " key ", const char * " url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +A key of type \fBgnutls_pubkey_t\fP +.IP "const char * url" 12 +A PKCS 11 url +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_* flags +.SH "DESCRIPTION" +This function will import a public key from the provided URL. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_x509.3 b/doc/manpages/gnutls_pubkey_import_x509.3 new file mode 100644 index 0000000..9dd1d7a --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_x509.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_x509" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_x509 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_x509(gnutls_pubkey_t " key ", gnutls_x509_crt_t " crt ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The public key +.IP "gnutls_x509_crt_t crt" 12 +The certificate to be imported +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will import the given public key to the abstract +\fBgnutls_pubkey_t\fP type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_x509_crq.3 b/doc/manpages/gnutls_pubkey_import_x509_crq.3 new file mode 100644 index 0000000..1bb9706 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_x509_crq.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_x509_crq" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_x509_crq \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_x509_crq(gnutls_pubkey_t " key ", gnutls_x509_crq_t " crq ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The public key +.IP "gnutls_x509_crq_t crq" 12 +The certificate to be imported +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will import the given public key to the abstract +\fBgnutls_pubkey_t\fP type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_import_x509_raw.3 b/doc/manpages/gnutls_pubkey_import_x509_raw.3 new file mode 100644 index 0000000..06a5837 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_x509_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_x509_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_x509_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_import_x509_raw(gnutls_pubkey_t " pkey ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t pkey" 12 +The public key +.IP "const gnutls_datum_t * data" 12 +The public key data to be imported +.IP "gnutls_x509_crt_fmt_t format" 12 +The format of the public key +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will import the given public key to the abstract +\fBgnutls_pubkey_t\fP type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_init.3 b/doc/manpages/gnutls_pubkey_init.3 new file mode 100644 index 0000000..915c7d7 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_init \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_init(gnutls_pubkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t * key" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a public key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_print.3 b/doc/manpages/gnutls_pubkey_print.3 new file mode 100644 index 0000000..27e785b --- /dev/null +++ b/doc/manpages/gnutls_pubkey_print.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_print \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_print(gnutls_pubkey_t " pubkey ", gnutls_certificate_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t pubkey" 12 +The data to be printed +.IP "gnutls_certificate_print_formats_t format" 12 +Indicate the format to use +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with null terminated string. +.SH "DESCRIPTION" +This function will pretty print public key information, suitable for +display to a human. + +Only \fBGNUTLS_CRT_PRINT_FULL\fP and \fBGNUTLS_CRT_PRINT_FULL_NUMBERS\fP +are implemented. + +The output \fIout\fP needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_set_key_usage.3 b/doc/manpages/gnutls_pubkey_set_key_usage.3 new file mode 100644 index 0000000..fbf9c2f --- /dev/null +++ b/doc/manpages/gnutls_pubkey_set_key_usage.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_set_key_usage" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_set_key_usage \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_set_key_usage(gnutls_pubkey_t " key ", unsigned int " usage ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "unsigned int usage" 12 +an ORed sequence of the GNUTLS_KEY_* elements. +.SH "DESCRIPTION" +This function will set the key usage flags of the public key. This +is only useful if the key is to be exported to a certificate or +certificate request. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_set_pin_function.3 b/doc/manpages/gnutls_pubkey_set_pin_function.3 new file mode 100644 index 0000000..b57ae75 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_set_pin_function.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_set_pin_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_set_pin_function \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "void gnutls_pubkey_set_pin_function(gnutls_pubkey_t " key ", gnutls_pin_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +A key of type \fBgnutls_pubkey_t\fP +.IP "gnutls_pin_callback_t fn" 12 +the callback +.IP "void * userdata" 12 +data associated with the callback +.SH "DESCRIPTION" +This function will set a callback function to be used when +required to access the object. This function overrides any other +global PIN functions. + +Note that this function must be called right after initialization +to have effect. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_set_spki.3 b/doc/manpages/gnutls_pubkey_set_spki.3 new file mode 100644 index 0000000..5b5267a --- /dev/null +++ b/doc/manpages/gnutls_pubkey_set_spki.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_set_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_set_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_set_spki(gnutls_pubkey_t " pubkey ", const gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t pubkey" 12 +a public key of type \fBgnutls_pubkey_t\fP +.IP "const gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_pubkey_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will set the public key information. +The provided \fIspki\fP must be initialized. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_verify_data2.3 b/doc/manpages/gnutls_pubkey_verify_data2.3 new file mode 100644 index 0000000..11abac0 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_verify_data2.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_verify_data2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_verify_data2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_verify_data2(gnutls_pubkey_t " pubkey ", gnutls_sign_algorithm_t " algo ", unsigned int " flags ", const gnutls_datum_t * " data ", const gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t pubkey" 12 +Holds the public key +.IP "gnutls_sign_algorithm_t algo" 12 +The signature algorithm used +.IP "unsigned int flags" 12 +Zero or an OR list of \fBgnutls_certificate_verify_flags\fP +.IP "const gnutls_datum_t * data" 12 +holds the signed data +.IP "const gnutls_datum_t * signature" 12 +contains the signature +.SH "DESCRIPTION" +This function will verify the given signed data, using the +parameters from the certificate. +.SH "RETURNS" +In case of a verification failure \fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP +is returned, and zero or positive code on success. For known to be insecure +signatures this function will return \fBGNUTLS_E_INSUFFICIENT_SECURITY\fP unless +the flag \fBGNUTLS_VERIFY_ALLOW_BROKEN\fP is specified. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_verify_hash2.3 b/doc/manpages/gnutls_pubkey_verify_hash2.3 new file mode 100644 index 0000000..d58b705 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_verify_hash2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_verify_hash2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_verify_hash2 \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_verify_hash2(gnutls_pubkey_t " key ", gnutls_sign_algorithm_t " algo ", unsigned int " flags ", const gnutls_datum_t * " hash ", const gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public key +.IP "gnutls_sign_algorithm_t algo" 12 +The signature algorithm used +.IP "unsigned int flags" 12 +Zero or an OR list of \fBgnutls_certificate_verify_flags\fP +.IP "const gnutls_datum_t * hash" 12 +holds the hash digest to be verified +.IP "const gnutls_datum_t * signature" 12 +contains the signature +.SH "DESCRIPTION" +This function will verify the given signed digest, using the +parameters from the public key. Note that unlike \fBgnutls_privkey_sign_hash()\fP, +this function accepts a signature algorithm instead of a digest algorithm. +You can use \fBgnutls_pk_to_sign()\fP to get the appropriate value. +.SH "RETURNS" +In case of a verification failure \fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP +is returned, and zero or positive code on success. For known to be insecure +signatures this function will return \fBGNUTLS_E_INSUFFICIENT_SECURITY\fP unless +the flag \fBGNUTLS_VERIFY_ALLOW_BROKEN\fP is specified. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_pubkey_verify_params.3 b/doc/manpages/gnutls_pubkey_verify_params.3 new file mode 100644 index 0000000..0a1bc5e --- /dev/null +++ b/doc/manpages/gnutls_pubkey_verify_params.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_verify_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_verify_params \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_verify_params(gnutls_pubkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +should contain a \fBgnutls_pubkey_t\fP type +.SH "DESCRIPTION" +This function will verify the public key parameters. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_random_art.3 b/doc/manpages/gnutls_random_art.3 new file mode 100644 index 0000000..107b0de --- /dev/null +++ b/doc/manpages/gnutls_random_art.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_random_art" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_random_art \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_random_art(gnutls_random_art_t " type ", const char * " key_type ", unsigned int " key_size ", void * " fpr ", size_t " fpr_size ", gnutls_datum_t * " art ");" +.SH ARGUMENTS +.IP "gnutls_random_art_t type" 12 +The type of the random art (for now only \fBGNUTLS_RANDOM_ART_OPENSSH\fP is supported) +.IP "const char * key_type" 12 +The type of the key (RSA, DSA etc.) +.IP "unsigned int key_size" 12 +The size of the key in bits +.IP "void * fpr" 12 +The fingerprint of the key +.IP "size_t fpr_size" 12 +The size of the fingerprint +.IP "gnutls_datum_t * art" 12 +The returned random art +.SH "DESCRIPTION" +This function will convert a given fingerprint to an "artistic" +image. The returned image is allocated using \fBgnutls_malloc()\fP, is +null\-terminated but art\->size will not account the terminating null. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_range_split.3 b/doc/manpages/gnutls_range_split.3 new file mode 100644 index 0000000..cf1739f --- /dev/null +++ b/doc/manpages/gnutls_range_split.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_range_split" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_range_split \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_range_split(gnutls_session_t " session ", const gnutls_range_st * " orig ", gnutls_range_st * " next ", gnutls_range_st * " remainder ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type +.IP "const gnutls_range_st * orig" 12 +is the original range provided by the user +.IP "gnutls_range_st * next" 12 +is the returned range that can be conveyed in a TLS record +.IP "gnutls_range_st * remainder" 12 +is the returned remaining range +.SH "DESCRIPTION" +This function should be used when it is required to hide the length +of very long data that cannot be directly provided to \fBgnutls_record_send_range()\fP. +In that case this function should be called with the desired length +hiding range in \fIorig\fP . The returned \fInext\fP value should then be used in +the next call to \fBgnutls_record_send_range()\fP with the partial data. +That process should be repeated until \fIremainder\fP is (0,0). +.SH "RETURNS" +0 in case splitting succeeds, non zero in case of error. +Note that \fIorig\fP is not changed, while the values of \fInext\fP and \fIremainder\fP are modified to store the resulting values. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_reauth.3 b/doc/manpages/gnutls_reauth.3 new file mode 100644 index 0000000..6c23803 --- /dev/null +++ b/doc/manpages/gnutls_reauth.3 @@ -0,0 +1,66 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_reauth" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_reauth \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_reauth(gnutls_session_t " session ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function performs the post\-handshake authentication +for TLS 1.3. The post\-handshake authentication is initiated by the server +by calling this function. Clients respond when \fBGNUTLS_E_REAUTH_REQUEST\fP +has been seen while receiving data. + +The non\-fatal errors expected by this function are: +\fBGNUTLS_E_INTERRUPTED\fP, \fBGNUTLS_E_AGAIN\fP, as well as +\fBGNUTLS_E_GOT_APPLICATION_DATA\fP when called on server side. + +The former two interrupt the authentication procedure due to the transport +layer being interrupted, and the latter because there were pending data prior +to peer initiating the re\-authentication. The server should read/process that +data as unauthenticated and retry calling \fBgnutls_reauth()\fP. + +When this function is called under TLS1.2 or earlier or the peer didn't +advertise post\-handshake auth, it always fails with +\fBGNUTLS_E_INVALID_REQUEST\fP. The verification of the received peers certificate +is delegated to the session or credentials verification callbacks. A +server can check whether post handshake authentication is supported +by the client by checking the session flags with \fBgnutls_session_get_flags()\fP. + +Prior to calling this function in server side, the function +\fBgnutls_certificate_server_set_request()\fP must be called setting expectations +for the received certificate (request or require). If none are set +this function will return with \fBGNUTLS_E_INVALID_REQUEST\fP. + +Note that post handshake authentication is available irrespective +of the initial negotiation type (PSK or certificate). In all cases +however, certificate credentials must be set to the session prior +to calling this function. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on a successful authentication, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_can_use_length_hiding.3 b/doc/manpages/gnutls_record_can_use_length_hiding.3 new file mode 100644 index 0000000..5ede07b --- /dev/null +++ b/doc/manpages/gnutls_record_can_use_length_hiding.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_can_use_length_hiding" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_can_use_length_hiding \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_record_can_use_length_hiding(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +If the session supports length\-hiding padding, you can +invoke \fBgnutls_record_send_range()\fP to send a message whose +length is hidden in the given range. If the session does not +support length hiding padding, you can use the standard +\fBgnutls_record_send()\fP function, or \fBgnutls_record_send_range()\fP +making sure that the range is the same as the length of the +message you are trying to send. +.SH "RETURNS" +true (1) if the current session supports length\-hiding +padding, false (0) if the current session does not. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_check_corked.3 b/doc/manpages/gnutls_record_check_corked.3 new file mode 100644 index 0000000..c3bcf81 --- /dev/null +++ b/doc/manpages/gnutls_record_check_corked.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_check_corked" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_check_corked \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "size_t gnutls_record_check_corked(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function checks if there pending corked +data in the gnutls buffers \-\-see \fBgnutls_record_cork()\fP. +.SH "RETURNS" +Returns the size of the corked data or zero. +.SH "SINCE" +3.2.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_check_pending.3 b/doc/manpages/gnutls_record_check_pending.3 new file mode 100644 index 0000000..3fdf050 --- /dev/null +++ b/doc/manpages/gnutls_record_check_pending.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_check_pending" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_check_pending \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "size_t gnutls_record_check_pending(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function checks if there are unread data +in the gnutls buffers. If the return value is +non\-zero the next call to \fBgnutls_record_recv()\fP +is guaranteed not to block. +.SH "RETURNS" +Returns the size of the data or zero. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_cork.3 b/doc/manpages/gnutls_record_cork.3 new file mode 100644 index 0000000..d0d9877 --- /dev/null +++ b/doc/manpages/gnutls_record_cork.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_cork" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_cork \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_record_cork(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +If called, \fBgnutls_record_send()\fP will no longer send any records. +Any sent records will be cached until \fBgnutls_record_uncork()\fP is called. + +This function is safe to use with DTLS after GnuTLS 3.3.0. +.SH "SINCE" +3.1.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_disable_padding.3 b/doc/manpages/gnutls_record_disable_padding.3 new file mode 100644 index 0000000..e1a1de5 --- /dev/null +++ b/doc/manpages/gnutls_record_disable_padding.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_disable_padding" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_disable_padding \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_record_disable_padding(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Used to disabled padding in TLS 1.0 and above. Normally you do not +need to use this function, but there are buggy clients that +complain if a server pads the encrypted data. This of course will +disable protection against statistical attacks on the data. + +This function is defunct since 3.1.7. Random padding is disabled +by default unless requested using \fBgnutls_record_send_range()\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_discard_queued.3 b/doc/manpages/gnutls_record_discard_queued.3 new file mode 100644 index 0000000..f1e9816 --- /dev/null +++ b/doc/manpages/gnutls_record_discard_queued.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_discard_queued" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_discard_queued \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "size_t gnutls_record_discard_queued(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function discards all queued to be sent packets in a DTLS session. +These are the packets queued after an interrupted \fBgnutls_record_send()\fP. + +This function can only be used with transports where \fBsend()\fP is +an all\-or\-nothing operation (e.g., UDP). When partial writes are allowed +this function will cause session errors. +.SH "RETURNS" +The number of bytes discarded. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_get_direction.3 b/doc/manpages/gnutls_record_get_direction.3 new file mode 100644 index 0000000..11e3201 --- /dev/null +++ b/doc/manpages/gnutls_record_get_direction.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_get_direction" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_get_direction \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_record_get_direction(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function is useful to determine whether a GnuTLS function was interrupted +while sending or receiving, so that \fBselect()\fP or \fBpoll()\fP may be called appropriately. + +It provides information about the internals of the record +protocol and is only useful if a prior gnutls function call, +e.g. \fBgnutls_handshake()\fP, was interrupted and returned +\fBGNUTLS_E_INTERRUPTED\fP or \fBGNUTLS_E_AGAIN\fP. After such an interrupt +applications may call \fBselect()\fP or \fBpoll()\fP before restoring the +interrupted GnuTLS function. + +This function's output is unreliable if you are using the same + \fIsession\fP in different threads for sending and receiving. +.SH "RETURNS" +0 if interrupted while trying to read data, or 1 while trying to write data. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_get_discarded.3 b/doc/manpages/gnutls_record_get_discarded.3 new file mode 100644 index 0000000..fc29941 --- /dev/null +++ b/doc/manpages/gnutls_record_get_discarded.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_get_discarded" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_get_discarded \- API function +.SH SYNOPSIS +.B #include <gnutls/dtls.h> +.sp +.BI "unsigned int gnutls_record_get_discarded(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Returns the number of discarded packets in a +DTLS connection. +.SH "RETURNS" +The number of discarded packets. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_get_max_early_data_size.3 b/doc/manpages/gnutls_record_get_max_early_data_size.3 new file mode 100644 index 0000000..fe6e79c --- /dev/null +++ b/doc/manpages/gnutls_record_get_max_early_data_size.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_get_max_early_data_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_get_max_early_data_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "size_t gnutls_record_get_max_early_data_size(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function returns the maximum early data size in this connection. +This property can only be set to servers. The client may be +provided with the maximum allowed size through the "early_data" +extension of the NewSessionTicket handshake message. +.SH "RETURNS" +The maximum early data size in this connection. +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_get_max_size.3 b/doc/manpages/gnutls_record_get_max_size.3 new file mode 100644 index 0000000..5a63e8b --- /dev/null +++ b/doc/manpages/gnutls_record_get_max_size.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_get_max_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_get_max_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "size_t gnutls_record_get_max_size(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the record size. The maximum record size is negotiated by the +client after the first handshake message. +.SH "RETURNS" +The maximum record packet size in this connection. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_get_state.3 b/doc/manpages/gnutls_record_get_state.3 new file mode 100644 index 0000000..979a17d --- /dev/null +++ b/doc/manpages/gnutls_record_get_state.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_get_state" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_get_state \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_record_get_state(gnutls_session_t " session ", unsigned " read ", gnutls_datum_t * " mac_key ", gnutls_datum_t * " IV ", gnutls_datum_t * " cipher_key ", unsigned char [8] " seq_number ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type +.IP "unsigned read" 12 +if non\-zero the read parameters are returned, otherwise the write +.IP "gnutls_datum_t * mac_key" 12 +the key used for MAC (if a MAC is used) +.IP "gnutls_datum_t * IV" 12 +the initialization vector or nonce used +.IP "gnutls_datum_t * cipher_key" 12 +the cipher key +.IP "unsigned char [8] seq_number" 12 +A 64\-bit sequence number +.SH "DESCRIPTION" +This function will return the parameters of the current record state. +These are only useful to be provided to an external off\-loading device +or subsystem. The returned values should be considered constant +and valid for the lifetime of the session. + +In that case, to sync the state back you must call \fBgnutls_record_set_state()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. + +Since 3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_overhead_size.3 b/doc/manpages/gnutls_record_overhead_size.3 new file mode 100644 index 0000000..9228d71 --- /dev/null +++ b/doc/manpages/gnutls_record_overhead_size.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_overhead_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_overhead_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "size_t gnutls_record_overhead_size(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is \fBgnutls_session_t\fP +.SH "DESCRIPTION" +This function will return the size in bytes of the overhead +due to TLS (or DTLS) per record. On certain occasions +(e.g., CBC ciphers) the returned value is the maximum +possible overhead. +.SH "SINCE" +3.2.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_recv.3 b/doc/manpages/gnutls_record_recv.3 new file mode 100644 index 0000000..357ac33 --- /dev/null +++ b/doc/manpages/gnutls_record_recv.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_recv" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_recv \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_recv(gnutls_session_t " session ", void * " data ", size_t " data_size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "void * data" 12 +the buffer that the data will be read into +.IP "size_t data_size" 12 +the number of requested bytes +.SH "DESCRIPTION" +This function has the similar semantics with \fBrecv()\fP. The only +difference is that it accepts a GnuTLS session, and uses different +error codes. +In the special case that the peer requests a renegotiation, the +caller will receive an error code of \fBGNUTLS_E_REHANDSHAKE\fP. In case +of a client, this message may be simply ignored, replied with an alert +\fBGNUTLS_A_NO_RENEGOTIATION\fP, or replied with a new handshake, +depending on the client's will. A server receiving this error code +can only initiate a new handshake or terminate the session. + +If \fBEINTR\fP is returned by the internal pull function (the default +is \fBrecv()\fP) then \fBGNUTLS_E_INTERRUPTED\fP will be returned. If +\fBGNUTLS_E_INTERRUPTED\fP or \fBGNUTLS_E_AGAIN\fP is returned, you must +call this function again to get the data. See also +\fBgnutls_record_get_direction()\fP. +.SH "RETURNS" +The number of bytes received and zero on EOF (for stream +connections). A negative error code is returned in case of an error. +The number of bytes received might be less than the requested \fIdata_size\fP . +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_recv_early_data.3 b/doc/manpages/gnutls_record_recv_early_data.3 new file mode 100644 index 0000000..f38d166 --- /dev/null +++ b/doc/manpages/gnutls_record_recv_early_data.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_recv_early_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_recv_early_data \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_recv_early_data(gnutls_session_t " session ", void * " data ", size_t " data_size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "void * data" 12 +the buffer that the data will be read into +.IP "size_t data_size" 12 +the number of requested bytes +.SH "DESCRIPTION" +This function can be used by a server to retrieve data sent early +in the handshake processes when resuming a session. This is used +to implement a zero\-roundtrip (0\-RTT) mode. It has the same +semantics as \fBgnutls_record_recv()\fP. + +This function can be called either in a handshake hook, or after +the handshake is complete. +.SH "RETURNS" +The number of bytes received and zero when early data +reading is complete. A negative error code is returned in case of +an error. If no early data is received during the handshake, this +function returns \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP. The +number of bytes received might be less than the requested + \fIdata_size\fP . +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_recv_packet.3 b/doc/manpages/gnutls_record_recv_packet.3 new file mode 100644 index 0000000..d0e36df --- /dev/null +++ b/doc/manpages/gnutls_record_recv_packet.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_recv_packet" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_recv_packet \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_recv_packet(gnutls_session_t " session ", gnutls_packet_t * " packet ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_packet_t * packet" 12 +the structure that will hold the packet data +.SH "DESCRIPTION" +This is a lower\-level function than \fBgnutls_record_recv()\fP and allows +to directly receive the whole decrypted packet. That avoids a +memory copy, and is intended to be used by applications seeking high +performance. + +The received packet is accessed using \fBgnutls_packet_get()\fP and +must be deinitialized using \fBgnutls_packet_deinit()\fP. The returned +packet will be \fBNULL\fP if the return value is zero (EOF). +.SH "RETURNS" +The number of bytes received and zero on EOF (for stream +connections). A negative error code is returned in case of an error. +.SH "SINCE" +3.3.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_recv_seq.3 b/doc/manpages/gnutls_record_recv_seq.3 new file mode 100644 index 0000000..654cee5 --- /dev/null +++ b/doc/manpages/gnutls_record_recv_seq.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_recv_seq" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_recv_seq \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_recv_seq(gnutls_session_t " session ", void * " data ", size_t " data_size ", unsigned char * " seq ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "void * data" 12 +the buffer that the data will be read into +.IP "size_t data_size" 12 +the number of requested bytes +.IP "unsigned char * seq" 12 +is the packet's 64\-bit sequence number. Should have space for 8 bytes. +.SH "DESCRIPTION" +This function is the same as \fBgnutls_record_recv()\fP, except that +it returns in addition to data, the sequence number of the data. +This is useful in DTLS where record packets might be received +out\-of\-order. The returned 8\-byte sequence number is an +integer in big\-endian format and should be +treated as a unique message identification. +.SH "RETURNS" +The number of bytes received and zero on EOF. A negative +error code is returned in case of an error. The number of bytes +received might be less than \fIdata_size\fP . +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_send.3 b/doc/manpages/gnutls_record_send.3 new file mode 100644 index 0000000..bc063e8 --- /dev/null +++ b/doc/manpages/gnutls_record_send.3 @@ -0,0 +1,68 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_send" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_send \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_send(gnutls_session_t " session ", const void * " data ", size_t " data_size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const void * data" 12 +contains the data to send +.IP "size_t data_size" 12 +is the length of the data +.SH "DESCRIPTION" +This function has the similar semantics with \fBsend()\fP. The only +difference is that it accepts a GnuTLS session, and uses different +error codes. +Note that if the send buffer is full, \fBsend()\fP will block this +function. See the \fBsend()\fP documentation for more information. + +You can replace the default push function which is \fBsend()\fP, by using +\fBgnutls_transport_set_push_function()\fP. + +If the EINTR is returned by the internal push function +then \fBGNUTLS_E_INTERRUPTED\fP will be returned. If +\fBGNUTLS_E_INTERRUPTED\fP or \fBGNUTLS_E_AGAIN\fP is returned, you must +call this function again with the exact same parameters, or provide a +\fBNULL\fP pointer for \fIdata\fP and 0 for \fIdata_size\fP , in order to write the +same data as before. If you wish to discard the previous data instead +of retrying, you must call \fBgnutls_record_discard_queued()\fP before +calling this function with different parameters. Note that the latter +works only on special transports (e.g., UDP). +cf. \fBgnutls_record_get_direction()\fP. + +Note that in DTLS this function will return the \fBGNUTLS_E_LARGE_PACKET\fP +error code if the send data exceed the data MTU value \- as returned +by \fBgnutls_dtls_get_data_mtu()\fP. The errno value EMSGSIZE +also maps to \fBGNUTLS_E_LARGE_PACKET\fP. +Note that since 3.2.13 this function can be called under cork in DTLS +mode, and will refuse to send data over the MTU size by returning +\fBGNUTLS_E_LARGE_PACKET\fP. +.SH "RETURNS" +The number of bytes sent, or a negative error code. The +number of bytes sent might be less than \fIdata_size\fP . The maximum +number of bytes this function can send in a single call depends +on the negotiated maximum record size. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_send2.3 b/doc/manpages/gnutls_record_send2.3 new file mode 100644 index 0000000..f121806 --- /dev/null +++ b/doc/manpages/gnutls_record_send2.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_send2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_send2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_send2(gnutls_session_t " session ", const void * " data ", size_t " data_size ", size_t " pad ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const void * data" 12 +contains the data to send +.IP "size_t data_size" 12 +is the length of the data +.IP "size_t pad" 12 +padding to be added to the record +.IP "unsigned flags" 12 +must be zero +.SH "DESCRIPTION" +This function is identical to \fBgnutls_record_send()\fP except that it +takes an extra argument to specify padding to be added the record. +To determine the maximum size of padding, use +\fBgnutls_record_get_max_size()\fP and \fBgnutls_record_overhead_size()\fP. + +Note that in order for GnuTLS to provide constant time processing +of padding and data in TLS1.3, the flag \fBGNUTLS_SAFE_PADDING_CHECK\fP +must be used in \fBgnutls_init()\fP. +.SH "RETURNS" +The number of bytes sent, or a negative error code. The +number of bytes sent might be less than \fIdata_size\fP . The maximum +number of bytes this function can send in a single call depends +on the negotiated maximum record size. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_send_early_data.3 b/doc/manpages/gnutls_record_send_early_data.3 new file mode 100644 index 0000000..919814c --- /dev/null +++ b/doc/manpages/gnutls_record_send_early_data.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_send_early_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_send_early_data \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_send_early_data(gnutls_session_t " session ", const void * " data ", size_t " data_size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const void * data" 12 +contains the data to send +.IP "size_t data_size" 12 +is the length of the data +.SH "DESCRIPTION" +This function can be used by a client to send data early in the +handshake processes when resuming a session. This is used to +implement a zero\-roundtrip (0\-RTT) mode. It has the same semantics +as \fBgnutls_record_send()\fP. + +There may be a limit to the amount of data sent as early data. Use +\fBgnutls_record_get_max_early_data_size()\fP to check the limit. If the +limit exceeds, this function returns +\fBGNUTLS_E_RECORD_LIMIT_REACHED\fP. +.SH "RETURNS" +The number of bytes sent, or a negative error code. The +number of bytes sent might be less than \fIdata_size\fP . The maximum +number of bytes this function can send in a single call depends +on the negotiated maximum record size. +.SH "SINCE" +3.6.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_send_file.3 b/doc/manpages/gnutls_record_send_file.3 new file mode 100644 index 0000000..8d5ebe9 --- /dev/null +++ b/doc/manpages/gnutls_record_send_file.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_send_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_send_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_send_file(gnutls_session_t " session ", int " fd ", off_t * " offset ", size_t " count ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "int fd" 12 +file descriptor from which to read data. +.IP "off_t * offset" 12 +Is relative to file offset, denotes the starting location for +reading. after function returns, it point to position following +last read byte. +.IP "size_t count" 12 +is the length of the data in bytes to be read from file and send. +.SH "DESCRIPTION" +This function sends data from \fIfd\fP . If KTLS (kernel TLS) is enabled, it will +use the \fBsendfile()\fP system call to avoid overhead of copying data between user +space and the kernel. Otherwise, this functionality is merely emulated by +calling \fBread()\fP and \fBgnutls_record_send()\fP. If this implementation is +suboptimal, check whether KTLS is enabled using +\fBgnutls_transport_is_ktls_enabled()\fP. + +If \fIoffset\fP is NULL then file offset is incremented by number of bytes send, +otherwise file offset remains unchanged. +.SH "RETURNS" +The number of bytes sent, or a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_send_range.3 b/doc/manpages/gnutls_record_send_range.3 new file mode 100644 index 0000000..9dda3d0 --- /dev/null +++ b/doc/manpages/gnutls_record_send_range.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_send_range" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_send_range \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_send_range(gnutls_session_t " session ", const void * " data ", size_t " data_size ", const gnutls_range_st * " range ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const void * data" 12 +contains the data to send. +.IP "size_t data_size" 12 +is the length of the data. +.IP "const gnutls_range_st * range" 12 +is the range of lengths in which the real data length must be hidden. +.SH "DESCRIPTION" +This function operates like \fBgnutls_record_send()\fP but, while +\fBgnutls_record_send()\fP adds minimal padding to each TLS record, +this function uses the TLS extra\-padding feature to conceal the real +data size within the range of lengths provided. +Some TLS sessions do not support extra padding (e.g. stream ciphers in standard +TLS or SSL3 sessions). To know whether the current session supports extra +padding, and hence length hiding, use the \fBgnutls_record_can_use_length_hiding()\fP +function. +.SH "NOTE" +This function currently is limited to blocking sockets. +.SH "RETURNS" +The number of bytes sent (that is data_size in a successful invocation), +or a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_set_max_early_data_size.3 b/doc/manpages/gnutls_record_set_max_early_data_size.3 new file mode 100644 index 0000000..5d45f15 --- /dev/null +++ b/doc/manpages/gnutls_record_set_max_early_data_size.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_set_max_early_data_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_set_max_early_data_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_record_set_max_early_data_size(gnutls_session_t " session ", size_t " size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t size" 12 +is the new size +.SH "DESCRIPTION" +This function sets the maximum early data size in this connection. +This property can only be set to servers. The client may be +provided with the maximum allowed size through the "early_data" +extension of the NewSessionTicket handshake message. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "SINCE" +3.6.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_set_max_recv_size.3 b/doc/manpages/gnutls_record_set_max_recv_size.3 new file mode 100644 index 0000000..4f676c2 --- /dev/null +++ b/doc/manpages/gnutls_record_set_max_recv_size.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_set_max_recv_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_set_max_recv_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_set_max_recv_size(gnutls_session_t " session ", size_t " size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t size" 12 +is the new size +.SH "DESCRIPTION" +This function sets the maximum amount of plaintext received in a +record in this connection. + +The limit is also negotiated through a TLS extension called 'record +size limit'. Note that while the 'record size limit' extension is +preferred, not all TLS implementations use or even understand the +extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "SINCE" +3.6.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_set_max_size.3 b/doc/manpages/gnutls_record_set_max_size.3 new file mode 100644 index 0000000..e6e4421 --- /dev/null +++ b/doc/manpages/gnutls_record_set_max_size.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_set_max_size" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_set_max_size \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "ssize_t gnutls_record_set_max_size(gnutls_session_t " session ", size_t " size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t size" 12 +is the new size +.SH "DESCRIPTION" +This function sets the maximum amount of plaintext sent and +received in a record in this connection. + +Prior to 3.6.4, this function was implemented using a TLS extension +called 'max fragment length', which limits the acceptable values to +512(=2^9), 1024(=2^10), 2048(=2^11) and 4096(=2^12). + +Since 3.6.4, the limit is also negotiated through a new TLS +extension called 'record size limit', which doesn't have the +limitation, as long as the value ranges between 512 and 16384. +Note that while the 'record size limit' extension is preferred, not +all TLS implementations use or even understand the extension. +.SH "DEPRECATED" +if the client can assume that the 'record size limit' +extension is supported by the server, we recommend using +\fBgnutls_record_set_max_recv_size()\fP instead. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_set_state.3 b/doc/manpages/gnutls_record_set_state.3 new file mode 100644 index 0000000..27b7245 --- /dev/null +++ b/doc/manpages/gnutls_record_set_state.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_set_state" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_set_state \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_record_set_state(gnutls_session_t " session ", unsigned " read ", const unsigned char [8] " seq_number ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type +.IP "unsigned read" 12 +if non\-zero the read parameters are returned, otherwise the write +.IP "const unsigned char [8] seq_number" 12 +A 64\-bit sequence number +.SH "DESCRIPTION" +This function will set the sequence number in the current record state. +This function is useful if sending and receiving are offloaded from +gnutls. That is, if \fBgnutls_record_get_state()\fP was used. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. + +Since 3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_set_timeout.3 b/doc/manpages/gnutls_record_set_timeout.3 new file mode 100644 index 0000000..ba68c50 --- /dev/null +++ b/doc/manpages/gnutls_record_set_timeout.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_set_timeout" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_set_timeout \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_record_set_timeout(gnutls_session_t " session ", unsigned int " ms ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int ms" 12 +is a timeout value in milliseconds +.SH "DESCRIPTION" +This function sets the receive timeout for the record layer +to the provided value. Use an \fIms\fP value of zero to disable +timeout (the default), or \fBGNUTLS_INDEFINITE_TIMEOUT\fP, to +set an indefinite timeout. + +This function requires to set a pull timeout callback. See +\fBgnutls_transport_set_pull_timeout_function()\fP. +.SH "SINCE" +3.1.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_record_uncork.3 b/doc/manpages/gnutls_record_uncork.3 new file mode 100644 index 0000000..ea566ad --- /dev/null +++ b/doc/manpages/gnutls_record_uncork.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_uncork" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_record_uncork \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_record_uncork(gnutls_session_t " session ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int flags" 12 +Could be zero or \fBGNUTLS_RECORD_WAIT\fP +.SH "DESCRIPTION" +This resets the effect of \fBgnutls_record_cork()\fP, and flushes any pending +data. If the \fBGNUTLS_RECORD_WAIT\fP flag is specified then this +function will block until the data is sent or a fatal error +occurs (i.e., the function will retry on \fBGNUTLS_E_AGAIN\fP and +\fBGNUTLS_E_INTERRUPTED\fP). + +If the flag \fBGNUTLS_RECORD_WAIT\fP is not specified and the function +is interrupted then the \fBGNUTLS_E_AGAIN\fP or \fBGNUTLS_E_INTERRUPTED\fP +errors will be returned. To obtain the data left in the corked +buffer use \fBgnutls_record_check_corked()\fP. +.SH "RETURNS" +On success the number of transmitted data is returned, or +otherwise a negative error code. +.SH "SINCE" +3.1.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_register_custom_url.3 b/doc/manpages/gnutls_register_custom_url.3 new file mode 100644 index 0000000..72bb55a --- /dev/null +++ b/doc/manpages/gnutls_register_custom_url.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_register_custom_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_register_custom_url \- API function +.SH SYNOPSIS +.B #include <gnutls/urls.h> +.sp +.BI "int gnutls_register_custom_url(const gnutls_custom_url_st * " st ");" +.SH ARGUMENTS +.IP "const gnutls_custom_url_st * st" 12 +A \fBgnutls_custom_url_st\fP structure +.SH "DESCRIPTION" +Register a custom URL. This will affect the following functions: +\fBgnutls_url_is_supported()\fP, \fBgnutls_privkey_import_url()\fP, +gnutls_pubkey_import_url, \fBgnutls_x509_crt_import_url()\fP +and all functions that depend on +them, e.g., \fBgnutls_certificate_set_x509_key_file2()\fP. + +The provided structure and callback functions must be valid throughout +the lifetime of the process. The registration of an existing URL type +will fail with \fBGNUTLS_E_INVALID_REQUEST\fP. Since GnuTLS 3.5.0 this function +can be used to override the builtin URLs. + +This function is not thread safe. +.SH "RETURNS" +returns zero if the given structure was imported or a negative value otherwise. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_rehandshake.3 b/doc/manpages/gnutls_rehandshake.3 new file mode 100644 index 0000000..a267f5d --- /dev/null +++ b/doc/manpages/gnutls_rehandshake.3 @@ -0,0 +1,66 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rehandshake" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_rehandshake \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_rehandshake(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function can only be called in server side, and +instructs a TLS 1.2 or earlier client to renegotiate +parameters (perform a handshake), by sending a +hello request message. + +If this function succeeds, the calling application +should call \fBgnutls_record_recv()\fP until \fBGNUTLS_E_REHANDSHAKE\fP +is returned to clear any pending data. If the \fBGNUTLS_E_REHANDSHAKE\fP +error code is not seen, then the handshake request was +not followed by the peer (the TLS protocol does not require +the client to do, and such compliance should be handled +by the application protocol). + +Once the \fBGNUTLS_E_REHANDSHAKE\fP error code is seen, the +calling application should proceed to calling +\fBgnutls_handshake()\fP to negotiate the new +parameters. + +If the client does not wish to renegotiate parameters he +may reply with an alert message, and in that case the return code seen +by subsequent \fBgnutls_record_recv()\fP will be +\fBGNUTLS_E_WARNING_ALERT_RECEIVED\fP with the specific alert being +\fBGNUTLS_A_NO_RENEGOTIATION\fP. A client may also choose to ignore +this request. + +Under TLS 1.3 this function is equivalent to \fBgnutls_session_key_update()\fP +with the \fBGNUTLS_KU_PEER\fP flag. In that case subsequent calls to +\fBgnutls_record_recv()\fP will not return \fBGNUTLS_E_REHANDSHAKE\fP, and +calls to \fBgnutls_handshake()\fP in server side are a no\-op. + +This function always fails with \fBGNUTLS_E_INVALID_REQUEST\fP when +called in client side. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_rnd.3 b/doc/manpages/gnutls_rnd.3 new file mode 100644 index 0000000..f385ab1 --- /dev/null +++ b/doc/manpages/gnutls_rnd.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rnd" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_rnd \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "int gnutls_rnd(gnutls_rnd_level_t " level ", void * " data ", size_t " len ");" +.SH ARGUMENTS +.IP "gnutls_rnd_level_t level" 12 +a security level +.IP "void * data" 12 +place to store random bytes +.IP "size_t len" 12 +The requested size +.SH "DESCRIPTION" +This function will generate random data and store it to output +buffer. The value of \fIlevel\fP should be one of \fBGNUTLS_RND_NONCE\fP, +\fBGNUTLS_RND_RANDOM\fP and \fBGNUTLS_RND_KEY\fP. See the manual and +\fBgnutls_rnd_level_t\fP for detailed information. + +This function is thread\-safe and also fork\-safe. +.SH "RETURNS" +Zero on success, or a negative error code on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_rnd_refresh.3 b/doc/manpages/gnutls_rnd_refresh.3 new file mode 100644 index 0000000..2dff237 --- /dev/null +++ b/doc/manpages/gnutls_rnd_refresh.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rnd_refresh" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_rnd_refresh \- API function +.SH SYNOPSIS +.B #include <gnutls/crypto.h> +.sp +.BI "void gnutls_rnd_refresh( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +This function refreshes the random generator state. +That is the current precise time, CPU usage, and +other values are input into its state. + +On a slower rate input from /dev/urandom is mixed too. +.SH "SINCE" +3.1.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_safe_renegotiation_status.3 b/doc/manpages/gnutls_safe_renegotiation_status.3 new file mode 100644 index 0000000..f14a980 --- /dev/null +++ b/doc/manpages/gnutls_safe_renegotiation_status.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_safe_renegotiation_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_safe_renegotiation_status \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_safe_renegotiation_status(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Can be used to check whether safe renegotiation is being used +in the current session. +.SH "RETURNS" +0 when safe renegotiation is not used and non (0) when +safe renegotiation is used. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sec_param_get_name.3 b/doc/manpages/gnutls_sec_param_get_name.3 new file mode 100644 index 0000000..57f1e2e --- /dev/null +++ b/doc/manpages/gnutls_sec_param_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sec_param_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sec_param_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_sec_param_get_name(gnutls_sec_param_t " param ");" +.SH ARGUMENTS +.IP "gnutls_sec_param_t param" 12 +is a security parameter +.SH "DESCRIPTION" +Convert a \fBgnutls_sec_param_t\fP value to a string. +.SH "RETURNS" +a pointer to a string that contains the name of the +specified security level, or \fBNULL\fP. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sec_param_to_pk_bits.3 b/doc/manpages/gnutls_sec_param_to_pk_bits.3 new file mode 100644 index 0000000..6fd66b7 --- /dev/null +++ b/doc/manpages/gnutls_sec_param_to_pk_bits.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sec_param_to_pk_bits" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sec_param_to_pk_bits \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned int gnutls_sec_param_to_pk_bits(gnutls_pk_algorithm_t " algo ", gnutls_sec_param_t " param ");" +.SH ARGUMENTS +.IP "gnutls_pk_algorithm_t algo" 12 +is a public key algorithm +.IP "gnutls_sec_param_t param" 12 +is a security parameter +.SH "DESCRIPTION" +When generating private and public key pairs a difficult question +is which size of "bits" the modulus will be in RSA and the group size +in DSA. The easy answer is 1024, which is also wrong. This function +will convert a human understandable security parameter to an +appropriate size for the specific algorithm. +.SH "RETURNS" +The number of bits, or (0). +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sec_param_to_symmetric_bits.3 b/doc/manpages/gnutls_sec_param_to_symmetric_bits.3 new file mode 100644 index 0000000..024b268 --- /dev/null +++ b/doc/manpages/gnutls_sec_param_to_symmetric_bits.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sec_param_to_symmetric_bits" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sec_param_to_symmetric_bits \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned int gnutls_sec_param_to_symmetric_bits(gnutls_sec_param_t " param ");" +.SH ARGUMENTS +.IP "gnutls_sec_param_t param" 12 +is a security parameter +.SH "DESCRIPTION" +This function will return the number of bits that correspond to +symmetric cipher strength for the given security parameter. +.SH "RETURNS" +The number of bits, or (0). +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_server_name_get.3 b/doc/manpages/gnutls_server_name_get.3 new file mode 100644 index 0000000..11783a2 --- /dev/null +++ b/doc/manpages/gnutls_server_name_get.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_server_name_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_server_name_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_server_name_get(gnutls_session_t " session ", void * " data ", size_t * " data_length ", unsigned int * " type ", unsigned int " indx ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "void * data" 12 +will hold the data +.IP "size_t * data_length" 12 +will hold the data length. Must hold the maximum size of data. +.IP "unsigned int * type" 12 +will hold the server name indicator type +.IP "unsigned int indx" 12 +is the index of the server_name +.SH "DESCRIPTION" +This function will allow you to get the name indication (if any), a +client has sent. The name indication may be any of the enumeration +gnutls_server_name_type_t. + +If \fItype\fP is GNUTLS_NAME_DNS, then this function is to be used by +servers that support virtual hosting, and the data will be a null +terminated IDNA ACE string (prior to GnuTLS 3.4.0 it was a UTF\-8 string). + +If \fIdata\fP has not enough size to hold the server name +GNUTLS_E_SHORT_MEMORY_BUFFER is returned, and \fIdata_length\fP will +hold the required size. + + \fIindx\fP is used to retrieve more than one server names (if sent by +the client). The first server name has an index of 0, the second 1 +and so on. If no name with the given index exists +GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, on UTF\-8 +decoding error \fBGNUTLS_E_IDNA_ERROR\fP is returned, otherwise a negative +error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_server_name_set.3 b/doc/manpages/gnutls_server_name_set.3 new file mode 100644 index 0000000..1c9ed1a --- /dev/null +++ b/doc/manpages/gnutls_server_name_set.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_server_name_set" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_server_name_set \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_server_name_set(gnutls_session_t " session ", gnutls_server_name_type_t " type ", const void * " name ", size_t " name_length ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_server_name_type_t type" 12 +specifies the indicator type +.IP "const void * name" 12 +is a string that contains the server name. +.IP "size_t name_length" 12 +holds the length of name excluding the terminating null byte +.SH "DESCRIPTION" +This function is to be used by clients that want to inform (via a +TLS extension mechanism) the server of the name they connected to. +This should be used by clients that connect to servers that do +virtual hosting. + +The value of \fIname\fP depends on the \fItype\fP type. In case of +\fBGNUTLS_NAME_DNS\fP, a UTF\-8 null\-terminated domain name string, +without the trailing dot, is expected. + +IPv4 or IPv6 addresses are not permitted to be set by this function. +If the function is called with a name of \fIname_length\fP zero it will clear +all server names set. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_channel_binding.3 b/doc/manpages/gnutls_session_channel_binding.3 new file mode 100644 index 0000000..c9860e5 --- /dev/null +++ b/doc/manpages/gnutls_session_channel_binding.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_channel_binding" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_channel_binding \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_channel_binding(gnutls_session_t " session ", gnutls_channel_binding_t " cbtype ", gnutls_datum_t * " cb ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_channel_binding_t cbtype" 12 +an \fBgnutls_channel_binding_t\fP enumeration type +.IP "gnutls_datum_t * cb" 12 +output buffer array with data +.SH "DESCRIPTION" +Extract given channel binding data of the \fIcbtype\fP (e.g., +\fBGNUTLS_CB_TLS_UNIQUE\fP) type. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, +\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP if the \fIcbtype\fP is unsupported, +\fBGNUTLS_E_CHANNEL_BINDING_NOT_AVAILABLE\fP if the data is not +currently available, or an error code. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_enable_compatibility_mode.3 b/doc/manpages/gnutls_session_enable_compatibility_mode.3 new file mode 100644 index 0000000..7029f90 --- /dev/null +++ b/doc/manpages/gnutls_session_enable_compatibility_mode.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_enable_compatibility_mode" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_enable_compatibility_mode \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_enable_compatibility_mode(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function can be used to disable certain (security) features in +TLS in order to maintain maximum compatibility with buggy +clients. Because several trade\-offs with security are enabled, +if required they will be reported through the audit subsystem. + +Normally only servers that require maximum compatibility with +everything out there, need to call this function. + +Note that this function must be called after any call to gnutls_priority +functions. +.SH "SINCE" +2.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_etm_status.3 b/doc/manpages/gnutls_session_etm_status.3 new file mode 100644 index 0000000..e08f51e --- /dev/null +++ b/doc/manpages/gnutls_session_etm_status.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_etm_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_etm_status \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_session_etm_status(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the status of the encrypt\-then\-mac extension negotiation. +This is in accordance to rfc7366 +.SH "RETURNS" +Non\-zero if the negotiation was successful or zero otherwise. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_ext_master_secret_status.3 b/doc/manpages/gnutls_session_ext_master_secret_status.3 new file mode 100644 index 0000000..211589a --- /dev/null +++ b/doc/manpages/gnutls_session_ext_master_secret_status.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_ext_master_secret_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_ext_master_secret_status \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_session_ext_master_secret_status(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get the status of the extended master secret extension negotiation. +This is in accordance to RFC7627. That information is also +available to the more generic \fBgnutls_session_get_flags()\fP. +.SH "RETURNS" +Non\-zero if the negotiation was successful or zero otherwise. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_ext_register.3 b/doc/manpages/gnutls_session_ext_register.3 new file mode 100644 index 0000000..00bfd5c --- /dev/null +++ b/doc/manpages/gnutls_session_ext_register.3 @@ -0,0 +1,70 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_ext_register" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_ext_register \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_ext_register(gnutls_session_t " session ", const char * " name ", int " id ", gnutls_ext_parse_type_t " parse_point ", gnutls_ext_recv_func " recv_func ", gnutls_ext_send_func " send_func ", gnutls_ext_deinit_data_func " deinit_func ", gnutls_ext_pack_func " pack_func ", gnutls_ext_unpack_func " unpack_func ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +the session for which this extension will be set +.IP "const char * name" 12 +the name of the extension to register +.IP "int id" 12 +the numeric id of the extension +.IP "gnutls_ext_parse_type_t parse_point" 12 +the parse type of the extension (see gnutls_ext_parse_type_t) +.IP "gnutls_ext_recv_func recv_func" 12 +a function to receive the data +.IP "gnutls_ext_send_func send_func" 12 +a function to send the data +.IP "gnutls_ext_deinit_data_func deinit_func" 12 +a function deinitialize any private data +.IP "gnutls_ext_pack_func pack_func" 12 +a function which serializes the extension's private data (used on session packing for resumption) +.IP "gnutls_ext_unpack_func unpack_func" 12 +a function which will deserialize the extension's private data +.IP "unsigned flags" 12 +must be zero or flags from \fBgnutls_ext_flags_t\fP +.SH "DESCRIPTION" +This function will register a new extension type. The extension will be +only usable within the registered session. If the extension type +is already registered then \fBGNUTLS_E_ALREADY_REGISTERED\fP will be returned, +unless the flag \fBGNUTLS_EXT_FLAG_OVERRIDE_INTERNAL\fP is specified. The latter +flag when specified can be used to override certain extensions introduced +after 3.6.0. It is expected to be used by applications which handle +custom extensions that are not currently supported in GnuTLS, but direct +support for them may be added in the future. + +Each registered extension can store temporary data into the gnutls_session_t +structure using \fBgnutls_ext_set_data()\fP, and they can be retrieved using +\fBgnutls_ext_get_data()\fP. + +The validity of the extension registered can be given by the appropriate flags +of \fBgnutls_ext_flags_t\fP. If no validity is given, then the registered extension +will be valid for client and TLS1.2 server hello (or encrypted extensions for TLS1.3). +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.5.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_force_valid.3 b/doc/manpages/gnutls_session_force_valid.3 new file mode 100644 index 0000000..8df7b06 --- /dev/null +++ b/doc/manpages/gnutls_session_force_valid.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_force_valid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_force_valid \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_force_valid(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Clears the invalid flag in a session. That means +that sessions were corrupt or invalid data were received +can be re\-used. Use only when debugging or experimenting +with the TLS protocol. Should not be used in typical +applications. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_data.3 b/doc/manpages/gnutls_session_get_data.3 new file mode 100644 index 0000000..9871303 --- /dev/null +++ b/doc/manpages/gnutls_session_get_data.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_data \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_get_data(gnutls_session_t " session ", void * " session_data ", size_t * " session_data_size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "void * session_data" 12 +is a pointer to space to hold the session. +.IP "size_t * session_data_size" 12 +is the session_data's size, or it will be set by the function. +.SH "DESCRIPTION" +Returns all session parameters needed to be stored to support resumption, +in a pre\-allocated buffer. + +See \fBgnutls_session_get_data2()\fP for more information. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_data2.3 b/doc/manpages/gnutls_session_get_data2.3 new file mode 100644 index 0000000..ac76316 --- /dev/null +++ b/doc/manpages/gnutls_session_get_data2.3 @@ -0,0 +1,68 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_data2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_data2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_get_data2(gnutls_session_t " session ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_datum_t * data" 12 +is a pointer to a datum that will hold the session. +.SH "DESCRIPTION" +Returns necessary parameters to support resumption. The client +should call this function and store the returned session data. A session +can be resumed later by calling \fBgnutls_session_set_data()\fP with the returned +data. Note that under TLS 1.3, it is recommended for clients to use +session parameters only once, to prevent passive\-observers from correlating +the different connections. + +The returned \fIdata\fP are allocated and must be released using \fBgnutls_free()\fP. + +This function will fail if called prior to handshake completion. In +case of false start TLS, the handshake completes only after data have +been successfully received from the peer. + +Under TLS1.3 session resumption is possible only after a session ticket +is received by the client. To ensure that such a ticket has been received use +\fBgnutls_session_get_flags()\fP and check for flag \fBGNUTLS_SFLAGS_SESSION_TICKET\fP; +if this flag is not set, this function will wait for a new ticket within +an estimated roundtrip, and if not received will return dummy data which +cannot lead to resumption. + +To get notified when new tickets are received by the server +use \fBgnutls_handshake_set_hook_function()\fP to wait for \fBGNUTLS_HANDSHAKE_NEW_SESSION_TICKET\fP +messages. Each call of \fBgnutls_session_get_data2()\fP after a ticket is +received, will return session resumption data corresponding to the last +received ticket. + +Note that this function under TLS1.3 requires a callback to be set with +\fBgnutls_transport_set_pull_timeout_function()\fP for successful operation. There +was a bug before 3.6.10 which could make this function fail if that callback +was not set. On later versions if not set, the function will return a successful +error code, but will return dummy data that cannot lead to a resumption. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_desc.3 b/doc/manpages/gnutls_session_get_desc.3 new file mode 100644 index 0000000..bb3da4f --- /dev/null +++ b/doc/manpages/gnutls_session_get_desc.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_desc" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_desc \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "char * gnutls_session_get_desc(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +This function returns a string describing the current session. +The string is null terminated and allocated using \fBgnutls_malloc()\fP. + +If initial negotiation is not complete when this function is called, +\fBNULL\fP will be returned. +.SH "RETURNS" +a description of the protocols and algorithms in the current session. +.SH "SINCE" +3.1.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_flags.3 b/doc/manpages/gnutls_session_get_flags.3 new file mode 100644 index 0000000..d4a14be --- /dev/null +++ b/doc/manpages/gnutls_session_get_flags.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_flags" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_flags \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_session_get_flags(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +This function will return a series (ORed) of flags, applicable +for the current session. + +This replaces individual informational functions such as +\fBgnutls_safe_renegotiation_status()\fP, \fBgnutls_session_ext_master_secret_status()\fP, +etc. +.SH "RETURNS" +An ORed sequence of flags (see \fBgnutls_session_flags_t\fP) +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_id.3 b/doc/manpages/gnutls_session_get_id.3 new file mode 100644 index 0000000..1c7a3a9 --- /dev/null +++ b/doc/manpages/gnutls_session_get_id.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_get_id(gnutls_session_t " session ", void * " session_id ", size_t * " session_id_size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "void * session_id" 12 +is a pointer to space to hold the session id. +.IP "size_t * session_id_size" 12 +initially should contain the maximum \fIsession_id\fP size and will be updated. +.SH "DESCRIPTION" +Returns the TLS session identifier. The session ID is selected by the +server, and in older versions of TLS was a unique identifier shared +between client and server which was persistent across resumption. +In the latest version of TLS (1.3) or TLS with session tickets, the +notion of session identifiers is undefined and cannot be relied for uniquely +identifying sessions across client and server. + +In client side this function returns the identifier returned by the +server, and cannot be assumed to have any relation to session resumption. +In server side this function is guaranteed to return a persistent +identifier of the session since GnuTLS 3.6.4, which may not necessarily +map into the TLS session ID value. Prior to that version the value +could only be considered a persistent identifier, under TLS1.2 or earlier +and when no session tickets were in use. + +The session identifier value returned is always less than +\fBGNUTLS_MAX_SESSION_ID_SIZE\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_id2.3 b/doc/manpages/gnutls_session_get_id2.3 new file mode 100644 index 0000000..f845f80 --- /dev/null +++ b/doc/manpages/gnutls_session_get_id2.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_id2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_id2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_get_id2(gnutls_session_t " session ", gnutls_datum_t * " session_id ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_datum_t * session_id" 12 +will point to the session ID. +.SH "DESCRIPTION" +Returns the TLS session identifier. The session ID is selected by the +server, and in older versions of TLS was a unique identifier shared +between client and server which was persistent across resumption. +In the latest version of TLS (1.3) or TLS 1.2 with session tickets, the +notion of session identifiers is undefined and cannot be relied for uniquely +identifying sessions across client and server. + +In client side this function returns the identifier returned by the +server, and cannot be assumed to have any relation to session resumption. +In server side this function is guaranteed to return a persistent +identifier of the session since GnuTLS 3.6.4, which may not necessarily +map into the TLS session ID value. Prior to that version the value +could only be considered a persistent identifier, under TLS1.2 or earlier +and when no session tickets were in use. + +The session identifier value returned is always less than +\fBGNUTLS_MAX_SESSION_ID_SIZE\fP and should be treated as constant. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_keylog_function.3 b/doc/manpages/gnutls_session_get_keylog_function.3 new file mode 100644 index 0000000..c8cb6c3 --- /dev/null +++ b/doc/manpages/gnutls_session_get_keylog_function.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_keylog_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_keylog_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_keylog_func gnutls_session_get_keylog_function(const gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "const gnutls_session_t session" 12 +is \fBgnutls_session_t\fP type +.SH "DESCRIPTION" +This function will return the callback function set using +\fBgnutls_session_set_keylog_function()\fP. +.SH "RETURNS" +The function set or \fBNULL\fP otherwise. +.SH "SINCE" +3.6.13 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_master_secret.3 b/doc/manpages/gnutls_session_get_master_secret.3 new file mode 100644 index 0000000..101d3f7 --- /dev/null +++ b/doc/manpages/gnutls_session_get_master_secret.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_master_secret" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_master_secret \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_get_master_secret(gnutls_session_t " session ", gnutls_datum_t * " secret ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_datum_t * secret" 12 +the session's master secret +.SH "DESCRIPTION" +This function returns pointers to the master secret +used in the TLS session. The pointers are not to be modified or deallocated. + +This function is only applicable under TLS 1.2 or earlier versions. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_ptr.3 b/doc/manpages/gnutls_session_get_ptr.3 new file mode 100644 index 0000000..6fb1b82 --- /dev/null +++ b/doc/manpages/gnutls_session_get_ptr.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void * gnutls_session_get_ptr(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Get user pointer for session. Useful in callbacks. This is the +pointer set with \fBgnutls_session_set_ptr()\fP. +.SH "RETURNS" +the user given pointer from the session structure, or +\fBNULL\fP if it was never set. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_random.3 b/doc/manpages/gnutls_session_get_random.3 new file mode 100644 index 0000000..289ef75 --- /dev/null +++ b/doc/manpages/gnutls_session_get_random.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_random" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_random \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_get_random(gnutls_session_t " session ", gnutls_datum_t * " client ", gnutls_datum_t * " server ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_datum_t * client" 12 +the client part of the random +.IP "gnutls_datum_t * server" 12 +the server part of the random +.SH "DESCRIPTION" +This function returns pointers to the client and server +random fields used in the TLS handshake. The pointers are +not to be modified or deallocated. + +If a client random value has not yet been established, the output +will be garbage. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_get_verify_cert_status.3 b/doc/manpages/gnutls_session_get_verify_cert_status.3 new file mode 100644 index 0000000..87cf036 --- /dev/null +++ b/doc/manpages/gnutls_session_get_verify_cert_status.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_verify_cert_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_verify_cert_status \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned int gnutls_session_get_verify_cert_status(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +This function returns the status of the verification when initiated +via auto\-verification, i.e., by \fBgnutls_session_set_verify_cert2()\fP or +\fBgnutls_session_set_verify_cert()\fP. If no certificate verification +was occurred then the return value would be set to ((unsigned int)\-1). + +The certificate verification status is the same as in \fBgnutls_certificate_verify_peers()\fP. +.SH "RETURNS" +the certificate verification status. +.SH "SINCE" +3.4.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_is_resumed.3 b/doc/manpages/gnutls_session_is_resumed.3 new file mode 100644 index 0000000..fffdb6a --- /dev/null +++ b/doc/manpages/gnutls_session_is_resumed.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_is_resumed" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_is_resumed \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_is_resumed(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Checks whether session is resumed or not. This is functional +for both server and client side. +.SH "RETURNS" +non zero if this session is resumed, or a zero if this is +a new session. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_key_update.3 b/doc/manpages/gnutls_session_key_update.3 new file mode 100644 index 0000000..1416c14 --- /dev/null +++ b/doc/manpages/gnutls_session_key_update.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_key_update" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_key_update \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_key_update(gnutls_session_t " session ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned flags" 12 +zero of \fBGNUTLS_KU_PEER\fP +.SH "DESCRIPTION" +This function will update/refresh the session keys when the +TLS protocol is 1.3 or better. The peer is notified of the +update by sending a message, so this function should be +treated similarly to \fBgnutls_record_send()\fP \-\-i.e., it may +return \fBGNUTLS_E_AGAIN\fP or \fBGNUTLS_E_INTERRUPTED\fP. + +When this flag \fBGNUTLS_KU_PEER\fP is specified, this function +in addition to updating the local keys, will ask the peer to +refresh its keys too. + +If the negotiated version is not TLS 1.3 or better this +function will return \fBGNUTLS_E_INVALID_REQUEST\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_resumption_requested.3 b/doc/manpages/gnutls_session_resumption_requested.3 new file mode 100644 index 0000000..39a10b1 --- /dev/null +++ b/doc/manpages/gnutls_session_resumption_requested.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_resumption_requested" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_resumption_requested \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_resumption_requested(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Check whether the client has asked for session resumption. +This function is valid only on server side. +.SH "RETURNS" +non zero if session resumption was asked, or a zero if not. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_set_data.3 b/doc/manpages/gnutls_session_set_data.3 new file mode 100644 index 0000000..a8bb042 --- /dev/null +++ b/doc/manpages/gnutls_session_set_data.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_data \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_set_data(gnutls_session_t " session ", const void * " session_data ", size_t " session_data_size ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const void * session_data" 12 +is a pointer to space to hold the session. +.IP "size_t session_data_size" 12 +is the session's size +.SH "DESCRIPTION" +Sets all session parameters, in order to resume a previously +established session. The session data given must be the one +returned by \fBgnutls_session_get_data()\fP. This function should be +called before \fBgnutls_handshake()\fP. + +Keep in mind that session resuming is advisory. The server may +choose not to resume the session, thus a full handshake will be +performed. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_set_id.3 b/doc/manpages/gnutls_session_set_id.3 new file mode 100644 index 0000000..30f3cf0 --- /dev/null +++ b/doc/manpages/gnutls_session_set_id.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_set_id(gnutls_session_t " session ", const gnutls_datum_t * " sid ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const gnutls_datum_t * sid" 12 +the session identifier +.SH "DESCRIPTION" +This function sets the session ID to be used in a client hello. +This is a function intended for exceptional uses. Do not use this +function unless you are implementing a custom protocol. + +To set session resumption parameters use \fBgnutls_session_set_data()\fP instead. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +3.2.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_set_keylog_function.3 b/doc/manpages/gnutls_session_set_keylog_function.3 new file mode 100644 index 0000000..b6beb61 --- /dev/null +++ b/doc/manpages/gnutls_session_set_keylog_function.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_keylog_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_keylog_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_set_keylog_function(gnutls_session_t " session ", gnutls_keylog_func " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is \fBgnutls_session_t\fP type +.IP "gnutls_keylog_func func" 12 +is the function to be called +.SH "DESCRIPTION" +This function will set a callback to be called when a new secret is +derived and installed during handshake. +.SH "SINCE" +3.6.13 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_set_premaster.3 b/doc/manpages/gnutls_session_set_premaster.3 new file mode 100644 index 0000000..6e75230 --- /dev/null +++ b/doc/manpages/gnutls_session_set_premaster.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_premaster" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_premaster \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_set_premaster(gnutls_session_t " session ", unsigned int " entity ", gnutls_protocol_t " version ", gnutls_kx_algorithm_t " kx ", gnutls_cipher_algorithm_t " cipher ", gnutls_mac_algorithm_t " mac ", gnutls_compression_method_t " comp ", const gnutls_datum_t * " master ", const gnutls_datum_t * " session_id ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int entity" 12 +GNUTLS_SERVER or GNUTLS_CLIENT +.IP "gnutls_protocol_t version" 12 +the TLS protocol version +.IP "gnutls_kx_algorithm_t kx" 12 +the key exchange method +.IP "gnutls_cipher_algorithm_t cipher" 12 +the cipher +.IP "gnutls_mac_algorithm_t mac" 12 +the MAC algorithm +.IP "gnutls_compression_method_t comp" 12 +the compression method (ignored) +.IP "const gnutls_datum_t * master" 12 +the master key to use +.IP "const gnutls_datum_t * session_id" 12 +the session identifier +.SH "DESCRIPTION" +This function sets the premaster secret in a session. This is +a function intended for exceptional uses. Do not use this +function unless you are implementing a legacy protocol. +Use \fBgnutls_session_set_data()\fP instead. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_set_ptr.3 b/doc/manpages/gnutls_session_set_ptr.3 new file mode 100644 index 0000000..dd665ba --- /dev/null +++ b/doc/manpages/gnutls_session_set_ptr.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_set_ptr(gnutls_session_t " session ", void * " ptr ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "void * ptr" 12 +is the user pointer +.SH "DESCRIPTION" +This function will set (associate) the user given pointer \fIptr\fP to +the session structure. This pointer can be accessed with +\fBgnutls_session_get_ptr()\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_set_verify_cert.3 b/doc/manpages/gnutls_session_set_verify_cert.3 new file mode 100644 index 0000000..7a94c80 --- /dev/null +++ b/doc/manpages/gnutls_session_set_verify_cert.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_verify_cert" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_verify_cert \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_set_verify_cert(gnutls_session_t " session ", const char * " hostname ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "const char * hostname" 12 +is the expected name of the peer; may be \fBNULL\fP +.IP "unsigned flags" 12 +flags for certificate verification \-\- \fBgnutls_certificate_verify_flags\fP +.SH "DESCRIPTION" +This function instructs GnuTLS to verify the peer's certificate +using the provided hostname. If the verification fails the handshake +will also fail with \fBGNUTLS_E_CERTIFICATE_VERIFICATION_ERROR\fP. In that +case the verification result can be obtained using \fBgnutls_session_get_verify_cert_status()\fP. + +The \fIhostname\fP pointer provided must remain valid for the lifetime +of the session. More precisely it should be available during any subsequent +handshakes. If no hostname is provided, no hostname verification +will be performed. For a more advanced verification function check +\fBgnutls_session_set_verify_cert2()\fP. + +If \fIflags\fP is provided which contain a profile, this function should be +called after any session priority setting functions. + +The \fBgnutls_session_set_verify_cert()\fP function is intended to be used by TLS +clients to verify the server's certificate. +.SH "SINCE" +3.4.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_set_verify_cert2.3 b/doc/manpages/gnutls_session_set_verify_cert2.3 new file mode 100644 index 0000000..f024102 --- /dev/null +++ b/doc/manpages/gnutls_session_set_verify_cert2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_verify_cert2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_verify_cert2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_set_verify_cert2(gnutls_session_t " session ", gnutls_typed_vdata_st * " data ", unsigned " elements ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "gnutls_typed_vdata_st * data" 12 +an array of typed data +.IP "unsigned elements" 12 +the number of data elements +.IP "unsigned flags" 12 +flags for certificate verification \-\- \fBgnutls_certificate_verify_flags\fP +.SH "DESCRIPTION" +This function instructs GnuTLS to verify the peer's certificate +using the provided typed data information. If the verification fails the handshake +will also fail with \fBGNUTLS_E_CERTIFICATE_VERIFICATION_ERROR\fP. In that +case the verification result can be obtained using \fBgnutls_session_get_verify_cert_status()\fP. + +The acceptable typed data are the same as in \fBgnutls_certificate_verify_peers()\fP, +and once set must remain valid for the lifetime of the session. More precisely +they should be available during any subsequent handshakes. + +If \fIflags\fP is provided which contain a profile, this function should be +called after any session priority setting functions. +.SH "SINCE" +3.4.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_set_verify_function.3 b/doc/manpages/gnutls_session_set_verify_function.3 new file mode 100644 index 0000000..ba9c634 --- /dev/null +++ b/doc/manpages/gnutls_session_set_verify_function.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_verify_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_verify_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_session_set_verify_function(gnutls_session_t " session ", gnutls_certificate_verify_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_certificate_verify_function * func" 12 +is the callback function +.SH "DESCRIPTION" +This function sets a callback to be called when peer's certificate +has been received in order to verify it on receipt rather than +doing after the handshake is completed. This overrides any callback +set using \fBgnutls_certificate_set_verify_function()\fP. + +The callback's function prototype is: +int (*callback)(gnutls_session_t); + +If the callback function is provided then gnutls will call it, in the +handshake, just after the certificate message has been received. +To verify or obtain the certificate the \fBgnutls_certificate_verify_peers2()\fP, +\fBgnutls_certificate_type_get()\fP, \fBgnutls_certificate_get_peers()\fP functions +can be used. + +The callback function should return 0 for the handshake to continue +or non\-zero to terminate. +.SH "SINCE" +3.4.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_set_verify_output_function.3 b/doc/manpages/gnutls_session_set_verify_output_function.3 new file mode 100644 index 0000000..07c9bf8 --- /dev/null +++ b/doc/manpages/gnutls_session_set_verify_output_function.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_verify_output_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_verify_output_function \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_session_set_verify_output_function(gnutls_session_t " session ", gnutls_verify_output_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_x509_trust_list_t\fP type. +.IP "gnutls_verify_output_function * func" 12 +is the callback function +.SH "DESCRIPTION" +This function sets a callback to be called when the peer's certificate +chain has to be verified and full path to the trusted root has to be +printed. + +The callback's function prototype is defined in `x509.h': +int (*callback)( +gnutls_x509_crt_t cert, +gnutls_x509_crt_t issuer, +gnutls_x509_crl_t crl, +unsigned int verification_output); + +If the callback function is provided then gnutls will call it, in the +certificate verification procedure. +To verify the certificate chain and print its path uptp the trusted root, +functions such as \fBgnutls_certificate_verify_peers()\fP, +\fBgnutls_x509_trust_list_verify_crt()\fP, and \fBgnutls_x509_trust_list_verify_crt2()\fP +can be used. The callback is set in \fB_gnutls_verify_crt_status()\fP and +\fB_gnutls_pkcs11_verify_crt_status()\fP. +.SH "SINCE" +3.7.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_supplemental_register.3 b/doc/manpages/gnutls_session_supplemental_register.3 new file mode 100644 index 0000000..e66f9aa --- /dev/null +++ b/doc/manpages/gnutls_session_supplemental_register.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_supplemental_register" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_supplemental_register \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_supplemental_register(gnutls_session_t " session ", const char * " name ", gnutls_supplemental_data_format_type_t " type ", gnutls_supp_recv_func " recv_func ", gnutls_supp_send_func " send_func ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +the session for which this will be registered +.IP "const char * name" 12 +the name of the supplemental data to register +.IP "gnutls_supplemental_data_format_type_t type" 12 +the type of the supplemental data format +.IP "gnutls_supp_recv_func recv_func" 12 +the function to receive the data +.IP "gnutls_supp_send_func send_func" 12 +the function to send the data +.IP "unsigned flags" 12 +must be zero +.SH "DESCRIPTION" +This function will register a new supplemental data type (rfc4680). +The registered supplemental functions will be used for that specific +session. The provided \fItype\fP must be an unassigned type in +\fBgnutls_supplemental_data_format_type_t\fP. + +If the type is already registered or handled by GnuTLS internally +\fBGNUTLS_E_ALREADY_REGISTERED\fP will be returned. + +As supplemental data are not defined under TLS 1.3, this function will +disable TLS 1.3 support for the given session. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.5.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_ticket_enable_client.3 b/doc/manpages/gnutls_session_ticket_enable_client.3 new file mode 100644 index 0000000..e38e16d --- /dev/null +++ b/doc/manpages/gnutls_session_ticket_enable_client.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_ticket_enable_client" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_ticket_enable_client \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_ticket_enable_client(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Request that the client should attempt session resumption using +SessionTicket. This call is typically unnecessary as session +tickets are enabled by default. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_ticket_enable_server.3 b/doc/manpages/gnutls_session_ticket_enable_server.3 new file mode 100644 index 0000000..b67d6e7 --- /dev/null +++ b/doc/manpages/gnutls_session_ticket_enable_server.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_ticket_enable_server" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_ticket_enable_server \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_ticket_enable_server(gnutls_session_t " session ", const gnutls_datum_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const gnutls_datum_t * key" 12 +key to encrypt session parameters. +.SH "DESCRIPTION" +Request that the server should attempt session resumption using +session tickets, i.e., by delegating storage to the client. + \fIkey\fP must be initialized using \fBgnutls_session_ticket_key_generate()\fP. +To avoid leaking that key, use \fBgnutls_memset()\fP prior to +releasing it. + +The default ticket expiration time can be overridden using +\fBgnutls_db_set_cache_expiration()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_ticket_key_generate.3 b/doc/manpages/gnutls_session_ticket_key_generate.3 new file mode 100644 index 0000000..4b083b3 --- /dev/null +++ b/doc/manpages/gnutls_session_ticket_key_generate.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_ticket_key_generate" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_ticket_key_generate \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_ticket_key_generate(gnutls_datum_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_datum_t * key" 12 +is a pointer to a \fBgnutls_datum_t\fP which will contain a newly +created key. +.SH "DESCRIPTION" +Generate a random key to encrypt security parameters within +SessionTicket. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_session_ticket_send.3 b/doc/manpages/gnutls_session_ticket_send.3 new file mode 100644 index 0000000..9f0e16d --- /dev/null +++ b/doc/manpages/gnutls_session_ticket_send.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_ticket_send" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_session_ticket_send \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_session_ticket_send(gnutls_session_t " session ", unsigned " nr ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned nr" 12 +the number of tickets to send +.IP "unsigned flags" 12 +must be zero +.SH "DESCRIPTION" +Sends a fresh session ticket to the peer. This is relevant only +in server side under TLS1.3. This function may also return \fBGNUTLS_E_AGAIN\fP +or \fBGNUTLS_E_INTERRUPTED\fP and in that case it must be called again. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_set_default_priority.3 b/doc/manpages/gnutls_set_default_priority.3 new file mode 100644 index 0000000..c07002d --- /dev/null +++ b/doc/manpages/gnutls_set_default_priority.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_set_default_priority" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_set_default_priority \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_set_default_priority(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Sets the default priority on the ciphers, key exchange methods, +and macs. This is the recommended method of +setting the defaults, in order to promote consistency between applications +using GnuTLS, and to allow GnuTLS using applications to update settings +in par with the library. For client applications which require +maximum compatibility consider calling \fBgnutls_session_enable_compatibility_mode()\fP +after this function. + +For an application to specify additional options to priority string +consider using \fBgnutls_set_default_priority_append()\fP. + +To allow a user to override the defaults (e.g., when a user interface +or configuration file is available), the functions +\fBgnutls_priority_set_direct()\fP or \fBgnutls_priority_set()\fP can +be used. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "SINCE" +2.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_set_default_priority_append.3 b/doc/manpages/gnutls_set_default_priority_append.3 new file mode 100644 index 0000000..6b94683 --- /dev/null +++ b/doc/manpages/gnutls_set_default_priority_append.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_set_default_priority_append" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_set_default_priority_append \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_set_default_priority_append(gnutls_session_t " session ", const char * " add_prio ", const char ** " err_pos ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const char * add_prio" 12 +is a string describing priorities to be appended to default +.IP "const char ** err_pos" 12 +In case of an error this will have the position in the string the error occurred +.IP "unsigned flags" 12 +must be zero +.SH "DESCRIPTION" +Sets the default priority on the ciphers, key exchange methods, +and macs with the additional options in \fIadd_prio\fP . This is the recommended method of +setting the defaults when only few additional options are to be added. This promotes +consistency between applications using GnuTLS, and allows GnuTLS using applications +to update settings in par with the library. + +The \fIadd_prio\fP string should start as a normal priority string, e.g., +'\-VERS\-TLS\-ALL:+VERS\-TLS1.3:%COMPAT' or '%FORCE_ETM'. That is, it must not start +with ':'. + +To allow a user to override the defaults (e.g., when a user interface +or configuration file is available), the functions +\fBgnutls_priority_set_direct()\fP or \fBgnutls_priority_set()\fP can +be used. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_algorithm_get.3 b/doc/manpages/gnutls_sign_algorithm_get.3 new file mode 100644 index 0000000..6c52068 --- /dev/null +++ b/doc/manpages/gnutls_sign_algorithm_get.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_algorithm_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_algorithm_get \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_sign_algorithm_get(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Returns the signature algorithm that is (or will be) used in this +session by the server to sign data. This function should be +used only with TLS 1.2 or later. +.SH "RETURNS" +The sign algorithm or \fBGNUTLS_SIGN_UNKNOWN\fP. +.SH "SINCE" +3.1.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_algorithm_get_client.3 b/doc/manpages/gnutls_sign_algorithm_get_client.3 new file mode 100644 index 0000000..811d807 --- /dev/null +++ b/doc/manpages/gnutls_sign_algorithm_get_client.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_algorithm_get_client" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_algorithm_get_client \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_sign_algorithm_get_client(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Returns the signature algorithm that is (or will be) used in this +session by the client to sign data. This function should be +used only with TLS 1.2 or later. +.SH "RETURNS" +The sign algorithm or \fBGNUTLS_SIGN_UNKNOWN\fP. +.SH "SINCE" +3.1.11 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_algorithm_get_requested.3 b/doc/manpages/gnutls_sign_algorithm_get_requested.3 new file mode 100644 index 0000000..f56418c --- /dev/null +++ b/doc/manpages/gnutls_sign_algorithm_get_requested.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_algorithm_get_requested" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_algorithm_get_requested \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_sign_algorithm_get_requested(gnutls_session_t " session ", size_t " indx ", gnutls_sign_algorithm_t * " algo ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "size_t indx" 12 +is an index of the signature algorithm to return +.IP "gnutls_sign_algorithm_t * algo" 12 +the returned certificate type will be stored there +.SH "DESCRIPTION" +Returns the signature algorithm specified by index that was +requested by the peer. If the specified index has no data available +this function returns \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP. If +the negotiated TLS version does not support signature algorithms +then \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned even +for the first index. The first index is 0. + +This function is useful in the certificate callback functions +to assist in selecting the correct certificate. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_get_hash_algorithm.3 b/doc/manpages/gnutls_sign_get_hash_algorithm.3 new file mode 100644 index 0000000..2a4470b --- /dev/null +++ b/doc/manpages/gnutls_sign_get_hash_algorithm.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_get_hash_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_get_hash_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_digest_algorithm_t gnutls_sign_get_hash_algorithm(gnutls_sign_algorithm_t " sign ");" +.SH ARGUMENTS +.IP "gnutls_sign_algorithm_t sign" 12 +is a signature algorithm +.SH "DESCRIPTION" +This function returns the digest algorithm corresponding to +the given signature algorithms. +.SH "SINCE" +3.1.1 +.SH "RETURNS" +return a \fBgnutls_digest_algorithm_t\fP value, or \fBGNUTLS_DIG_UNKNOWN\fP on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_get_id.3 b/doc/manpages/gnutls_sign_get_id.3 new file mode 100644 index 0000000..5242c3b --- /dev/null +++ b/doc/manpages/gnutls_sign_get_id.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_sign_algorithm_t gnutls_sign_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a sign algorithm name +.SH "DESCRIPTION" +The names are compared in a case insensitive way. +.SH "RETURNS" +return a \fBgnutls_sign_algorithm_t\fP value corresponding to +the specified algorithm, or \fBGNUTLS_SIGN_UNKNOWN\fP on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_get_name.3 b/doc/manpages/gnutls_sign_get_name.3 new file mode 100644 index 0000000..7fe10a9 --- /dev/null +++ b/doc/manpages/gnutls_sign_get_name.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_sign_get_name(gnutls_sign_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_sign_algorithm_t algorithm" 12 +is a sign algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_sign_algorithm_t\fP value to a string. +.SH "RETURNS" +a string that contains the name of the specified sign +algorithm, or \fBNULL\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_get_oid.3 b/doc/manpages/gnutls_sign_get_oid.3 new file mode 100644 index 0000000..f73f9ef --- /dev/null +++ b/doc/manpages/gnutls_sign_get_oid.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_get_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_get_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_sign_get_oid(gnutls_sign_algorithm_t " sign ");" +.SH ARGUMENTS +.IP "gnutls_sign_algorithm_t sign" 12 +is a sign algorithm +.SH "DESCRIPTION" +Convert a \fBgnutls_sign_algorithm_t\fP value to its object identifier. +.SH "RETURNS" +a string that contains the object identifier of the specified sign +algorithm, or \fBNULL\fP. +.SH "SINCE" +3.4.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_get_pk_algorithm.3 b/doc/manpages/gnutls_sign_get_pk_algorithm.3 new file mode 100644 index 0000000..8f1c539 --- /dev/null +++ b/doc/manpages/gnutls_sign_get_pk_algorithm.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_get_pk_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_pk_algorithm_t gnutls_sign_get_pk_algorithm(gnutls_sign_algorithm_t " sign ");" +.SH ARGUMENTS +.IP "gnutls_sign_algorithm_t sign" 12 +is a signature algorithm +.SH "DESCRIPTION" +This function returns the public key algorithm corresponding to +the given signature algorithms. Note that there may be multiple +public key algorithms supporting a particular signature type; +when dealing with such algorithms use instead \fBgnutls_sign_supports_pk_algorithm()\fP. +.SH "SINCE" +3.1.1 +.SH "RETURNS" +return a \fBgnutls_pk_algorithm_t\fP value, or \fBGNUTLS_PK_UNKNOWN\fP on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_is_secure.3 b/doc/manpages/gnutls_sign_is_secure.3 new file mode 100644 index 0000000..8d26428 --- /dev/null +++ b/doc/manpages/gnutls_sign_is_secure.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_is_secure" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_is_secure \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_sign_is_secure(gnutls_sign_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_sign_algorithm_t algorithm" 12 +is a sign algorithm +.SH "RETURNS" +Non\-zero if the provided signature algorithm is considered to be secure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_is_secure2.3 b/doc/manpages/gnutls_sign_is_secure2.3 new file mode 100644 index 0000000..1ef85ef --- /dev/null +++ b/doc/manpages/gnutls_sign_is_secure2.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_is_secure2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_is_secure2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_sign_is_secure2(gnutls_sign_algorithm_t " algorithm ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_sign_algorithm_t algorithm" 12 +is a sign algorithm +.IP "unsigned int flags" 12 +zero or \fBGNUTLS_SIGN_FLAG_SECURE_FOR_CERTS\fP +.SH "RETURNS" +Non\-zero if the provided signature algorithm is considered to be secure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_list.3 b/doc/manpages/gnutls_sign_list.3 new file mode 100644 index 0000000..790b514 --- /dev/null +++ b/doc/manpages/gnutls_sign_list.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_list" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_list \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const gnutls_sign_algorithm_t * gnutls_sign_list( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH "DESCRIPTION" + +Get a list of supported public key signature algorithms. +This function is not thread safe. +.SH "RETURNS" +a (0)\-terminated list of \fBgnutls_sign_algorithm_t\fP +integers indicating the available ciphers. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_set_secure.3 b/doc/manpages/gnutls_sign_set_secure.3 new file mode 100644 index 0000000..8eaa64b --- /dev/null +++ b/doc/manpages/gnutls_sign_set_secure.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_set_secure" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_set_secure \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_sign_set_secure(gnutls_sign_algorithm_t " sign ", unsigned int " secure ");" +.SH ARGUMENTS +.IP "gnutls_sign_algorithm_t sign" 12 +the sign algorithm +.IP "unsigned int secure" 12 +whether to mark the sign algorithm secure +.SH "DESCRIPTION" +Modify the previous system wide setting that marked \fIsign\fP as secure +or insecure. Calling this function is allowed +only if allowlisting mode is set in the configuration file, +and only if the system\-wide TLS priority string +has not been initialized yet. +The intended usage is to provide applications with a way +to expressly deviate from the distribution or site defaults +inherited from the configuration file. +The modification is composable with further modifications +performed through the priority string mechanism. + +This function is not thread\-safe and is intended to be called +in the main thread at the beginning of the process execution. + +Even when \fIsecure\fP is true, \fIsign\fP is not marked as secure for the +use in certificates. Use \fBgnutls_sign_set_secure_for_certs()\fP to +mark it secure as well for certificates. +.SH "RETURNS" +0 on success or negative error code otherwise. +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_set_secure_for_certs.3 b/doc/manpages/gnutls_sign_set_secure_for_certs.3 new file mode 100644 index 0000000..42831d1 --- /dev/null +++ b/doc/manpages/gnutls_sign_set_secure_for_certs.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_set_secure_for_certs" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_set_secure_for_certs \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_sign_set_secure_for_certs(gnutls_sign_algorithm_t " sign ", unsigned int " secure ");" +.SH ARGUMENTS +.IP "gnutls_sign_algorithm_t sign" 12 +the sign algorithm +.IP "unsigned int secure" 12 +whether to mark the sign algorithm secure for certificates +.SH "DESCRIPTION" +Modify the previous system wide setting that marked \fIsign\fP as secure +or insecure for the use in certificates. Calling this fuction is allowed +only if allowlisting mode is set in the configuration file, +and only if the system\-wide TLS priority string +has not been initialized yet. +The intended usage is to provide applications with a way +to expressly deviate from the distribution or site defaults +inherited from the configuration file. +The modification is composable with further modifications +performed through the priority string mechanism. + +This function is not thread\-safe and is intended to be called +in the main thread at the beginning of the process execution. +When \fIsecure\fP is true, \fIsign\fP is marked as secure for any use unlike +\fBgnutls_sign_set_secure()\fP. Otherwise, it is marked as insecure only +for the use in certificates. Use \fBgnutls_sign_set_secure()\fP to mark +it insecure for any uses. +.SH "RETURNS" +0 on success or negative error code otherwise. +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_sign_supports_pk_algorithm.3 b/doc/manpages/gnutls_sign_supports_pk_algorithm.3 new file mode 100644 index 0000000..1c92930 --- /dev/null +++ b/doc/manpages/gnutls_sign_supports_pk_algorithm.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_supports_pk_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_sign_supports_pk_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_sign_supports_pk_algorithm(gnutls_sign_algorithm_t " sign ", gnutls_pk_algorithm_t " pk ");" +.SH ARGUMENTS +.IP "gnutls_sign_algorithm_t sign" 12 +is a signature algorithm +.IP "gnutls_pk_algorithm_t pk" 12 +is a public key algorithm +.SH "DESCRIPTION" +This function returns non\-zero if the public key algorithm corresponds to +the given signature algorithm. That is, if that signature can be generated +from the given private key algorithm. +.SH "SINCE" +3.6.0 +.SH "RETURNS" +return non\-zero when the provided algorithms are compatible. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_allocate_client_credentials.3 b/doc/manpages/gnutls_srp_allocate_client_credentials.3 new file mode 100644 index 0000000..3fff935 --- /dev/null +++ b/doc/manpages/gnutls_srp_allocate_client_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_allocate_client_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_allocate_client_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_allocate_client_credentials(gnutls_srp_client_credentials_t * " sc ");" +.SH ARGUMENTS +.IP "gnutls_srp_client_credentials_t * sc" 12 +is a pointer to a \fBgnutls_srp_server_credentials_t\fP type. +.SH "DESCRIPTION" +Allocate a gnutls_srp_client_credentials_t structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_allocate_server_credentials.3 b/doc/manpages/gnutls_srp_allocate_server_credentials.3 new file mode 100644 index 0000000..0e9e928 --- /dev/null +++ b/doc/manpages/gnutls_srp_allocate_server_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_allocate_server_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_allocate_server_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_allocate_server_credentials(gnutls_srp_server_credentials_t * " sc ");" +.SH ARGUMENTS +.IP "gnutls_srp_server_credentials_t * sc" 12 +is a pointer to a \fBgnutls_srp_server_credentials_t\fP type. +.SH "DESCRIPTION" +Allocate a gnutls_srp_server_credentials_t structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_base64_decode.3 b/doc/manpages/gnutls_srp_base64_decode.3 new file mode 100644 index 0000000..5854cd3 --- /dev/null +++ b/doc/manpages/gnutls_srp_base64_decode.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_base64_decode" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_base64_decode \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_base64_decode(const gnutls_datum_t * " b64_data ", char * " result ", size_t * " result_size ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * b64_data" 12 +contain the encoded data +.IP "char * result" 12 +the place where decoded data will be copied +.IP "size_t * result_size" 12 +holds the size of the result +.SH "DESCRIPTION" +This function will decode the given encoded data, using the base64 +encoding found in libsrp. + +Note that \fIb64_data\fP should be null terminated. + +Warning! This base64 encoding is not the "standard" encoding, so +do not use it for non\-SRP purposes. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not +long enough, or 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_base64_decode2.3 b/doc/manpages/gnutls_srp_base64_decode2.3 new file mode 100644 index 0000000..9bcf488 --- /dev/null +++ b/doc/manpages/gnutls_srp_base64_decode2.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_base64_decode2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_base64_decode2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_base64_decode2(const gnutls_datum_t * " b64_data ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * b64_data" 12 +contains the encoded data +.IP "gnutls_datum_t * result" 12 +the place where decoded data lie +.SH "DESCRIPTION" +This function will decode the given encoded data. The decoded data +will be allocated, and stored into result. It will decode using +the base64 algorithm as used in libsrp. + +You should use \fBgnutls_free()\fP to free the returned data. + +Warning! This base64 encoding is not the "standard" encoding, so +do not use it for non\-SRP purposes. +.SH "RETURNS" +0 on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_base64_encode.3 b/doc/manpages/gnutls_srp_base64_encode.3 new file mode 100644 index 0000000..dd9e7cd --- /dev/null +++ b/doc/manpages/gnutls_srp_base64_encode.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_base64_encode" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_base64_encode \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_base64_encode(const gnutls_datum_t * " data ", char * " result ", size_t * " result_size ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * data" 12 +contain the raw data +.IP "char * result" 12 +the place where base64 data will be copied +.IP "size_t * result_size" 12 +holds the size of the result +.SH "DESCRIPTION" +This function will convert the given data to printable data, using +the base64 encoding, as used in the libsrp. This is the encoding +used in SRP password files. If the provided buffer is not long +enough GNUTLS_E_SHORT_MEMORY_BUFFER is returned. + +Warning! This base64 encoding is not the "standard" encoding, so +do not use it for non\-SRP purposes. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not +long enough, or 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_base64_encode2.3 b/doc/manpages/gnutls_srp_base64_encode2.3 new file mode 100644 index 0000000..d20d2de --- /dev/null +++ b/doc/manpages/gnutls_srp_base64_encode2.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_base64_encode2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_base64_encode2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_base64_encode2(const gnutls_datum_t * " data ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * data" 12 +contains the raw data +.IP "gnutls_datum_t * result" 12 +will hold the newly allocated encoded data +.SH "DESCRIPTION" +This function will convert the given data to printable data, using +the base64 encoding. This is the encoding used in SRP password +files. This function will allocate the required memory to hold +the encoded data. + +You should use \fBgnutls_free()\fP to free the returned data. + +Warning! This base64 encoding is not the "standard" encoding, so +do not use it for non\-SRP purposes. +.SH "RETURNS" +0 on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_free_client_credentials.3 b/doc/manpages/gnutls_srp_free_client_credentials.3 new file mode 100644 index 0000000..1ba871e --- /dev/null +++ b/doc/manpages/gnutls_srp_free_client_credentials.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_free_client_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_free_client_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_srp_free_client_credentials(gnutls_srp_client_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_srp_client_credentials_t sc" 12 +is a \fBgnutls_srp_client_credentials_t\fP type. +.SH "DESCRIPTION" +Free a gnutls_srp_client_credentials_t structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_free_server_credentials.3 b/doc/manpages/gnutls_srp_free_server_credentials.3 new file mode 100644 index 0000000..011393c --- /dev/null +++ b/doc/manpages/gnutls_srp_free_server_credentials.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_free_server_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_free_server_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_srp_free_server_credentials(gnutls_srp_server_credentials_t " sc ");" +.SH ARGUMENTS +.IP "gnutls_srp_server_credentials_t sc" 12 +is a \fBgnutls_srp_server_credentials_t\fP type. +.SH "DESCRIPTION" +Free a gnutls_srp_server_credentials_t structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_server_get_username.3 b/doc/manpages/gnutls_srp_server_get_username.3 new file mode 100644 index 0000000..ee8b41e --- /dev/null +++ b/doc/manpages/gnutls_srp_server_get_username.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_server_get_username" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_server_get_username \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_srp_server_get_username(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH "DESCRIPTION" +This function will return the username of the peer. This should +only be called in case of SRP authentication and in case of a +server. Returns NULL in case of an error. +.SH "RETURNS" +SRP username of the peer, or NULL in case of error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_set_client_credentials.3 b/doc/manpages/gnutls_srp_set_client_credentials.3 new file mode 100644 index 0000000..7af7fd3 --- /dev/null +++ b/doc/manpages/gnutls_srp_set_client_credentials.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_set_client_credentials" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_set_client_credentials \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_set_client_credentials(gnutls_srp_client_credentials_t " res ", const char * " username ", const char * " password ");" +.SH ARGUMENTS +.IP "gnutls_srp_client_credentials_t res" 12 +is a \fBgnutls_srp_client_credentials_t\fP type. +.IP "const char * username" 12 +is the user's userid +.IP "const char * password" 12 +is the user's password +.SH "DESCRIPTION" +This function sets the username and password, in a +\fBgnutls_srp_client_credentials_t\fP type. Those will be used in +SRP authentication. \fIusername\fP should be an ASCII string or UTF\-8 +string. In case of a UTF\-8 string it is recommended to be following +the PRECIS framework for usernames (rfc8265). The password can +be in ASCII format, or normalized using \fBgnutls_utf8_password_normalize()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_set_client_credentials_function.3 b/doc/manpages/gnutls_srp_set_client_credentials_function.3 new file mode 100644 index 0000000..e37ebab --- /dev/null +++ b/doc/manpages/gnutls_srp_set_client_credentials_function.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_set_client_credentials_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_set_client_credentials_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_srp_set_client_credentials_function(gnutls_srp_client_credentials_t " cred ", gnutls_srp_client_credentials_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_srp_client_credentials_t cred" 12 +is a \fBgnutls_srp_server_credentials_t\fP type. +.IP "gnutls_srp_client_credentials_function * func" 12 +is the callback function +.SH "DESCRIPTION" +This function can be used to set a callback to retrieve the +username and password for client SRP authentication. The +callback's function form is: + +int (*callback)(gnutls_session_t, char** username, char**password); + +The \fIusername\fP and \fIpassword\fP must be allocated using +\fBgnutls_malloc()\fP. + +The \fIusername\fP should be an ASCII string or UTF\-8 +string. In case of a UTF\-8 string it is recommended to be following +the PRECIS framework for usernames (rfc8265). The password can +be in ASCII format, or normalized using \fBgnutls_utf8_password_normalize()\fP. + +The callback function will be called once per handshake before the +initial hello message is sent. + +The callback should not return a negative error code the second +time called, since the handshake procedure will be aborted. + +The callback function should return 0 on success. +\-1 indicates an error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_set_prime_bits.3 b/doc/manpages/gnutls_srp_set_prime_bits.3 new file mode 100644 index 0000000..25625c3 --- /dev/null +++ b/doc/manpages/gnutls_srp_set_prime_bits.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_set_prime_bits" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_set_prime_bits \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_srp_set_prime_bits(gnutls_session_t " session ", unsigned int " bits ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned int bits" 12 +is the number of bits +.SH "DESCRIPTION" +This function sets the minimum accepted number of bits, for use in +an SRP key exchange. If zero, the default 2048 bits will be used. + +In the client side it sets the minimum accepted number of bits. If +a server sends a prime with less bits than that +\fBGNUTLS_E_RECEIVED_ILLEGAL_PARAMETER\fP will be returned by the +handshake. + +This function has no effect in server side. +.SH "SINCE" +2.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_set_server_credentials_file.3 b/doc/manpages/gnutls_srp_set_server_credentials_file.3 new file mode 100644 index 0000000..0d62411 --- /dev/null +++ b/doc/manpages/gnutls_srp_set_server_credentials_file.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_set_server_credentials_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_set_server_credentials_file \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_set_server_credentials_file(gnutls_srp_server_credentials_t " res ", const char * " password_file ", const char * " password_conf_file ");" +.SH ARGUMENTS +.IP "gnutls_srp_server_credentials_t res" 12 +is a \fBgnutls_srp_server_credentials_t\fP type. +.IP "const char * password_file" 12 +is the SRP password file (tpasswd) +.IP "const char * password_conf_file" 12 +is the SRP password conf file (tpasswd.conf) +.SH "DESCRIPTION" +This function sets the password files, in a +\fBgnutls_srp_server_credentials_t\fP type. Those password files +hold usernames and verifiers and will be used for SRP +authentication. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_set_server_credentials_function.3 b/doc/manpages/gnutls_srp_set_server_credentials_function.3 new file mode 100644 index 0000000..b30ad82 --- /dev/null +++ b/doc/manpages/gnutls_srp_set_server_credentials_function.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_set_server_credentials_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_set_server_credentials_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_srp_set_server_credentials_function(gnutls_srp_server_credentials_t " cred ", gnutls_srp_server_credentials_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_srp_server_credentials_t cred" 12 +is a \fBgnutls_srp_server_credentials_t\fP type. +.IP "gnutls_srp_server_credentials_function * func" 12 +is the callback function +.SH "DESCRIPTION" +This function can be used to set a callback to retrieve the user's +SRP credentials. The callback's function form is: + +int (*callback)(gnutls_session_t, const char* username, +gnutls_datum_t *salt, gnutls_datum_t *verifier, gnutls_datum_t *generator, +gnutls_datum_t *prime); + + \fIusername\fP contains the actual username. +The \fIsalt\fP , \fIverifier\fP , \fIgenerator\fP and \fIprime\fP must be filled +in using the \fBgnutls_malloc()\fP. For convenience \fIprime\fP and \fIgenerator\fP may also be one of the static parameters defined in gnutls.h. + +Initially, the data field is NULL in every \fBgnutls_datum_t\fP +structure that the callback has to fill in. When the +callback is done GnuTLS deallocates all of those buffers +which are non\-NULL, regardless of the return value. + +In order to prevent attackers from guessing valid usernames, +if a user does not exist, g and n values should be filled in +using a random user's parameters. In that case the callback must +return the special value (1). +See \fBgnutls_srp_set_server_fake_salt_seed\fP too. +If this is not required for your application, return a negative +number from the callback to abort the handshake. + +The callback function will only be called once per handshake. +The callback function should return 0 on success, while +\-1 indicates an error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_set_server_fake_salt_seed.3 b/doc/manpages/gnutls_srp_set_server_fake_salt_seed.3 new file mode 100644 index 0000000..58346a9 --- /dev/null +++ b/doc/manpages/gnutls_srp_set_server_fake_salt_seed.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_set_server_fake_salt_seed" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_set_server_fake_salt_seed \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_srp_set_server_fake_salt_seed(gnutls_srp_server_credentials_t " cred ", const gnutls_datum_t * " seed ", unsigned int " salt_length ");" +.SH ARGUMENTS +.IP "gnutls_srp_server_credentials_t cred" 12 +is a \fBgnutls_srp_server_credentials_t\fP type +.IP "const gnutls_datum_t * seed" 12 +is the seed data, only needs to be valid until the function +returns; size of the seed must be greater than zero +.IP "unsigned int salt_length" 12 +is the length of the generated fake salts +.SH "DESCRIPTION" +This function sets the seed that is used to generate salts for +invalid (non\-existent) usernames. + +In order to prevent attackers from guessing valid usernames, +when a user does not exist gnutls generates a salt and a verifier +and proceeds with the protocol as usual. +The authentication will ultimately fail, but the client cannot tell +whether the username is valid (exists) or invalid. + +If an attacker learns the seed, given a salt (which is part of the +handshake) which was generated when the seed was in use, it can tell +whether or not the authentication failed because of an unknown username. +This seed cannot be used to reveal application data or passwords. + + \fIsalt_length\fP should represent the salt length your application uses. +Generating fake salts longer than 20 bytes is not supported. + +By default the seed is a random value, different each time a +\fBgnutls_srp_server_credentials_t\fP is allocated and fake salts are +16 bytes long. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srp_verifier.3 b/doc/manpages/gnutls_srp_verifier.3 new file mode 100644 index 0000000..c08ff8c --- /dev/null +++ b/doc/manpages/gnutls_srp_verifier.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_verifier" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srp_verifier \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srp_verifier(const char * " username ", const char * " password ", const gnutls_datum_t * " salt ", const gnutls_datum_t * " generator ", const gnutls_datum_t * " prime ", gnutls_datum_t * " res ");" +.SH ARGUMENTS +.IP "const char * username" 12 +is the user's name +.IP "const char * password" 12 +is the user's password +.IP "const gnutls_datum_t * salt" 12 +should be some randomly generated bytes +.IP "const gnutls_datum_t * generator" 12 +is the generator of the group +.IP "const gnutls_datum_t * prime" 12 +is the group's prime +.IP "gnutls_datum_t * res" 12 +where the verifier will be stored. +.SH "DESCRIPTION" +This function will create an SRP verifier, as specified in +RFC2945. The \fIprime\fP and \fIgenerator\fP should be one of the static +parameters defined in gnutls/gnutls.h or may be generated. + +The verifier will be allocated with @\fBgnutls_malloc()\fP and will be stored in + \fIres\fP using binary format. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srtp_get_keys.3 b/doc/manpages/gnutls_srtp_get_keys.3 new file mode 100644 index 0000000..a9baf01 --- /dev/null +++ b/doc/manpages/gnutls_srtp_get_keys.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srtp_get_keys" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srtp_get_keys \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srtp_get_keys(gnutls_session_t " session ", void * " key_material ", unsigned int " key_material_size ", gnutls_datum_t * " client_key ", gnutls_datum_t * " client_salt ", gnutls_datum_t * " server_key ", gnutls_datum_t * " server_salt ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "void * key_material" 12 +Space to hold the generated key material +.IP "unsigned int key_material_size" 12 +The maximum size of the key material +.IP "gnutls_datum_t * client_key" 12 +The master client write key, pointing inside the key material +.IP "gnutls_datum_t * client_salt" 12 +The master client write salt, pointing inside the key material +.IP "gnutls_datum_t * server_key" 12 +The master server write key, pointing inside the key material +.IP "gnutls_datum_t * server_salt" 12 +The master server write salt, pointing inside the key material +.SH "DESCRIPTION" +This is a helper function to generate the keying material for SRTP. +It requires the space of the key material to be pre\-allocated (should be at least +2x the maximum key size and salt size). The \fIclient_key\fP , \fIclient_salt\fP , \fIserver_key\fP and \fIserver_salt\fP are convenience datums that point inside the key material. They may +be \fBNULL\fP. +.SH "RETURNS" +On success the size of the key material is returned, +otherwise, \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not +sufficient, or a negative error code. + +Since 3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srtp_get_mki.3 b/doc/manpages/gnutls_srtp_get_mki.3 new file mode 100644 index 0000000..0c5b1c6 --- /dev/null +++ b/doc/manpages/gnutls_srtp_get_mki.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srtp_get_mki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srtp_get_mki \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srtp_get_mki(gnutls_session_t " session ", gnutls_datum_t * " mki ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_datum_t * mki" 12 +will hold the MKI +.SH "DESCRIPTION" +This function exports the negotiated Master Key Identifier, +received by the peer if any. The returned value in \fImki\fP should be +treated as constant and valid only during the session's lifetime. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. + +Since 3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srtp_get_profile_id.3 b/doc/manpages/gnutls_srtp_get_profile_id.3 new file mode 100644 index 0000000..d29f369 --- /dev/null +++ b/doc/manpages/gnutls_srtp_get_profile_id.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srtp_get_profile_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srtp_get_profile_id \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srtp_get_profile_id(const char * " name ", gnutls_srtp_profile_t * " profile ");" +.SH ARGUMENTS +.IP "const char * name" 12 +The name of the profile to look up +.IP "gnutls_srtp_profile_t * profile" 12 +Will hold the profile id +.SH "DESCRIPTION" +This function allows you to look up a profile based on a string. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. + +Since 3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srtp_get_profile_name.3 b/doc/manpages/gnutls_srtp_get_profile_name.3 new file mode 100644 index 0000000..eec6e54 --- /dev/null +++ b/doc/manpages/gnutls_srtp_get_profile_name.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srtp_get_profile_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srtp_get_profile_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_srtp_get_profile_name(gnutls_srtp_profile_t " profile ");" +.SH ARGUMENTS +.IP "gnutls_srtp_profile_t profile" 12 +The profile to look up a string for +.SH "DESCRIPTION" +This function allows you to get the corresponding name for a +SRTP protection profile. +.SH "RETURNS" +On success, the name of a SRTP profile as a string, +otherwise NULL. + +Since 3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srtp_get_selected_profile.3 b/doc/manpages/gnutls_srtp_get_selected_profile.3 new file mode 100644 index 0000000..ec7061f --- /dev/null +++ b/doc/manpages/gnutls_srtp_get_selected_profile.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srtp_get_selected_profile" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srtp_get_selected_profile \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srtp_get_selected_profile(gnutls_session_t " session ", gnutls_srtp_profile_t * " profile ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_srtp_profile_t * profile" 12 +will hold the profile +.SH "DESCRIPTION" +This function allows you to get the negotiated SRTP profile. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. + +Since 3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srtp_set_mki.3 b/doc/manpages/gnutls_srtp_set_mki.3 new file mode 100644 index 0000000..3a17994 --- /dev/null +++ b/doc/manpages/gnutls_srtp_set_mki.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srtp_set_mki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srtp_set_mki \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srtp_set_mki(gnutls_session_t " session ", const gnutls_datum_t * " mki ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const gnutls_datum_t * mki" 12 +holds the MKI +.SH "DESCRIPTION" +This function sets the Master Key Identifier, to be +used by this session (if any). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. + +Since 3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srtp_set_profile.3 b/doc/manpages/gnutls_srtp_set_profile.3 new file mode 100644 index 0000000..be013a4 --- /dev/null +++ b/doc/manpages/gnutls_srtp_set_profile.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srtp_set_profile" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srtp_set_profile \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srtp_set_profile(gnutls_session_t " session ", gnutls_srtp_profile_t " profile ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_srtp_profile_t profile" 12 +is the profile id to add. +.SH "DESCRIPTION" +This function is to be used by both clients and servers, to declare +what SRTP profiles they support, to negotiate with the peer. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. + +Since 3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_srtp_set_profile_direct.3 b/doc/manpages/gnutls_srtp_set_profile_direct.3 new file mode 100644 index 0000000..000214c --- /dev/null +++ b/doc/manpages/gnutls_srtp_set_profile_direct.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srtp_set_profile_direct" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_srtp_set_profile_direct \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_srtp_set_profile_direct(gnutls_session_t " session ", const char * " profiles ", const char ** " err_pos ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "const char * profiles" 12 +is a string that contains the supported SRTP profiles, +separated by colons. +.IP "const char ** err_pos" 12 +In case of an error this will have the position in the string the error occurred, may be NULL. +.SH "DESCRIPTION" +This function is to be used by both clients and servers, to declare +what SRTP profiles they support, to negotiate with the peer. +.SH "RETURNS" +On syntax error \fBGNUTLS_E_INVALID_REQUEST\fP is returned, +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. + +Since 3.1.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_store_commitment.3 b/doc/manpages/gnutls_store_commitment.3 new file mode 100644 index 0000000..d00864e --- /dev/null +++ b/doc/manpages/gnutls_store_commitment.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_store_commitment" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_store_commitment \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_store_commitment(const char * " db_name ", gnutls_tdb_t " tdb ", const char * " host ", const char * " service ", gnutls_digest_algorithm_t " hash_algo ", const gnutls_datum_t * " hash ", time_t " expiration ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * db_name" 12 +A file specifying the stored keys (use NULL for the default) +.IP "gnutls_tdb_t tdb" 12 +A storage structure or NULL to use the default +.IP "const char * host" 12 +The peer's name +.IP "const char * service" 12 +non\-NULL if this key is specific to a service (e.g. http) +.IP "gnutls_digest_algorithm_t hash_algo" 12 +The hash algorithm type +.IP "const gnutls_datum_t * hash" 12 +The raw hash +.IP "time_t expiration" 12 +The expiration time (use 0 to disable expiration) +.IP "unsigned int flags" 12 +should be 0 or \fBGNUTLS_SCOMMIT_FLAG_ALLOW_BROKEN\fP. +.SH "DESCRIPTION" +This function will store the provided hash commitment to +the list of stored public keys. The key with the given +hash will be considered valid until the provided expiration time. + +The \fItdb\fP variable if non\-null specifies a custom backend for +the storage of entries. If it is NULL then the +default file backend will be used. + +Note that this function is not thread safe with the default backend. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_store_pubkey.3 b/doc/manpages/gnutls_store_pubkey.3 new file mode 100644 index 0000000..fff39cb --- /dev/null +++ b/doc/manpages/gnutls_store_pubkey.3 @@ -0,0 +1,67 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_store_pubkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_store_pubkey \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_store_pubkey(const char * " db_name ", gnutls_tdb_t " tdb ", const char * " host ", const char * " service ", gnutls_certificate_type_t " cert_type ", const gnutls_datum_t * " cert ", time_t " expiration ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * db_name" 12 +A file specifying the stored keys (use NULL for the default) +.IP "gnutls_tdb_t tdb" 12 +A storage structure or NULL to use the default +.IP "const char * host" 12 +The peer's name +.IP "const char * service" 12 +non\-NULL if this key is specific to a service (e.g. http) +.IP "gnutls_certificate_type_t cert_type" 12 +The type of the certificate +.IP "const gnutls_datum_t * cert" 12 +The data of the certificate +.IP "time_t expiration" 12 +The expiration time (use 0 to disable expiration) +.IP "unsigned int flags" 12 +should be 0. +.SH "DESCRIPTION" +This function will store a raw public\-key or a public\-key provided via +a raw (DER\-encoded) certificate to the list of stored public keys. The key +will be considered valid until the provided expiration time. + +The \fItdb\fP variable if non\-null specifies a custom backend for +the storage of entries. If it is NULL then the +default file backend will be used. + +Unless an alternative \fItdb\fP is provided, the storage format is a textual format +consisting of a line for each host with fields separated by '|'. The contents of +the fields are a format\-identifier which is set to 'g0', the hostname that the +rest of the data applies to, the numeric port or host name, the expiration +time in seconds since the epoch (0 for no expiration), and a base64 +encoding of the raw (DER) public key information (SPKI) of the peer. + +As of GnuTLS 3.6.6 this function also accepts raw public keys. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0.13 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_strerror.3 b/doc/manpages/gnutls_strerror.3 new file mode 100644 index 0000000..b462c1f --- /dev/null +++ b/doc/manpages/gnutls_strerror.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_strerror" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_strerror \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_strerror(int " error ");" +.SH ARGUMENTS +.IP "int error" 12 +is a GnuTLS error code, a negative error code +.SH "DESCRIPTION" +This function is similar to strerror. The difference is that it +accepts an error number returned by a gnutls function; In case of +an unknown error a descriptive string is sent instead of \fBNULL\fP. + +Error codes are always a negative error code. +.SH "RETURNS" +A string explaining the GnuTLS error message. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_strerror_name.3 b/doc/manpages/gnutls_strerror_name.3 new file mode 100644 index 0000000..32f54de --- /dev/null +++ b/doc/manpages/gnutls_strerror_name.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_strerror_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_strerror_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_strerror_name(int " error ");" +.SH ARGUMENTS +.IP "int error" 12 +is an error returned by a gnutls function. +.SH "DESCRIPTION" +Return the GnuTLS error code define as a string. For example, +gnutls_strerror_name (GNUTLS_E_DH_PRIME_UNACCEPTABLE) will return +the string "GNUTLS_E_DH_PRIME_UNACCEPTABLE". +.SH "RETURNS" +A string corresponding to the symbol name of the error +code. +.SH "SINCE" +2.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_subject_alt_names_deinit.3 b/doc/manpages/gnutls_subject_alt_names_deinit.3 new file mode 100644 index 0000000..38b6095 --- /dev/null +++ b/doc/manpages/gnutls_subject_alt_names_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_subject_alt_names_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_subject_alt_names_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "void gnutls_subject_alt_names_deinit(gnutls_subject_alt_names_t " sans ");" +.SH ARGUMENTS +.IP "gnutls_subject_alt_names_t sans" 12 +The alternative names +.SH "DESCRIPTION" +This function will deinitialize an alternative names structure. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_subject_alt_names_get.3 b/doc/manpages/gnutls_subject_alt_names_get.3 new file mode 100644 index 0000000..ab7f38a --- /dev/null +++ b/doc/manpages/gnutls_subject_alt_names_get.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_subject_alt_names_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_subject_alt_names_get \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_subject_alt_names_get(gnutls_subject_alt_names_t " sans ", unsigned int " seq ", unsigned int * " san_type ", gnutls_datum_t * " san ", gnutls_datum_t * " othername_oid ");" +.SH ARGUMENTS +.IP "gnutls_subject_alt_names_t sans" 12 +The alternative names +.IP "unsigned int seq" 12 +The index of the name to get +.IP "unsigned int * san_type" 12 +Will hold the type of the name (of \fBgnutls_subject_alt_names_t\fP) +.IP "gnutls_datum_t * san" 12 +The alternative name data (should be treated as constant) +.IP "gnutls_datum_t * othername_oid" 12 +The object identifier if \fIsan_type\fP is \fBGNUTLS_SAN_OTHERNAME\fP (should be treated as constant) +.SH "DESCRIPTION" +This function will return a specific alternative name as stored in +the \fIsans\fP type. The returned values should be treated as constant +and valid for the lifetime of \fIsans\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the index is out of bounds, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_subject_alt_names_init.3 b/doc/manpages/gnutls_subject_alt_names_init.3 new file mode 100644 index 0000000..bd0e4b5 --- /dev/null +++ b/doc/manpages/gnutls_subject_alt_names_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_subject_alt_names_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_subject_alt_names_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_subject_alt_names_init(gnutls_subject_alt_names_t * " sans ");" +.SH ARGUMENTS +.IP "gnutls_subject_alt_names_t * sans" 12 +The alternative names +.SH "DESCRIPTION" +This function will initialize an alternative names structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_subject_alt_names_set.3 b/doc/manpages/gnutls_subject_alt_names_set.3 new file mode 100644 index 0000000..713f4bc --- /dev/null +++ b/doc/manpages/gnutls_subject_alt_names_set.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_subject_alt_names_set" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_subject_alt_names_set \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_subject_alt_names_set(gnutls_subject_alt_names_t " sans ", unsigned int " san_type ", const gnutls_datum_t * " san ", const char * " othername_oid ");" +.SH ARGUMENTS +.IP "gnutls_subject_alt_names_t sans" 12 +The alternative names +.IP "unsigned int san_type" 12 +The type of the name (of \fBgnutls_subject_alt_names_t\fP) +.IP "const gnutls_datum_t * san" 12 +The alternative name data +.IP "const char * othername_oid" 12 +The object identifier if \fIsan_type\fP is \fBGNUTLS_SAN_OTHERNAME\fP +.SH "DESCRIPTION" +This function will store the specified alternative name in +the \fIsans\fP . + +Since version 3.5.7 the \fBGNUTLS_SAN_RFC822NAME\fP, \fBGNUTLS_SAN_DNSNAME\fP, and +\fBGNUTLS_SAN_OTHERNAME_XMPP\fP are converted to ACE format when necessary. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0), otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_supplemental_get_name.3 b/doc/manpages/gnutls_supplemental_get_name.3 new file mode 100644 index 0000000..1d02348 --- /dev/null +++ b/doc/manpages/gnutls_supplemental_get_name.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_supplemental_get_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_supplemental_get_name \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "const char * gnutls_supplemental_get_name(gnutls_supplemental_data_format_type_t " type ");" +.SH ARGUMENTS +.IP "gnutls_supplemental_data_format_type_t type" 12 +is a supplemental data format type +.SH "DESCRIPTION" +Convert a \fBgnutls_supplemental_data_format_type_t\fP value to a +string. +.SH "RETURNS" +a string that contains the name of the specified +supplemental data format type, or \fBNULL\fP for unknown types. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_supplemental_recv.3 b/doc/manpages/gnutls_supplemental_recv.3 new file mode 100644 index 0000000..0f37986 --- /dev/null +++ b/doc/manpages/gnutls_supplemental_recv.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_supplemental_recv" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_supplemental_recv \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_supplemental_recv(gnutls_session_t " session ", unsigned " do_recv_supplemental ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned do_recv_supplemental" 12 +non\-zero in order to expect supplemental data +.SH "DESCRIPTION" +This function is to be called by an extension handler to +instruct gnutls to attempt to receive supplemental data +during the handshake process. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_supplemental_register.3 b/doc/manpages/gnutls_supplemental_register.3 new file mode 100644 index 0000000..727143a --- /dev/null +++ b/doc/manpages/gnutls_supplemental_register.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_supplemental_register" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_supplemental_register \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_supplemental_register(const char * " name ", gnutls_supplemental_data_format_type_t " type ", gnutls_supp_recv_func " recv_func ", gnutls_supp_send_func " send_func ");" +.SH ARGUMENTS +.IP "const char * name" 12 +the name of the supplemental data to register +.IP "gnutls_supplemental_data_format_type_t type" 12 +the type of the supplemental data format +.IP "gnutls_supp_recv_func recv_func" 12 +the function to receive the data +.IP "gnutls_supp_send_func send_func" 12 +the function to send the data +.SH "DESCRIPTION" +This function will register a new supplemental data type (rfc4680). +The registered data will remain until \fBgnutls_global_deinit()\fP +is called. The provided \fItype\fP must be an unassigned type in +\fBgnutls_supplemental_data_format_type_t\fP. If the type is already +registered or handled by GnuTLS internally \fBGNUTLS_E_ALREADY_REGISTERED\fP +will be returned. + +This function is not thread safe. As supplemental data are not defined under +TLS 1.3, this function will disable TLS 1.3 support globally. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_supplemental_send.3 b/doc/manpages/gnutls_supplemental_send.3 new file mode 100644 index 0000000..e51ef68 --- /dev/null +++ b/doc/manpages/gnutls_supplemental_send.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_supplemental_send" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_supplemental_send \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_supplemental_send(gnutls_session_t " session ", unsigned " do_send_supplemental ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "unsigned do_send_supplemental" 12 +non\-zero in order to send supplemental data +.SH "DESCRIPTION" +This function is to be called by an extension handler to +instruct gnutls to send supplemental data during the handshake process. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_system_key_add_x509.3 b/doc/manpages/gnutls_system_key_add_x509.3 new file mode 100644 index 0000000..27f34e8 --- /dev/null +++ b/doc/manpages/gnutls_system_key_add_x509.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_system_key_add_x509" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_system_key_add_x509 \- API function +.SH SYNOPSIS +.B #include <gnutls/system-keys.h> +.sp +.BI "int gnutls_system_key_add_x509(gnutls_x509_crt_t " crt ", gnutls_x509_privkey_t " privkey ", const char * " label ", char ** " cert_url ", char ** " key_url ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +the certificate to be added +.IP "gnutls_x509_privkey_t privkey" 12 +the key to be added +.IP "const char * label" 12 +the friendly name to describe the key +.IP "char ** cert_url" 12 +if non\-NULL it will contain an allocated value with the certificate URL +.IP "char ** key_url" 12 +if non\-NULL it will contain an allocated value with the key URL +.SH "DESCRIPTION" +This function will added the given key and certificate pair, +to the system list. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_system_key_delete.3 b/doc/manpages/gnutls_system_key_delete.3 new file mode 100644 index 0000000..6b4a16f --- /dev/null +++ b/doc/manpages/gnutls_system_key_delete.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_system_key_delete" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_system_key_delete \- API function +.SH SYNOPSIS +.B #include <gnutls/system-keys.h> +.sp +.BI "int gnutls_system_key_delete(const char * " cert_url ", const char * " key_url ");" +.SH ARGUMENTS +.IP "const char * cert_url" 12 +the URL of the certificate +.IP "const char * key_url" 12 +the URL of the key +.SH "DESCRIPTION" +This function will delete the key and certificate pair. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_system_key_iter_deinit.3 b/doc/manpages/gnutls_system_key_iter_deinit.3 new file mode 100644 index 0000000..5a1c16f --- /dev/null +++ b/doc/manpages/gnutls_system_key_iter_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_system_key_iter_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_system_key_iter_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/system-keys.h> +.sp +.BI "void gnutls_system_key_iter_deinit(gnutls_system_key_iter_t " iter ");" +.SH ARGUMENTS +.IP "gnutls_system_key_iter_t iter" 12 +an iterator of system keys +.SH "DESCRIPTION" +This function will deinitialize the iterator. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_system_key_iter_get_info.3 b/doc/manpages/gnutls_system_key_iter_get_info.3 new file mode 100644 index 0000000..8f9350d --- /dev/null +++ b/doc/manpages/gnutls_system_key_iter_get_info.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_system_key_iter_get_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_system_key_iter_get_info \- API function +.SH SYNOPSIS +.B #include <gnutls/system-keys.h> +.sp +.BI "int gnutls_system_key_iter_get_info(gnutls_system_key_iter_t * " iter ", unsigned " cert_type ", char ** " cert_url ", char ** " key_url ", char ** " label ", gnutls_datum_t * " der ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_system_key_iter_t * iter" 12 +an iterator of the system keys (must be set to \fBNULL\fP initially) +.IP "unsigned cert_type" 12 +A value of gnutls_certificate_type_t which indicates the type of certificate to look for +.IP "char ** cert_url" 12 +The certificate URL of the pair (may be \fBNULL\fP) +.IP "char ** key_url" 12 +The key URL of the pair (may be \fBNULL\fP) +.IP "char ** label" 12 +The friendly name (if any) of the pair (may be \fBNULL\fP) +.IP "gnutls_datum_t * der" 12 +if non\-NULL the DER data of the certificate +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will return on each call a certificate +and key pair URLs, as well as a label associated with them, +and the DER\-encoded certificate. When the iteration is complete it will +return \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP. + +Typically \fIcert_type\fP should be \fBGNUTLS_CRT_X509\fP. + +All values set are allocated and must be cleared using \fBgnutls_free()\fP, +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_system_recv_timeout.3 b/doc/manpages/gnutls_system_recv_timeout.3 new file mode 100644 index 0000000..643b3ac --- /dev/null +++ b/doc/manpages/gnutls_system_recv_timeout.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_system_recv_timeout" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_system_recv_timeout \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_system_recv_timeout(gnutls_transport_ptr_t " ptr ", unsigned int " ms ");" +.SH ARGUMENTS +.IP "gnutls_transport_ptr_t ptr" 12 +A file descriptor (wrapped in a gnutls_transport_ptr_t pointer) +.IP "unsigned int ms" 12 +The number of milliseconds to wait. +.SH "DESCRIPTION" +Wait for data to be received from the provided socket ( \fIptr\fP ) within a +timeout period in milliseconds, using \fBselect()\fP on the provided \fIptr\fP . + +This function is provided as a helper for constructing custom +callbacks for \fBgnutls_transport_set_pull_timeout_function()\fP, +which can be used if you rely on socket file descriptors. + +Returns \-1 on error, 0 on timeout, positive value if data are available for reading. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tdb_deinit.3 b/doc/manpages/gnutls_tdb_deinit.3 new file mode 100644 index 0000000..c62a8d5 --- /dev/null +++ b/doc/manpages/gnutls_tdb_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tdb_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tdb_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_tdb_deinit(gnutls_tdb_t " tdb ");" +.SH ARGUMENTS +.IP "gnutls_tdb_t tdb" 12 +The structure to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a public key trust storage structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tdb_init.3 b/doc/manpages/gnutls_tdb_init.3 new file mode 100644 index 0000000..cc25a1a --- /dev/null +++ b/doc/manpages/gnutls_tdb_init.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tdb_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tdb_init \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_tdb_init(gnutls_tdb_t * " tdb ");" +.SH ARGUMENTS +.IP "gnutls_tdb_t * tdb" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a public key trust storage structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tdb_set_store_commitment_func.3 b/doc/manpages/gnutls_tdb_set_store_commitment_func.3 new file mode 100644 index 0000000..575e5fc --- /dev/null +++ b/doc/manpages/gnutls_tdb_set_store_commitment_func.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tdb_set_store_commitment_func" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tdb_set_store_commitment_func \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_tdb_set_store_commitment_func(gnutls_tdb_t " tdb ", gnutls_tdb_store_commitment_func " cstore ");" +.SH ARGUMENTS +.IP "gnutls_tdb_t tdb" 12 +The trust storage +.IP "gnutls_tdb_store_commitment_func cstore" 12 +The commitment storage function +.SH "DESCRIPTION" +This function will associate a commitment (hash) storage function with the +trust storage structure. The function is of the following form. + +int gnutls_tdb_store_commitment_func(const char* db_name, const char* host, +const char* service, time_t expiration, +gnutls_digest_algorithm_t, const gnutls_datum_t* hash); + +The \fIdb_name\fP should be used to pass any private data to this function. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tdb_set_store_func.3 b/doc/manpages/gnutls_tdb_set_store_func.3 new file mode 100644 index 0000000..2f0fb36 --- /dev/null +++ b/doc/manpages/gnutls_tdb_set_store_func.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tdb_set_store_func" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tdb_set_store_func \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_tdb_set_store_func(gnutls_tdb_t " tdb ", gnutls_tdb_store_func " store ");" +.SH ARGUMENTS +.IP "gnutls_tdb_t tdb" 12 +The trust storage +.IP "gnutls_tdb_store_func store" 12 +The storage function +.SH "DESCRIPTION" +This function will associate a storage function with the +trust storage structure. The function is of the following form. + +int gnutls_tdb_store_func(const char* db_name, const char* host, +const char* service, time_t expiration, +const gnutls_datum_t* pubkey); + +The \fIdb_name\fP should be used to pass any private data to this function. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tdb_set_verify_func.3 b/doc/manpages/gnutls_tdb_set_verify_func.3 new file mode 100644 index 0000000..5f90617 --- /dev/null +++ b/doc/manpages/gnutls_tdb_set_verify_func.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tdb_set_verify_func" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tdb_set_verify_func \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_tdb_set_verify_func(gnutls_tdb_t " tdb ", gnutls_tdb_verify_func " verify ");" +.SH ARGUMENTS +.IP "gnutls_tdb_t tdb" 12 +The trust storage +.IP "gnutls_tdb_verify_func verify" 12 +The verification function +.SH "DESCRIPTION" +This function will associate a retrieval function with the +trust storage structure. The function is of the following form. + +int gnutls_tdb_verify_func(const char* db_name, const char* host, +const char* service, const gnutls_datum_t* pubkey); + +The verify function should return zero on a match, \fBGNUTLS_E_CERTIFICATE_KEY_MISMATCH\fP +if there is a mismatch and any other negative error code otherwise. + +The \fIdb_name\fP should be used to pass any private data to this function. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tpm_get_registered.3 b/doc/manpages/gnutls_tpm_get_registered.3 new file mode 100644 index 0000000..8587bd6 --- /dev/null +++ b/doc/manpages/gnutls_tpm_get_registered.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tpm_get_registered" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tpm_get_registered \- API function +.SH SYNOPSIS +.B #include <gnutls/tpm.h> +.sp +.BI "int gnutls_tpm_get_registered(gnutls_tpm_key_list_t * " list ");" +.SH ARGUMENTS +.IP "gnutls_tpm_key_list_t * list" 12 +a list to store the keys +.SH "DESCRIPTION" +This function will get a list of stored keys in the TPM. The uuid +of those keys +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tpm_key_list_deinit.3 b/doc/manpages/gnutls_tpm_key_list_deinit.3 new file mode 100644 index 0000000..1001c8d --- /dev/null +++ b/doc/manpages/gnutls_tpm_key_list_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tpm_key_list_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tpm_key_list_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/tpm.h> +.sp +.BI "void gnutls_tpm_key_list_deinit(gnutls_tpm_key_list_t " list ");" +.SH ARGUMENTS +.IP "gnutls_tpm_key_list_t list" 12 +a list of the keys +.SH "DESCRIPTION" +This function will deinitialize the list of stored keys in the TPM. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tpm_key_list_get_url.3 b/doc/manpages/gnutls_tpm_key_list_get_url.3 new file mode 100644 index 0000000..7a84048 --- /dev/null +++ b/doc/manpages/gnutls_tpm_key_list_get_url.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tpm_key_list_get_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tpm_key_list_get_url \- API function +.SH SYNOPSIS +.B #include <gnutls/tpm.h> +.sp +.BI "int gnutls_tpm_key_list_get_url(gnutls_tpm_key_list_t " list ", unsigned int " idx ", char ** " url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_tpm_key_list_t list" 12 +a list of the keys +.IP "unsigned int idx" 12 +The index of the key (starting from zero) +.IP "char ** url" 12 +The URL to be returned +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will return for each given index a URL of +the corresponding key. +If the provided index is out of bounds then \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tpm_privkey_delete.3 b/doc/manpages/gnutls_tpm_privkey_delete.3 new file mode 100644 index 0000000..ea9ab38 --- /dev/null +++ b/doc/manpages/gnutls_tpm_privkey_delete.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tpm_privkey_delete" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tpm_privkey_delete \- API function +.SH SYNOPSIS +.B #include <gnutls/tpm.h> +.sp +.BI "int gnutls_tpm_privkey_delete(const char * " url ", const char * " srk_password ");" +.SH ARGUMENTS +.IP "const char * url" 12 +the URL describing the key +.IP "const char * srk_password" 12 +a password for the SRK key +.SH "DESCRIPTION" +This function will unregister the private key from the TPM +chip. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_tpm_privkey_generate.3 b/doc/manpages/gnutls_tpm_privkey_generate.3 new file mode 100644 index 0000000..ab639be --- /dev/null +++ b/doc/manpages/gnutls_tpm_privkey_generate.3 @@ -0,0 +1,64 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_tpm_privkey_generate" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_tpm_privkey_generate \- API function +.SH SYNOPSIS +.B #include <gnutls/tpm.h> +.sp +.BI "int gnutls_tpm_privkey_generate(gnutls_pk_algorithm_t " pk ", unsigned int " bits ", const char * " srk_password ", const char * " key_password ", gnutls_tpmkey_fmt_t " format ", gnutls_x509_crt_fmt_t " pub_format ", gnutls_datum_t * " privkey ", gnutls_datum_t * " pubkey ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pk_algorithm_t pk" 12 +the public key algorithm +.IP "unsigned int bits" 12 +the security bits +.IP "const char * srk_password" 12 +a password to protect the exported key (optional) +.IP "const char * key_password" 12 +the password for the TPM (optional) +.IP "gnutls_tpmkey_fmt_t format" 12 +the format of the private key +.IP "gnutls_x509_crt_fmt_t pub_format" 12 +the format of the public key +.IP "gnutls_datum_t * privkey" 12 +the generated key +.IP "gnutls_datum_t * pubkey" 12 +the corresponding public key (may be null) +.IP "unsigned int flags" 12 +should be a list of GNUTLS_TPM_* flags +.SH "DESCRIPTION" +This function will generate a private key in the TPM +chip. The private key will be generated within the chip +and will be exported in a wrapped with TPM's master key +form. Furthermore the wrapped key can be protected with +the provided \fIpassword\fP . + +Note that bits in TPM is quantized value. If the input value +is not one of the allowed values, then it will be quantized to +one of 512, 1024, 2048, 4096, 8192 and 16384. + +Allowed flags are: +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_get_int.3 b/doc/manpages/gnutls_transport_get_int.3 new file mode 100644 index 0000000..14109d2 --- /dev/null +++ b/doc/manpages/gnutls_transport_get_int.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_get_int" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_get_int \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_transport_get_int(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Used to get the first argument of the transport function (like +PUSH and PULL). This must have been set using +\fBgnutls_transport_set_int()\fP. +.SH "RETURNS" +The first argument of the transport function. +.SH "SINCE" +3.1.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_get_int2.3 b/doc/manpages/gnutls_transport_get_int2.3 new file mode 100644 index 0000000..5f09d5e --- /dev/null +++ b/doc/manpages/gnutls_transport_get_int2.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_get_int2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_get_int2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_get_int2(gnutls_session_t " session ", int * " recv_int ", int * " send_int ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "int * recv_int" 12 +will hold the value for the pull function +.IP "int * send_int" 12 +will hold the value for the push function +.SH "DESCRIPTION" +Used to get the arguments of the transport functions (like PUSH +and PULL). These should have been set using +\fBgnutls_transport_set_int2()\fP. +.SH "SINCE" +3.1.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_get_ptr.3 b/doc/manpages/gnutls_transport_get_ptr.3 new file mode 100644 index 0000000..13076b7 --- /dev/null +++ b/doc/manpages/gnutls_transport_get_ptr.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_get_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_get_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "gnutls_transport_ptr_t gnutls_transport_get_ptr(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Used to get the first argument of the transport function (like +PUSH and PULL). This must have been set using +\fBgnutls_transport_set_ptr()\fP. +.SH "RETURNS" +The first argument of the transport function. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_get_ptr2.3 b/doc/manpages/gnutls_transport_get_ptr2.3 new file mode 100644 index 0000000..9c16091 --- /dev/null +++ b/doc/manpages/gnutls_transport_get_ptr2.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_get_ptr2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_get_ptr2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_get_ptr2(gnutls_session_t " session ", gnutls_transport_ptr_t * " recv_ptr ", gnutls_transport_ptr_t * " send_ptr ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_transport_ptr_t * recv_ptr" 12 +will hold the value for the pull function +.IP "gnutls_transport_ptr_t * send_ptr" 12 +will hold the value for the push function +.SH "DESCRIPTION" +Used to get the arguments of the transport functions (like PUSH +and PULL). These should have been set using +\fBgnutls_transport_set_ptr2()\fP. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_is_ktls_enabled.3 b/doc/manpages/gnutls_transport_is_ktls_enabled.3 new file mode 100644 index 0000000..83dbbd1 --- /dev/null +++ b/doc/manpages/gnutls_transport_is_ktls_enabled.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_is_ktls_enabled" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_is_ktls_enabled \- API function +.SH SYNOPSIS +.B #include <gnutls/socket.h> +.sp +.BI "gnutls_transport_ktls_enable_flags_t gnutls_transport_is_ktls_enabled(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.SH "DESCRIPTION" +Checks if KTLS is now enabled and was properly inicialized. +.SH "RETURNS" +\fBGNUTLS_KTLS_RECV\fP, \fBGNUTLS_KTLS_SEND\fP, \fBGNUTLS_KTLS_DUPLEX\fP, otherwise 0 +.SH "SINCE" +3.7.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_errno.3 b/doc/manpages/gnutls_transport_set_errno.3 new file mode 100644 index 0000000..f2dcaa2 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_errno.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_errno" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_errno \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_errno(gnutls_session_t " session ", int " err ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "int err" 12 +error value to store in session\-specific errno variable. +.SH "DESCRIPTION" +Store \fIerr\fP in the session\-specific errno variable. Useful values +for \fIerr\fP are EINTR, EAGAIN and EMSGSIZE, other values are treated will be +treated as real errors in the push/pull function. + +This function is useful in replacement push and pull functions set by +\fBgnutls_transport_set_push_function()\fP and +\fBgnutls_transport_set_pull_function()\fP under Windows, where the +replacements may not have access to the same \fIerrno\fP variable that is used by GnuTLS (e.g., the application is linked to +msvcr71.dll and gnutls is linked to msvcrt.dll). + +This function is unreliable if you are using the same + \fIsession\fP in different threads for sending and receiving. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_errno_function.3 b/doc/manpages/gnutls_transport_set_errno_function.3 new file mode 100644 index 0000000..cea84a8 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_errno_function.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_errno_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_errno_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_errno_function(gnutls_session_t " session ", gnutls_errno_func " errno_func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_errno_func errno_func" 12 +a callback function similar to \fBwrite()\fP +.SH "DESCRIPTION" +This is the function where you set a function to retrieve errno +after a failed push or pull operation. + + \fIerrno_func\fP is of the form, +int (*gnutls_errno_func)(gnutls_transport_ptr_t); +and should return the errno. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_fastopen.3 b/doc/manpages/gnutls_transport_set_fastopen.3 new file mode 100644 index 0000000..fd3f246 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_fastopen.3 @@ -0,0 +1,63 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_fastopen" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_fastopen \- API function +.SH SYNOPSIS +.B #include <gnutls/socket.h> +.sp +.BI "void gnutls_transport_set_fastopen(gnutls_session_t " session ", int " fd ", struct sockaddr * " connect_addr ", socklen_t " connect_addrlen ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "int fd" 12 +is the session's socket descriptor +.IP "struct sockaddr * connect_addr" 12 +is the address we want to connect to +.IP "socklen_t connect_addrlen" 12 +is the length of \fIconnect_addr\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +Enables TCP Fast Open (TFO) for the specified TLS client session. +That means that TCP connection establishment and the transmission +of the first TLS client hello packet are combined. The +peer's address must be specified in \fIconnect_addr\fP and \fIconnect_addrlen\fP , +and the socket specified by \fIfd\fP should not be connected. + +TFO only works for TCP sockets of type AF_INET and AF_INET6. +If the OS doesn't support TCP fast open this function will result +to gnutls using \fBconnect()\fP transparently during the first write. +.SH "NOTE" +This function overrides all the transport callback functions. +If this is undesirable, TCP Fast Open must be implemented on the user +callback functions without calling this function. When using +this function, transport callbacks must not be set, and +\fBgnutls_transport_set_ptr()\fP or \fBgnutls_transport_set_int()\fP +must not be called. + +On GNU/Linux TFO has to be enabled at the system layer, that is +in /proc/sys/net/ipv4/tcp_fastopen, bit 0 has to be set. + +This function has no effect on server sessions. +.SH "SINCE" +3.5.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_int.3 b/doc/manpages/gnutls_transport_set_int.3 new file mode 100644 index 0000000..9d6797a --- /dev/null +++ b/doc/manpages/gnutls_transport_set_int.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_int" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_int \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_int(gnutls_session_t " session ", int " fd ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "int fd" 12 +is the socket descriptor for the connection. +.SH "DESCRIPTION" +This function sets the first argument of the transport function, such +as \fBsend()\fP and \fBrecv()\fP for the default callbacks using the +system's socket API. + +This function is equivalent to calling \fBgnutls_transport_set_ptr()\fP +with the descriptor, but requires no casts. +.SH "SINCE" +3.1.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_int2.3 b/doc/manpages/gnutls_transport_set_int2.3 new file mode 100644 index 0000000..bb3118d --- /dev/null +++ b/doc/manpages/gnutls_transport_set_int2.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_int2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_int2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_int2(gnutls_session_t " session ", int " recv_fd ", int " send_fd ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "int recv_fd" 12 +is socket descriptor for the pull function +.IP "int send_fd" 12 +is socket descriptor for the push function +.SH "DESCRIPTION" +This function sets the first argument of the transport functions, +such as \fBsend()\fP and \fBrecv()\fP for the default callbacks using the +system's socket API. With this function you can set two different +descriptors for receiving and sending. + +This function is equivalent to calling \fBgnutls_transport_set_ptr2()\fP +with the descriptors, but requires no casts. +.SH "SINCE" +3.1.9 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_ptr.3 b/doc/manpages/gnutls_transport_set_ptr.3 new file mode 100644 index 0000000..d64be22 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_ptr.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_ptr(gnutls_session_t " session ", gnutls_transport_ptr_t " ptr ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_transport_ptr_t ptr" 12 +is the value. +.SH "DESCRIPTION" +Used to set the first argument of the transport function (for push +and pull callbacks). In berkeley style sockets this function will set the +connection descriptor. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_ptr2.3 b/doc/manpages/gnutls_transport_set_ptr2.3 new file mode 100644 index 0000000..e0bfa11 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_ptr2.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_ptr2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_ptr2 \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_ptr2(gnutls_session_t " session ", gnutls_transport_ptr_t " recv_ptr ", gnutls_transport_ptr_t " send_ptr ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_transport_ptr_t recv_ptr" 12 +is the value for the pull function +.IP "gnutls_transport_ptr_t send_ptr" 12 +is the value for the push function +.SH "DESCRIPTION" +Used to set the first argument of the transport function (for push +and pull callbacks). In berkeley style sockets this function will set the +connection descriptor. With this function you can use two different +pointers for receiving and sending. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_pull_function.3 b/doc/manpages/gnutls_transport_set_pull_function.3 new file mode 100644 index 0000000..99a00f1 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_pull_function.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_pull_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_pull_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_pull_function(gnutls_session_t " session ", gnutls_pull_func " pull_func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_pull_func pull_func" 12 +a callback function similar to \fBread()\fP +.SH "DESCRIPTION" +This is the function where you set a function for gnutls to receive +data. Normally, if you use berkeley style sockets, do not need to +use this function since the default recv(2) will probably be ok. +The callback should return 0 on connection termination, a positive +number indicating the number of bytes received, and \-1 on error. + + \fIgnutls_pull_func\fP is of the form, +ssize_t (*gnutls_pull_func)(gnutls_transport_ptr_t, void*, size_t); +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_pull_timeout_function.3 b/doc/manpages/gnutls_transport_set_pull_timeout_function.3 new file mode 100644 index 0000000..0a5c156 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_pull_timeout_function.3 @@ -0,0 +1,62 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_pull_timeout_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_pull_timeout_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_pull_timeout_function(gnutls_session_t " session ", gnutls_pull_timeout_func " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_pull_timeout_func func" 12 +a callback function +.SH "DESCRIPTION" +This is the function where you set a function for gnutls to know +whether data are ready to be received. It should wait for data a +given time frame in milliseconds. The callback should return 0 on +timeout, a positive number if data can be received, and \-1 on error. +You'll need to override this function if \fBselect()\fP is not suitable +for the provided transport calls. + +As with \fBselect()\fP, if the timeout value is zero the callback should return +zero if no data are immediately available. The special value +\fBGNUTLS_INDEFINITE_TIMEOUT\fP indicates that the callback should wait indefinitely +for data. + + \fIgnutls_pull_timeout_func\fP is of the form, +int (*gnutls_pull_timeout_func)(gnutls_transport_ptr_t, unsigned int ms); + +This callback is necessary when \fBgnutls_handshake_set_timeout()\fP or +\fBgnutls_record_set_timeout()\fP are set, under TLS1.3 and for enforcing the DTLS +mode timeouts when in blocking mode. + +For compatibility with future GnuTLS versions this callback must be set when +a custom pull function is registered. The callback will not be used when the +session is in TLS mode with non\-blocking sockets. That is, when \fBGNUTLS_NONBLOCK\fP +is specified for a TLS session in \fBgnutls_init()\fP. + +The helper function \fBgnutls_system_recv_timeout()\fP is provided to +simplify writing callbacks. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_push_function.3 b/doc/manpages/gnutls_transport_set_push_function.3 new file mode 100644 index 0000000..d53f469 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_push_function.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_push_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_push_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_push_function(gnutls_session_t " session ", gnutls_push_func " push_func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_push_func push_func" 12 +a callback function similar to \fBwrite()\fP +.SH "DESCRIPTION" +This is the function where you set a push function for gnutls to +use in order to send data. If you are going to use berkeley style +sockets, you do not need to use this function since the default +send(2) will probably be ok. Otherwise you should specify this +function for gnutls to be able to send data. +The callback should return a positive number indicating the +bytes sent, and \-1 on error. + + \fIpush_func\fP is of the form, +ssize_t (*gnutls_push_func)(gnutls_transport_ptr_t, const void*, size_t); +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_transport_set_vec_push_function.3 b/doc/manpages/gnutls_transport_set_vec_push_function.3 new file mode 100644 index 0000000..64cb558 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_vec_push_function.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_vec_push_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_vec_push_function \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "void gnutls_transport_set_vec_push_function(gnutls_session_t " session ", gnutls_vec_push_func " vec_func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP type. +.IP "gnutls_vec_push_func vec_func" 12 +a callback function similar to \fBwritev()\fP +.SH "DESCRIPTION" +Using this function you can override the default writev(2) +function for gnutls to send data. Setting this callback +instead of \fBgnutls_transport_set_push_function()\fP is recommended +since it introduces less overhead in the TLS handshake process. + + \fIvec_func\fP is of the form, +ssize_t (*gnutls_vec_push_func) (gnutls_transport_ptr_t, const giovec_t * iov, int iovcnt); +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_url_is_supported.3 b/doc/manpages/gnutls_url_is_supported.3 new file mode 100644 index 0000000..488a4b0 --- /dev/null +++ b/doc/manpages/gnutls_url_is_supported.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_url_is_supported" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_url_is_supported \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "unsigned gnutls_url_is_supported(const char * " url ");" +.SH ARGUMENTS +.IP "const char * url" 12 +A URI to be tested +.SH "DESCRIPTION" +Check whether the provided \fIurl\fP is supported. Depending on the system libraries +GnuTLS may support pkcs11, tpmkey or other URLs. +.SH "RETURNS" +return non\-zero if the given URL is supported, and zero if +it is not known. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_utf8_password_normalize.3 b/doc/manpages/gnutls_utf8_password_normalize.3 new file mode 100644 index 0000000..5403380 --- /dev/null +++ b/doc/manpages/gnutls_utf8_password_normalize.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_utf8_password_normalize" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_utf8_password_normalize \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_utf8_password_normalize(const unsigned char * " password ", unsigned " plen ", gnutls_datum_t * " out ", unsigned " flags ");" +.SH ARGUMENTS +.IP "const unsigned char * password" 12 +contain the UTF\-8 formatted password +.IP "unsigned plen" 12 +the length of the provided password +.IP "gnutls_datum_t * out" 12 +the result in an null\-terminated allocated string +.IP "unsigned flags" 12 +should be zero +.SH "DESCRIPTION" +This function will convert the provided UTF\-8 password according +to the normalization rules in RFC7613. + +If the flag \fBGNUTLS_UTF8_IGNORE_ERRS\fP is specified, any UTF\-8 encoding +errors will be ignored, and in that case the output will be a copy of the input. +.SH "RETURNS" +\fBGNUTLS_E_INVALID_UTF8_STRING\fP on invalid UTF\-8 data, or 0 on success. +.SH "SINCE" +3.5.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_verify_stored_pubkey.3 b/doc/manpages/gnutls_verify_stored_pubkey.3 new file mode 100644 index 0000000..37fc9b4 --- /dev/null +++ b/doc/manpages/gnutls_verify_stored_pubkey.3 @@ -0,0 +1,69 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_verify_stored_pubkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_verify_stored_pubkey \- API function +.SH SYNOPSIS +.B #include <gnutls/gnutls.h> +.sp +.BI "int gnutls_verify_stored_pubkey(const char * " db_name ", gnutls_tdb_t " tdb ", const char * " host ", const char * " service ", gnutls_certificate_type_t " cert_type ", const gnutls_datum_t * " cert ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * db_name" 12 +A file specifying the stored keys (use NULL for the default) +.IP "gnutls_tdb_t tdb" 12 +A storage structure or NULL to use the default +.IP "const char * host" 12 +The peer's name +.IP "const char * service" 12 +non\-NULL if this key is specific to a service (e.g. http) +.IP "gnutls_certificate_type_t cert_type" 12 +The type of the certificate +.IP "const gnutls_datum_t * cert" 12 +The raw (der) data of the certificate +.IP "unsigned int flags" 12 +should be 0. +.SH "DESCRIPTION" +This function will try to verify a raw public\-key or a public\-key provided via +a raw (DER\-encoded) certificate using a list of stored public keys. +The \fIservice\fP field if non\-NULL should be a port number. + +The \fIdb_name\fP variable if non\-null specifies a custom backend for +the retrieval of entries. If it is NULL then the +default file backend will be used. In POSIX\-like systems the +file backend uses the $HOME/.gnutls/known_hosts file. + +Note that if the custom storage backend is provided the +retrieval function should return \fBGNUTLS_E_CERTIFICATE_KEY_MISMATCH\fP +if the host/service pair is found but key doesn't match, +\fBGNUTLS_E_NO_CERTIFICATE_FOUND\fP if no such host/service with +the given key is found, and 0 if it was found. The storage +function should return 0 on success. + +As of GnuTLS 3.6.6 this function also verifies raw public keys. +.SH "RETURNS" +If no associated public key is found +then \fBGNUTLS_E_NO_CERTIFICATE_FOUND\fP will be returned. If a key +is found but does not match \fBGNUTLS_E_CERTIFICATE_KEY_MISMATCH\fP +is returned. On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +or a negative error value on other errors. +.SH "SINCE" +3.0.13 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aia_deinit.3 b/doc/manpages/gnutls_x509_aia_deinit.3 new file mode 100644 index 0000000..9e80682 --- /dev/null +++ b/doc/manpages/gnutls_x509_aia_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aia_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aia_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "void gnutls_x509_aia_deinit(gnutls_x509_aia_t " aia ");" +.SH ARGUMENTS +.IP "gnutls_x509_aia_t aia" 12 +The authority info access +.SH "DESCRIPTION" +This function will deinitialize an authority info access type. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aia_get.3 b/doc/manpages/gnutls_x509_aia_get.3 new file mode 100644 index 0000000..0b7e10f --- /dev/null +++ b/doc/manpages/gnutls_x509_aia_get.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aia_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aia_get \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_aia_get(gnutls_x509_aia_t " aia ", unsigned int " seq ", gnutls_datum_t * " oid ", unsigned * " san_type ", gnutls_datum_t * " san ");" +.SH ARGUMENTS +.IP "gnutls_x509_aia_t aia" 12 +The authority info access +.IP "unsigned int seq" 12 +specifies the sequence number of the access descriptor (0 for the first one, 1 for the second etc.) +.IP "gnutls_datum_t * oid" 12 +the type of available data; to be treated as constant. +.IP "unsigned * san_type" 12 +Will hold the type of the name of \fBgnutls_subject_alt_names_t\fP (may be null). +.IP "gnutls_datum_t * san" 12 +the access location name; to be treated as constant (may be null). +.SH "DESCRIPTION" +This function reads from the Authority Information Access type. + +The \fIseq\fP input parameter is used to indicate which member of the +sequence the caller is interested in. The first member is 0, the +second member 1 and so on. When the \fIseq\fP value is out of bounds, +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. + +Typically \fIoid\fP is \fBGNUTLS_OID_AD_CAISSUERS\fP or \fBGNUTLS_OID_AD_OCSP\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aia_init.3 b/doc/manpages/gnutls_x509_aia_init.3 new file mode 100644 index 0000000..1fbe627 --- /dev/null +++ b/doc/manpages/gnutls_x509_aia_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aia_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aia_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_aia_init(gnutls_x509_aia_t * " aia ");" +.SH ARGUMENTS +.IP "gnutls_x509_aia_t * aia" 12 +The authority info access +.SH "DESCRIPTION" +This function will initialize an authority info access type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aia_set.3 b/doc/manpages/gnutls_x509_aia_set.3 new file mode 100644 index 0000000..d6de95d --- /dev/null +++ b/doc/manpages/gnutls_x509_aia_set.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aia_set" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aia_set \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_aia_set(gnutls_x509_aia_t " aia ", const char * " oid ", unsigned " san_type ", const gnutls_datum_t * " san ");" +.SH ARGUMENTS +.IP "gnutls_x509_aia_t aia" 12 +The authority info access +.IP "const char * oid" 12 +the type of data. +.IP "unsigned san_type" 12 +The type of the name (of \fBgnutls_subject_alt_names_t\fP) +.IP "const gnutls_datum_t * san" 12 +The alternative name data +.SH "DESCRIPTION" +This function will store the specified alternative name in +the \fIaia\fP type. + +Typically the value for \fIoid\fP should be \fBGNUTLS_OID_AD_OCSP\fP, or +\fBGNUTLS_OID_AD_CAISSUERS\fP. + +Since version 3.5.7 the \fBGNUTLS_SAN_RFC822NAME\fP, and \fBGNUTLS_SAN_DNSNAME\fP, +are converted to ACE format when necessary. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0), otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aki_deinit.3 b/doc/manpages/gnutls_x509_aki_deinit.3 new file mode 100644 index 0000000..ced3ae6 --- /dev/null +++ b/doc/manpages/gnutls_x509_aki_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aki_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aki_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "void gnutls_x509_aki_deinit(gnutls_x509_aki_t " aki ");" +.SH ARGUMENTS +.IP "gnutls_x509_aki_t aki" 12 +The authority key identifier type +.SH "DESCRIPTION" +This function will deinitialize an authority key identifier. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aki_get_cert_issuer.3 b/doc/manpages/gnutls_x509_aki_get_cert_issuer.3 new file mode 100644 index 0000000..9ec417b --- /dev/null +++ b/doc/manpages/gnutls_x509_aki_get_cert_issuer.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aki_get_cert_issuer" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aki_get_cert_issuer \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_aki_get_cert_issuer(gnutls_x509_aki_t " aki ", unsigned int " seq ", unsigned int * " san_type ", gnutls_datum_t * " san ", gnutls_datum_t * " othername_oid ", gnutls_datum_t * " serial ");" +.SH ARGUMENTS +.IP "gnutls_x509_aki_t aki" 12 +The authority key ID +.IP "unsigned int seq" 12 +The index of the name to get +.IP "unsigned int * san_type" 12 +Will hold the type of the name (of \fBgnutls_subject_alt_names_t\fP) +.IP "gnutls_datum_t * san" 12 +The alternative name data +.IP "gnutls_datum_t * othername_oid" 12 +The object identifier if \fIsan_type\fP is \fBGNUTLS_SAN_OTHERNAME\fP +.IP "gnutls_datum_t * serial" 12 +The authorityCertSerialNumber number +.SH "DESCRIPTION" +This function will return a specific authorityCertIssuer name as stored in +the \fIaki\fP type, as well as the authorityCertSerialNumber. All the returned +values should be treated as constant, and may be set to \fBNULL\fP when are not required. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the index is out of bounds, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aki_get_id.3 b/doc/manpages/gnutls_x509_aki_get_id.3 new file mode 100644 index 0000000..b79f2fe --- /dev/null +++ b/doc/manpages/gnutls_x509_aki_get_id.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aki_get_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aki_get_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_aki_get_id(gnutls_x509_aki_t " aki ", gnutls_datum_t * " id ");" +.SH ARGUMENTS +.IP "gnutls_x509_aki_t aki" 12 +The authority key ID +.IP "gnutls_datum_t * id" 12 +Will hold the identifier +.SH "DESCRIPTION" +This function will return the key identifier as stored in +the \fIaki\fP type. The identifier should be treated as constant. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the index is out of bounds, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aki_init.3 b/doc/manpages/gnutls_x509_aki_init.3 new file mode 100644 index 0000000..8b08f22 --- /dev/null +++ b/doc/manpages/gnutls_x509_aki_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aki_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aki_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_aki_init(gnutls_x509_aki_t * " aki ");" +.SH ARGUMENTS +.IP "gnutls_x509_aki_t * aki" 12 +The authority key ID type +.SH "DESCRIPTION" +This function will initialize an authority key ID. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aki_set_cert_issuer.3 b/doc/manpages/gnutls_x509_aki_set_cert_issuer.3 new file mode 100644 index 0000000..7c6c826 --- /dev/null +++ b/doc/manpages/gnutls_x509_aki_set_cert_issuer.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aki_set_cert_issuer" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aki_set_cert_issuer \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_aki_set_cert_issuer(gnutls_x509_aki_t " aki ", unsigned int " san_type ", const gnutls_datum_t * " san ", const char * " othername_oid ", const gnutls_datum_t * " serial ");" +.SH ARGUMENTS +.IP "gnutls_x509_aki_t aki" 12 +The authority key ID +.IP "unsigned int san_type" 12 +the type of the name (of \fBgnutls_subject_alt_names_t\fP), may be null +.IP "const gnutls_datum_t * san" 12 +The alternative name data +.IP "const char * othername_oid" 12 +The object identifier if \fIsan_type\fP is \fBGNUTLS_SAN_OTHERNAME\fP +.IP "const gnutls_datum_t * serial" 12 +The authorityCertSerialNumber number (may be null) +.SH "DESCRIPTION" +This function will set the authorityCertIssuer name and the authorityCertSerialNumber +to be stored in the \fIaki\fP type. When storing multiple names, the serial +should be set on the first call, and subsequent calls should use a \fBNULL\fP serial. + +Since version 3.5.7 the \fBGNUTLS_SAN_RFC822NAME\fP, \fBGNUTLS_SAN_DNSNAME\fP, and +\fBGNUTLS_SAN_OTHERNAME_XMPP\fP are converted to ACE format when necessary. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_aki_set_id.3 b/doc/manpages/gnutls_x509_aki_set_id.3 new file mode 100644 index 0000000..af73e61 --- /dev/null +++ b/doc/manpages/gnutls_x509_aki_set_id.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_aki_set_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_aki_set_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_aki_set_id(gnutls_x509_aki_t " aki ", const gnutls_datum_t * " id ");" +.SH ARGUMENTS +.IP "gnutls_x509_aki_t aki" 12 +The authority key ID +.IP "const gnutls_datum_t * id" 12 +the key identifier +.SH "DESCRIPTION" +This function will set the keyIdentifier to be stored in the \fIaki\fP type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_cidr_to_rfc5280.3 b/doc/manpages/gnutls_x509_cidr_to_rfc5280.3 new file mode 100644 index 0000000..ae3849c --- /dev/null +++ b/doc/manpages/gnutls_x509_cidr_to_rfc5280.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_cidr_to_rfc5280" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_cidr_to_rfc5280 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_cidr_to_rfc5280(const char * " cidr ", gnutls_datum_t * " cidr_rfc5280 ");" +.SH ARGUMENTS +.IP "const char * cidr" 12 +CIDR in RFC4632 format (IP/prefix), null\-terminated +.IP "gnutls_datum_t * cidr_rfc5280" 12 +CIDR range converted to RFC5280 format +.SH "DESCRIPTION" +This function will convert text CIDR range with prefix (such as '10.0.0.0/8') +to RFC5280 (IP address in network byte order followed by its network mask). +Works for both IPv4 and IPv6. + +The resulting object is directly usable for IP name constraints usage, +for example in functions \fBgnutls_x509_name_constraints_add_permitted\fP +or \fBgnutls_x509_name_constraints_add_excluded\fP. + +The data in datum needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.5.4 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_check_issuer.3 b/doc/manpages/gnutls_x509_crl_check_issuer.3 new file mode 100644 index 0000000..89f7496 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_check_issuer.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_check_issuer" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_check_issuer \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_crl_check_issuer(gnutls_x509_crl_t " crl ", gnutls_x509_crt_t " issuer ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +is the CRL to be checked +.IP "gnutls_x509_crt_t issuer" 12 +is the certificate of a possible issuer +.SH "DESCRIPTION" +This function will check if the given CRL was issued by the given +issuer certificate. +.SH "RETURNS" +true (1) if the given CRL was issued by the given issuer, +and false (0) if not. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_deinit.3 b/doc/manpages/gnutls_x509_crl_deinit.3 new file mode 100644 index 0000000..b4499a7 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_crl_deinit(gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +The data to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a CRL structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_dist_points_deinit.3 b/doc/manpages/gnutls_x509_crl_dist_points_deinit.3 new file mode 100644 index 0000000..da28856 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_dist_points_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_dist_points_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_dist_points_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "void gnutls_x509_crl_dist_points_deinit(gnutls_x509_crl_dist_points_t " cdp ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_dist_points_t cdp" 12 +The CRL distribution points +.SH "DESCRIPTION" +This function will deinitialize a CRL distribution points type. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_dist_points_get.3 b/doc/manpages/gnutls_x509_crl_dist_points_get.3 new file mode 100644 index 0000000..8c54c88 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_dist_points_get.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_dist_points_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_dist_points_get \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_crl_dist_points_get(gnutls_x509_crl_dist_points_t " cdp ", unsigned int " seq ", unsigned int * " type ", gnutls_datum_t * " san ", unsigned int * " reasons ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_dist_points_t cdp" 12 +The CRL distribution points +.IP "unsigned int seq" 12 +specifies the sequence number of the distribution point (0 for the first one, 1 for the second etc.) +.IP "unsigned int * type" 12 +The name type of the corresponding name (gnutls_x509_subject_alt_name_t) +.IP "gnutls_datum_t * san" 12 +The distribution point names (to be treated as constant) +.IP "unsigned int * reasons" 12 +Revocation reasons. An ORed sequence of flags from \fBgnutls_x509_crl_reason_flags_t\fP. +.SH "DESCRIPTION" +This function retrieves the individual CRL distribution points (2.5.29.31), +contained in provided type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the index is out of bounds, otherwise a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_dist_points_init.3 b/doc/manpages/gnutls_x509_crl_dist_points_init.3 new file mode 100644 index 0000000..fc0f0c9 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_dist_points_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_dist_points_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_dist_points_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_crl_dist_points_init(gnutls_x509_crl_dist_points_t * " cdp ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_dist_points_t * cdp" 12 +The CRL distribution points +.SH "DESCRIPTION" +This function will initialize a CRL distribution points type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_dist_points_set.3 b/doc/manpages/gnutls_x509_crl_dist_points_set.3 new file mode 100644 index 0000000..06c1af3 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_dist_points_set.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_dist_points_set" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_dist_points_set \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_crl_dist_points_set(gnutls_x509_crl_dist_points_t " cdp ", gnutls_x509_subject_alt_name_t " type ", const gnutls_datum_t * " san ", unsigned int " reasons ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_dist_points_t cdp" 12 +The CRL distribution points +.IP "gnutls_x509_subject_alt_name_t type" 12 +The type of the name (of \fBgnutls_subject_alt_names_t\fP) +.IP "const gnutls_datum_t * san" 12 +The point name data +.IP "unsigned int reasons" 12 +Revocation reasons. An ORed sequence of flags from \fBgnutls_x509_crl_reason_flags_t\fP. +.SH "DESCRIPTION" +This function will store the specified CRL distribution point value +the \fIcdp\fP type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0), otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_export.3 b/doc/manpages/gnutls_x509_crl_export.3 new file mode 100644 index 0000000..9c16b01 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_export.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_export \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_export(gnutls_x509_crl_t " crl ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +Holds the revocation list +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "void * output_data" 12 +will contain a private key PEM or DER encoded +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will +be replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the revocation list to DER or PEM format. + +If the buffer provided is not long enough to hold the output, then +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be returned. + +If the structure is PEM encoded, it will have a header +of "BEGIN X509 CRL". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_export2.3 b/doc/manpages/gnutls_x509_crl_export2.3 new file mode 100644 index 0000000..a75f33b --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_export2.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_export2(gnutls_x509_crl_t " crl ", gnutls_x509_crt_fmt_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +Holds the revocation list +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "gnutls_datum_t * out" 12 +will contain a private key PEM or DER encoded +.SH "DESCRIPTION" +This function will export the revocation list to DER or PEM format. + +The output buffer is allocated using \fBgnutls_malloc()\fP. + +If the structure is PEM encoded, it will have a header +of "BEGIN X509 CRL". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. + +Since 3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_authority_key_gn_serial.3 b/doc/manpages/gnutls_x509_crl_get_authority_key_gn_serial.3 new file mode 100644 index 0000000..3bed74b --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_authority_key_gn_serial.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_authority_key_gn_serial" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_authority_key_gn_serial \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_authority_key_gn_serial(gnutls_x509_crl_t " crl ", unsigned int " seq ", void * " alt ", size_t * " alt_size ", unsigned int * " alt_type ", void * " serial ", size_t * " serial_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) +.IP "void * alt" 12 +is the place where the alternative name will be copied to +.IP "size_t * alt_size" 12 +holds the size of alt. +.IP "unsigned int * alt_type" 12 +holds the type of the alternative name (one of gnutls_x509_subject_alt_name_t). +.IP "void * serial" 12 +buffer to store the serial number (may be null) +.IP "size_t * serial_size" 12 +Holds the size of the serial field (may be null) +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical (may be null) +.SH "DESCRIPTION" +This function will return the X.509 authority key +identifier when stored as a general name (authorityCertIssuer) +and serial number. + +Because more than one general names might be stored + \fIseq\fP can be used as a counter to request them all until +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "RETURNS" +Returns 0 on success, or an error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_authority_key_id.3 b/doc/manpages/gnutls_x509_crl_get_authority_key_id.3 new file mode 100644 index 0000000..da8679a --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_authority_key_id.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_authority_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_authority_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_authority_key_id(gnutls_x509_crl_t " crl ", void * " id ", size_t * " id_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "void * id" 12 +The place where the identifier will be copied +.IP "size_t * id_size" 12 +Holds the size of the result field. +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +(may be null) +.SH "DESCRIPTION" +This function will return the CRL authority's key identifier. This +is obtained by the X.509 Authority Key identifier extension field +(2.5.29.35). Note that this function +only returns the keyIdentifier field of the extension and +\fBGNUTLS_E_X509_UNSUPPORTED_EXTENSION\fP, if the extension contains +the name and serial number of the certificate. In that case +\fBgnutls_x509_crl_get_authority_key_gn_serial()\fP may be used. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_crt_count.3 b/doc/manpages/gnutls_x509_crl_get_crt_count.3 new file mode 100644 index 0000000..a8cb5ca --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_crt_count.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_crt_count" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_crt_count \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_crt_count(gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.SH "DESCRIPTION" +This function will return the number of revoked certificates in the +given CRL. +.SH "RETURNS" +number of certificates, a negative error code on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_crt_serial.3 b/doc/manpages/gnutls_x509_crl_get_crt_serial.3 new file mode 100644 index 0000000..03866c9 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_crt_serial.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_crt_serial" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_crt_serial \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_crt_serial(gnutls_x509_crl_t " crl ", unsigned " indx ", unsigned char * " serial ", size_t * " serial_size ", time_t * " t ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "unsigned indx" 12 +the index of the certificate to extract (starting from 0) +.IP "unsigned char * serial" 12 +where the serial number will be copied +.IP "size_t * serial_size" 12 +initially holds the size of serial +.IP "time_t * t" 12 +if non null, will hold the time this certificate was revoked +.SH "DESCRIPTION" +This function will retrieve the serial number of the specified, by +the index, revoked certificate. + +Note that this function will have performance issues in large sequences +of revoked certificates. In that case use \fBgnutls_x509_crl_iter_crt_serial()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_dn_oid.3 b/doc/manpages/gnutls_x509_crl_get_dn_oid.3 new file mode 100644 index 0000000..1b7f74b --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_dn_oid.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_dn_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_dn_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_dn_oid(gnutls_x509_crl_t " crl ", unsigned " indx ", void * " oid ", size_t * " sizeof_oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "unsigned indx" 12 +Specifies which DN OID to send. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to store the OID (may be null) +.IP "size_t * sizeof_oid" 12 +initially holds the size of 'oid' +.SH "DESCRIPTION" +This function will extract the requested OID of the name of the CRL +issuer, specified by the given index. + +If oid is null then only the size will be filled. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is +not long enough, and in that case the sizeof_oid will be updated +with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_extension_data.3 b/doc/manpages/gnutls_x509_crl_get_extension_data.3 new file mode 100644 index 0000000..9fb460f --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_extension_data.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_extension_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_extension_data \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_extension_data(gnutls_x509_crl_t " crl ", unsigned " indx ", void * " data ", size_t * " sizeof_data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to send. Use (0) to get the first one. +.IP "void * data" 12 +a pointer to a structure to hold the data (may be null) +.IP "size_t * sizeof_data" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the requested extension data in the CRL. +The extension data will be stored as a string in the provided +buffer. + +Use \fBgnutls_x509_crl_get_extension_info()\fP to extract the OID and +critical flag. Use \fBgnutls_x509_crl_get_extension_info()\fP instead, +if you want to get data indexed by the extension OID rather than +sequence. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. If your have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_extension_data2.3 b/doc/manpages/gnutls_x509_crl_get_extension_data2.3 new file mode 100644 index 0000000..a250d68 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_extension_data2.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_extension_data2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_extension_data2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_extension_data2(gnutls_x509_crl_t " crl ", unsigned " indx ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to read. Use (0) to get the first one. +.IP "gnutls_datum_t * data" 12 +will contain the extension DER\-encoded data +.SH "DESCRIPTION" +This function will return the requested by the index extension data in the +certificate revocation list. The extension data will be allocated using +\fBgnutls_malloc()\fP. + +Use \fBgnutls_x509_crt_get_extension_info()\fP to extract the OID. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. If you have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_extension_info.3 b/doc/manpages/gnutls_x509_crl_get_extension_info.3 new file mode 100644 index 0000000..c818b0e --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_extension_info.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_extension_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_extension_info \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_extension_info(gnutls_x509_crl_t " crl ", unsigned " indx ", void * " oid ", size_t * " sizeof_oid ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to send, use (0) to get the first one. +.IP "void * oid" 12 +a pointer to store the OID +.IP "size_t * sizeof_oid" 12 +initially holds the maximum size of \fIoid\fP , on return +holds actual size of \fIoid\fP . +.IP "unsigned int * critical" 12 +output variable with critical flag, may be NULL. +.SH "DESCRIPTION" +This function will return the requested extension OID in the CRL, +and the critical flag for it. The extension OID will be stored as +a string in the provided buffer. Use +\fBgnutls_x509_crl_get_extension_data()\fP to extract the data. + +If the buffer provided is not long enough to hold the output, then +* \fIsizeof_oid\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be +returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. If your have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_extension_oid.3 b/doc/manpages/gnutls_x509_crl_get_extension_oid.3 new file mode 100644 index 0000000..e566d37 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_extension_oid.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_extension_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_extension_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_extension_oid(gnutls_x509_crl_t " crl ", unsigned " indx ", void * " oid ", size_t * " sizeof_oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to send, use (0) to get the first one. +.IP "void * oid" 12 +a pointer to store the OID (may be null) +.IP "size_t * sizeof_oid" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the requested extension OID in the CRL. +The extension OID will be stored as a string in the provided +buffer. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. If your have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_issuer_dn.3 b/doc/manpages/gnutls_x509_crl_get_issuer_dn.3 new file mode 100644 index 0000000..a860a9d --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_issuer_dn.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_issuer_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_issuer_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_issuer_dn(gnutls_x509_crl_t " crl ", char * " buf ", size_t * " sizeof_buf ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "char * buf" 12 +a pointer to a structure to hold the peer's name (may be null) +.IP "size_t * sizeof_buf" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will copy the name of the CRL issuer in the provided +buffer. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +If buf is \fBNULL\fP then only the size will be filled. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_x509_crl_get_issuer_dn3()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is +not long enough, and in that case the sizeof_buf will be updated +with the required size, and 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_issuer_dn2.3 b/doc/manpages/gnutls_x509_crl_get_issuer_dn2.3 new file mode 100644 index 0000000..563726a --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_issuer_dn2.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_issuer_dn2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_issuer_dn2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_issuer_dn2(gnutls_x509_crl_t " crl ", gnutls_datum_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "gnutls_datum_t * dn" 12 +a pointer to a structure to hold the name; must be freed using \fBgnutls_free()\fP +.SH "DESCRIPTION" +This function will allocate buffer and copy the name of the CRL issuer. +The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_x509_crl_get_issuer_dn3()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_issuer_dn3.3 b/doc/manpages/gnutls_x509_crl_get_issuer_dn3.3 new file mode 100644 index 0000000..3ca8b5c --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_issuer_dn3.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_issuer_dn3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_issuer_dn3 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_issuer_dn3(gnutls_x509_crl_t " crl ", gnutls_datum_t * " dn ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "gnutls_datum_t * dn" 12 +a pointer to a structure to hold the name; must be freed using \fBgnutls_free()\fP +.IP "unsigned flags" 12 +zero or \fBGNUTLS_X509_DN_FLAG_COMPAT\fP +.SH "DESCRIPTION" +This function will allocate buffer and copy the name of the CRL issuer. +The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +When the flag \fBGNUTLS_X509_DN_FLAG_COMPAT\fP is specified, the output +format will match the format output by previous to 3.5.6 versions of GnuTLS +which was not not fully RFC4514\-compliant. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_issuer_dn_by_oid.3 b/doc/manpages/gnutls_x509_crl_get_issuer_dn_by_oid.3 new file mode 100644 index 0000000..d5e7c83 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_issuer_dn_by_oid.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_issuer_dn_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_issuer_dn_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_issuer_dn_by_oid(gnutls_x509_crl_t " crl ", const char * " oid ", unsigned " indx ", unsigned int " raw_flag ", void * " buf ", size_t * " sizeof_buf ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the RDN, this specifies which to send. Use (0) to get the first one. +.IP "unsigned int raw_flag" 12 +If non\-zero returns the raw DER data of the DN part. +.IP "void * buf" 12 +a pointer to a structure to hold the peer's name (may be null) +.IP "size_t * sizeof_buf" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will extract the part of the name of the CRL issuer +specified by the given OID. The output will be encoded as described +in RFC4514. The output string will be ASCII or UTF\-8 encoded, +depending on the certificate data. + +Some helper macros with popular OIDs can be found in gnutls/x509.h +If raw flag is (0), this function will only return known OIDs as +text. Other OIDs will be DER encoded, as described in RFC4514 \-\- in +hex format with a '#' prefix. You can check about known OIDs +using \fBgnutls_x509_dn_oid_known()\fP. + +If buf is null then only the size will be filled. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is +not long enough, and in that case the sizeof_buf will be updated +with the required size, and 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_next_update.3 b/doc/manpages/gnutls_x509_crl_get_next_update.3 new file mode 100644 index 0000000..f9cc94a --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_next_update.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_next_update" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_next_update \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "time_t gnutls_x509_crl_get_next_update(gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.SH "DESCRIPTION" +This function will return the time the next CRL will be issued. +This field is optional in a CRL so it might be normal to get an +error instead. +.SH "RETURNS" +when the next CRL will be issued, or (time_t)\-1 on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_number.3 b/doc/manpages/gnutls_x509_crl_get_number.3 new file mode 100644 index 0000000..78e2387 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_number.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_number" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_number \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_number(gnutls_x509_crl_t " crl ", void * " ret ", size_t * " ret_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "void * ret" 12 +The place where the number will be copied +.IP "size_t * ret_size" 12 +Holds the size of the result field. +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +(may be null) +.SH "DESCRIPTION" +This function will return the CRL number extension. This is +obtained by the CRL Number extension field (2.5.29.20). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_raw_issuer_dn.3 b/doc/manpages/gnutls_x509_crl_get_raw_issuer_dn.3 new file mode 100644 index 0000000..84a2356 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_raw_issuer_dn.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_raw_issuer_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_raw_issuer_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_raw_issuer_dn(gnutls_x509_crl_t " crl ", gnutls_datum_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "gnutls_datum_t * dn" 12 +will hold the starting point of the DN +.SH "DESCRIPTION" +This function will return a pointer to the DER encoded DN structure +and the length. +.SH "RETURNS" +a negative error code on error, and (0) on success. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_signature.3 b/doc/manpages/gnutls_x509_crl_get_signature.3 new file mode 100644 index 0000000..1b9d139 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_signature.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_signature" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_signature \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_signature(gnutls_x509_crl_t " crl ", char * " sig ", size_t * " sizeof_sig ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "char * sig" 12 +a pointer where the signature part will be copied (may be null). +.IP "size_t * sizeof_sig" 12 +initially holds the size of \fIsig\fP +.SH "DESCRIPTION" +This function will extract the signature field of a CRL. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_signature_algorithm.3 b/doc/manpages/gnutls_x509_crl_get_signature_algorithm.3 new file mode 100644 index 0000000..701fd59 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_signature_algorithm.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_signature_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_signature_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_signature_algorithm(gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.SH "DESCRIPTION" +This function will return a value of the \fBgnutls_sign_algorithm_t\fP +enumeration that is the signature algorithm. + +Since 3.6.0 this function never returns a negative error code. +Error cases and unknown/unsupported signature algorithms are +mapped to \fBGNUTLS_SIGN_UNKNOWN\fP. +.SH "RETURNS" +a \fBgnutls_sign_algorithm_t\fP value +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_signature_oid.3 b/doc/manpages/gnutls_x509_crl_get_signature_oid.3 new file mode 100644 index 0000000..421ee3a --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_signature_oid.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_signature_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_signature_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_signature_oid(gnutls_x509_crl_t " crl ", char * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "char * oid" 12 +a pointer to a buffer to hold the OID (may be null) +.IP "size_t * oid_size" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the OID of the signature algorithm +that has been used to sign this CRL. This is function +is useful in the case \fBgnutls_x509_crl_get_signature_algorithm()\fP +returned \fBGNUTLS_SIGN_UNKNOWN\fP. +.SH "RETURNS" +zero or a negative error code on error. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_this_update.3 b/doc/manpages/gnutls_x509_crl_get_this_update.3 new file mode 100644 index 0000000..e619521 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_this_update.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_this_update" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_this_update \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "time_t gnutls_x509_crl_get_this_update(gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.SH "DESCRIPTION" +This function will return the time this CRL was issued. +.SH "RETURNS" +when the CRL was issued, or (time_t)\-1 on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_get_version.3 b/doc/manpages/gnutls_x509_crl_get_version.3 new file mode 100644 index 0000000..428e1bb --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_version.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_version \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_get_version(gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.SH "DESCRIPTION" +This function will return the version of the specified CRL. +.SH "RETURNS" +The version number, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_import.3 b/doc/manpages/gnutls_x509_crl_import.3 new file mode 100644 index 0000000..dff4e01 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_import.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_import \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_import(gnutls_x509_crl_t " crl ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +The data to store the parsed CRL. +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded CRL. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM +.SH "DESCRIPTION" +This function will convert the given DER or PEM encoded CRL +to the native \fBgnutls_x509_crl_t\fP format. The output will be stored in 'crl'. + +If the CRL is PEM encoded it should have a header of "X509 CRL". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_init.3 b/doc/manpages/gnutls_x509_crl_init.3 new file mode 100644 index 0000000..17ddafc --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_init(gnutls_x509_crl_t * " crl ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t * crl" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a CRL structure. CRL stands for +Certificate Revocation List. A revocation list usually contains +lists of certificate serial numbers that have been revoked by an +Authority. The revocation lists are always signed with the +authority's private key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_iter_crt_serial.3 b/doc/manpages/gnutls_x509_crl_iter_crt_serial.3 new file mode 100644 index 0000000..ed6a661 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_iter_crt_serial.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_iter_crt_serial" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_iter_crt_serial \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_iter_crt_serial(gnutls_x509_crl_t " crl ", gnutls_x509_crl_iter_t * " iter ", unsigned char * " serial ", size_t * " serial_size ", time_t * " t ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP type +.IP "gnutls_x509_crl_iter_t * iter" 12 +A pointer to an iterator (initially the iterator should be \fBNULL\fP) +.IP "unsigned char * serial" 12 +where the serial number will be copied +.IP "size_t * serial_size" 12 +initially holds the size of serial +.IP "time_t * t" 12 +if non null, will hold the time this certificate was revoked +.SH "DESCRIPTION" +This function performs the same as \fBgnutls_x509_crl_get_crt_serial()\fP, +but reads sequentially and keeps state in the iterator +between calls. That allows it to provide better performance in sequences +with many elements (50000+). + +When past the last element is accessed \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +is returned and the iterator is reset. + +After use, the iterator must be deinitialized using \fBgnutls_x509_crl_iter_deinit()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_iter_deinit.3 b/doc/manpages/gnutls_x509_crl_iter_deinit.3 new file mode 100644 index 0000000..223eff1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_iter_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_iter_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_iter_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_crl_iter_deinit(gnutls_x509_crl_iter_t " iter ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_iter_t iter" 12 +The iterator to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize an iterator type. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_list_import.3 b/doc/manpages/gnutls_x509_crl_list_import.3 new file mode 100644 index 0000000..923ee50 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_list_import.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_list_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_list_import \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_list_import(gnutls_x509_crl_t * " crls ", unsigned int * " crl_max ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t * crls" 12 +Indicates where the parsed CRLs will be copied to. Must not be initialized. +.IP "unsigned int * crl_max" 12 +Initially must hold the maximum number of crls. It will be updated with the number of crls available. +.IP "const gnutls_datum_t * data" 12 +The PEM encoded CRLs +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM. +.IP "unsigned int flags" 12 +must be (0) or an OR'd sequence of gnutls_certificate_import_flags. +.SH "DESCRIPTION" +This function will convert the given PEM encoded CRL list +to the native gnutls_x509_crl_t format. The output will be stored +in \fIcrls\fP . They will be automatically initialized. + +If the Certificate is PEM encoded it should have a header of "X509 CRL". +.SH "RETURNS" +the number of certificates read or a negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_list_import2.3 b/doc/manpages/gnutls_x509_crl_list_import2.3 new file mode 100644 index 0000000..c76bfcc --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_list_import2.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_list_import2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_list_import2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_list_import2(gnutls_x509_crl_t ** " crls ", unsigned int * " size ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t ** crls" 12 +Will contain the parsed crl list. +.IP "unsigned int * size" 12 +It will contain the size of the list. +.IP "const gnutls_datum_t * data" 12 +The PEM encoded CRL. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM. +.IP "unsigned int flags" 12 +must be (0) or an OR'd sequence of gnutls_certificate_import_flags. +.SH "DESCRIPTION" +This function will convert the given PEM encoded CRL list +to the native gnutls_x509_crl_t format. The output will be stored +in \fIcrls\fP . They will be automatically initialized. + +If the Certificate is PEM encoded it should have a header of "X509 +CRL". +.SH "RETURNS" +the number of certificates read or a negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_print.3 b/doc/manpages/gnutls_x509_crl_print.3 new file mode 100644 index 0000000..7e2217f --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_print.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_print \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_print(gnutls_x509_crl_t " crl ", gnutls_certificate_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +The data to be printed +.IP "gnutls_certificate_print_formats_t format" 12 +Indicate the format to use +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with null terminated string. +.SH "DESCRIPTION" +This function will pretty print a X.509 certificate revocation +list, suitable for display to a human. + +The output \fIout\fP needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_privkey_sign.3 b/doc/manpages/gnutls_x509_crl_privkey_sign.3 new file mode 100644 index 0000000..d71a69f --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_privkey_sign.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_privkey_sign" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_privkey_sign \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_x509_crl_privkey_sign(gnutls_x509_crl_t " crl ", gnutls_x509_crt_t " issuer ", gnutls_privkey_t " issuer_key ", gnutls_digest_algorithm_t " dig ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "gnutls_x509_crt_t issuer" 12 +is the certificate of the certificate issuer +.IP "gnutls_privkey_t issuer_key" 12 +holds the issuer's private key +.IP "gnutls_digest_algorithm_t dig" 12 +The message digest to use. GNUTLS_DIG_SHA256 is the safe choice unless you know what you're doing. +.IP "unsigned int flags" 12 +must be 0 +.SH "DESCRIPTION" +This function will sign the CRL with the issuer's private key, and +will copy the issuer's information into the CRL. + +This must be the last step in a certificate CRL since all +the previously set parameters are now signed. + +A known limitation of this function is, that a newly\-signed CRL will not +be fully functional (e.g., for signature verification), until it +is exported an re\-imported. + +After GnuTLS 3.6.1 the value of \fIdig\fP may be \fBGNUTLS_DIG_UNKNOWN\fP, +and in that case, a suitable but reasonable for the key algorithm will be selected. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. + +Since 2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_set_authority_key_id.3 b/doc/manpages/gnutls_x509_crl_set_authority_key_id.3 new file mode 100644 index 0000000..79a9142 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_authority_key_id.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_authority_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_authority_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_set_authority_key_id(gnutls_x509_crl_t " crl ", const void * " id ", size_t " id_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +a CRL of type \fBgnutls_x509_crl_t\fP +.IP "const void * id" 12 +The key ID +.IP "size_t id_size" 12 +Holds the size of the serial field. +.SH "DESCRIPTION" +This function will set the CRL's authority key ID extension. Only +the keyIdentifier field can be set with this function. This may +be used by an authority that holds multiple private keys, to distinguish +the used key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_set_crt.3 b/doc/manpages/gnutls_x509_crl_set_crt.3 new file mode 100644 index 0000000..d467490 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_crt.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_set_crt(gnutls_x509_crl_t " crl ", gnutls_x509_crt_t " crt ", time_t " revocation_time ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP with the revoked certificate +.IP "time_t revocation_time" 12 +The time this certificate was revoked +.SH "DESCRIPTION" +This function will set a revoked certificate's serial number to the CRL. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_set_crt_serial.3 b/doc/manpages/gnutls_x509_crl_set_crt_serial.3 new file mode 100644 index 0000000..8a430fc --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_crt_serial.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_crt_serial" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_crt_serial \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_set_crt_serial(gnutls_x509_crl_t " crl ", const void * " serial ", size_t " serial_size ", time_t " revocation_time ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "const void * serial" 12 +The revoked certificate's serial number +.IP "size_t serial_size" 12 +Holds the size of the serial field. +.IP "time_t revocation_time" 12 +The time this certificate was revoked +.SH "DESCRIPTION" +This function will set a revoked certificate's serial number to the CRL. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_set_next_update.3 b/doc/manpages/gnutls_x509_crl_set_next_update.3 new file mode 100644 index 0000000..c2a13fc --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_next_update.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_next_update" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_next_update \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_set_next_update(gnutls_x509_crl_t " crl ", time_t " exp_time ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "time_t exp_time" 12 +The actual time +.SH "DESCRIPTION" +This function will set the time this CRL will be updated. +This is an optional value to be set on a CRL and this call +can be omitted when generating a CRL. + +Prior to GnuTLS 3.5.7, setting a nextUpdate field was required +in order to generate a CRL. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_set_number.3 b/doc/manpages/gnutls_x509_crl_set_number.3 new file mode 100644 index 0000000..ce08294 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_number.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_number" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_number \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_set_number(gnutls_x509_crl_t " crl ", const void * " nr ", size_t " nr_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +a CRL of type \fBgnutls_x509_crl_t\fP +.IP "const void * nr" 12 +The CRL number +.IP "size_t nr_size" 12 +Holds the size of the nr field. +.SH "DESCRIPTION" +This function will set the CRL's number extension. This +is to be used as a unique and monotonic number assigned to +the CRL by the authority. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_set_this_update.3 b/doc/manpages/gnutls_x509_crl_set_this_update.3 new file mode 100644 index 0000000..c67aea2 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_this_update.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_this_update" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_this_update \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_set_this_update(gnutls_x509_crl_t " crl ", time_t " act_time ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "time_t act_time" 12 +The actual time +.SH "DESCRIPTION" +This function will set the time this CRL was issued. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_set_version.3 b/doc/manpages/gnutls_x509_crl_set_version.3 new file mode 100644 index 0000000..de71ce4 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_version.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_version \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_set_version(gnutls_x509_crl_t " crl ", unsigned int " version ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "unsigned int version" 12 +holds the version number. For CRLv1 crls must be 1. +.SH "DESCRIPTION" +This function will set the version of the CRL. This +must be one for CRL version 1, and so on. The CRLs generated +by gnutls should have a version number of 2. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_sign.3 b/doc/manpages/gnutls_x509_crl_sign.3 new file mode 100644 index 0000000..d7887ba --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_sign.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_sign" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_sign \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_sign(gnutls_x509_crl_t " crl ", gnutls_x509_crt_t " issuer ", gnutls_x509_privkey_t " issuer_key ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "gnutls_x509_crt_t issuer" 12 +is the certificate of the certificate issuer +.IP "gnutls_x509_privkey_t issuer_key" 12 +holds the issuer's private key +.SH "DESCRIPTION" +This function is the same a \fBgnutls_x509_crl_sign2()\fP with no flags, +and an appropriate hash algorithm. The hash algorithm used may +vary between versions of GnuTLS, and it is tied to the security +level of the issuer's public key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_sign2.3 b/doc/manpages/gnutls_x509_crl_sign2.3 new file mode 100644 index 0000000..57b27a5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_sign2.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_sign2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_sign2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_sign2(gnutls_x509_crl_t " crl ", gnutls_x509_crt_t " issuer ", gnutls_x509_privkey_t " issuer_key ", gnutls_digest_algorithm_t " dig ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t type +.IP "gnutls_x509_crt_t issuer" 12 +is the certificate of the certificate issuer +.IP "gnutls_x509_privkey_t issuer_key" 12 +holds the issuer's private key +.IP "gnutls_digest_algorithm_t dig" 12 +The message digest to use. GNUTLS_DIG_SHA256 is the safe choice unless you know what you're doing. +.IP "unsigned int flags" 12 +must be 0 +.SH "DESCRIPTION" +This function will sign the CRL with the issuer's private key, and +will copy the issuer's information into the CRL. + +This must be the last step in a certificate CRL since all +the previously set parameters are now signed. + +A known limitation of this function is, that a newly\-signed CRL will not +be fully functional (e.g., for signature verification), until it +is exported an re\-imported. + +After GnuTLS 3.6.1 the value of \fIdig\fP may be \fBGNUTLS_DIG_UNKNOWN\fP, +and in that case, a suitable but reasonable for the key algorithm will be selected. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crl_verify.3 b/doc/manpages/gnutls_x509_crl_verify.3 new file mode 100644 index 0000000..59ca27d --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_verify.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_verify" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_verify \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crl_verify(gnutls_x509_crl_t " crl ", const gnutls_x509_crt_t * " trusted_cas ", unsigned " tcas_size ", unsigned int " flags ", unsigned int * " verify ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +is the crl to be verified +.IP "const gnutls_x509_crt_t * trusted_cas" 12 +is a certificate list that is considered to be trusted one +.IP "unsigned tcas_size" 12 +holds the number of CA certificates in CA_list +.IP "unsigned int flags" 12 +Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations. +.IP "unsigned int * verify" 12 +will hold the crl verification output. +.SH "DESCRIPTION" +This function will try to verify the given crl and return its verification status. +See \fBgnutls_x509_crt_list_verify()\fP for a detailed description of +return values. Note that since GnuTLS 3.1.4 this function includes +the time checks. + +Note that value in \fIverify\fP is set only when the return value of this +function is success (i.e, failure to trust a CRL a certificate does not imply +a negative return value). + +Before GnuTLS 3.5.7 this function would return zero or a positive +number on success. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0), otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_deinit.3 b/doc/manpages/gnutls_x509_crq_deinit.3 new file mode 100644 index 0000000..bfed9af --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_deinit.3 @@ -0,0 +1,34 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_crq_deinit(gnutls_x509_crq_t " crq ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +the type to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a PKCS\fB10\fP certificate request +structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_export.3 b/doc/manpages/gnutls_x509_crq_export.3 new file mode 100644 index 0000000..552e456 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_export.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_export \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_export(gnutls_x509_crq_t " crq ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "void * output_data" 12 +will contain a certificate request PEM or DER encoded +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the certificate request to a PEM or DER +encoded PKCS10 structure. + +If the buffer provided is not long enough to hold the output, then +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be returned and +* \fIoutput_data_size\fP will be updated. + +If the structure is PEM encoded, it will have a header of "BEGIN +NEW CERTIFICATE REQUEST". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_export2.3 b/doc/manpages/gnutls_x509_crq_export2.3 new file mode 100644 index 0000000..813ec5e --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_export2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_export2(gnutls_x509_crq_t " crq ", gnutls_x509_crt_fmt_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "gnutls_datum_t * out" 12 +will contain a certificate request PEM or DER encoded +.SH "DESCRIPTION" +This function will export the certificate request to a PEM or DER +encoded PKCS10 structure. + +The output buffer is allocated using \fBgnutls_malloc()\fP. + +If the structure is PEM encoded, it will have a header of "BEGIN +NEW CERTIFICATE REQUEST". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. + +Since 3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_attribute_by_oid.3 b/doc/manpages/gnutls_x509_crq_get_attribute_by_oid.3 new file mode 100644 index 0000000..577b74c --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_attribute_by_oid.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_attribute_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_attribute_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_attribute_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", unsigned " indx ", void * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "const char * oid" 12 +holds an Object Identifier in null\-terminated string +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the attribute list, this +specifies which to get, use (0) to get the first one +.IP "void * buf" 12 +a pointer to a structure to hold the attribute data (may be \fBNULL\fP) +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will return the attribute in the certificate request +specified by the given Object ID. The attribute will be DER +encoded. + +Attributes in a certificate request is an optional set of data +appended to the request. Their interpretation depends on the CA policy. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_attribute_data.3 b/doc/manpages/gnutls_x509_crq_get_attribute_data.3 new file mode 100644 index 0000000..077f138 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_attribute_data.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_attribute_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_attribute_data \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_attribute_data(gnutls_x509_crq_t " crq ", unsigned " indx ", void * " data ", size_t * " sizeof_data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned indx" 12 +Specifies which attribute number to get. Use (0) to get the first one. +.IP "void * data" 12 +a pointer to a structure to hold the data (may be null) +.IP "size_t * sizeof_data" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the requested attribute data in the +certificate request. The attribute data will be stored as a string in the +provided buffer. + +Use \fBgnutls_x509_crq_get_attribute_info()\fP to extract the OID. +Use \fBgnutls_x509_crq_get_attribute_by_oid()\fP instead, +if you want to get data indexed by the attribute OID rather than +sequence. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. If your have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_attribute_info.3 b/doc/manpages/gnutls_x509_crq_get_attribute_info.3 new file mode 100644 index 0000000..0dab307 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_attribute_info.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_attribute_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_attribute_info \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_attribute_info(gnutls_x509_crq_t " crq ", unsigned " indx ", void * " oid ", size_t * " sizeof_oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned indx" 12 +Specifies which attribute number to get. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to a structure to hold the OID +.IP "size_t * sizeof_oid" 12 +initially holds the maximum size of \fIoid\fP , on return +holds actual size of \fIoid\fP . +.SH "DESCRIPTION" +This function will return the requested attribute OID in the +certificate, and the critical flag for it. The attribute OID will +be stored as a string in the provided buffer. Use +\fBgnutls_x509_crq_get_attribute_data()\fP to extract the data. + +If the buffer provided is not long enough to hold the output, then +* \fIsizeof_oid\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be +returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. If your have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_basic_constraints.3 b/doc/manpages/gnutls_x509_crq_get_basic_constraints.3 new file mode 100644 index 0000000..61e7a43 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_basic_constraints.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_basic_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_basic_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_basic_constraints(gnutls_x509_crq_t " crq ", unsigned int * " critical ", unsigned int * " ca ", int * " pathlen ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.IP "unsigned int * ca" 12 +pointer to output integer indicating CA status, may be NULL, +value is 1 if the certificate CA flag is set, 0 otherwise. +.IP "int * pathlen" 12 +pointer to output integer indicating path length (may be +NULL), non\-negative error codes indicate a present pathLenConstraint +field and the actual value, \-1 indicate that the field is absent. +.SH "DESCRIPTION" +This function will read the certificate's basic constraints, and +return the certificates CA status. It reads the basicConstraints +X.509 extension (2.5.29.19). +.SH "RETURNS" +If the certificate is a CA a positive value will be +returned, or (0) if the certificate does not have CA flag set. +A negative error code may be returned in case of errors. If the +certificate does not contain the basicConstraints extension +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_challenge_password.3 b/doc/manpages/gnutls_x509_crq_get_challenge_password.3 new file mode 100644 index 0000000..215bd04 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_challenge_password.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_challenge_password" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_challenge_password \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_challenge_password(gnutls_x509_crq_t " crq ", char * " pass ", size_t * " pass_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "char * pass" 12 +will hold a (0)\-terminated password string +.IP "size_t * pass_size" 12 +Initially holds the size of \fIpass\fP . +.SH "DESCRIPTION" +This function will return the challenge password in the request. +The challenge password is intended to be used for requesting a +revocation of the certificate. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_dn.3 b/doc/manpages/gnutls_x509_crq_get_dn.3 new file mode 100644 index 0000000..b3b23fc --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_dn.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_dn(gnutls_x509_crq_t " crq ", char * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "char * buf" 12 +a pointer to a structure to hold the name (may be \fBNULL\fP) +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will copy the name of the Certificate request subject +to the provided buffer. The name will be in the form +"C=xxxx,O=yyyy,CN=zzzz" as described in RFC 2253. The output string + \fIbuf\fP will be ASCII or UTF\-8 encoded, depending on the certificate +data. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_x509_crq_get_dn3()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is not +long enough, and in that case the * \fIbuf_size\fP will be updated with +the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_dn2.3 b/doc/manpages/gnutls_x509_crq_get_dn2.3 new file mode 100644 index 0000000..9b4186f --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_dn2.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_dn2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_dn2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_dn2(gnutls_x509_crq_t " crq ", gnutls_datum_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_datum_t * dn" 12 +a pointer to a structure to hold the name; must be freed using \fBgnutls_free()\fP +.SH "DESCRIPTION" +This function will allocate buffer and copy the name of the Certificate +request. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_x509_crq_get_dn3()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. and a negative error code on error. +.SH "SINCE" +3.1.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_dn3.3 b/doc/manpages/gnutls_x509_crq_get_dn3.3 new file mode 100644 index 0000000..df6b5d4 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_dn3.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_dn3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_dn3 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_dn3(gnutls_x509_crq_t " crq ", gnutls_datum_t * " dn ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_datum_t * dn" 12 +a pointer to a structure to hold the name; must be freed using \fBgnutls_free()\fP +.IP "unsigned flags" 12 +zero or \fBGNUTLS_X509_DN_FLAG_COMPAT\fP +.SH "DESCRIPTION" +This function will allocate buffer and copy the name of the Certificate +request. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +When the flag \fBGNUTLS_X509_DN_FLAG_COMPAT\fP is specified, the output +format will match the format output by previous to 3.5.6 versions of GnuTLS +which was not not fully RFC4514\-compliant. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. and a negative error code on error. +.SH "SINCE" +3.5.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_dn_by_oid.3 b/doc/manpages/gnutls_x509_crq_get_dn_by_oid.3 new file mode 100644 index 0000000..cbdc9e7 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_dn_by_oid.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_dn_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_dn_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_dn_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", unsigned " indx ", unsigned int " raw_flag ", void * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a gnutls_x509_crq_t type +.IP "const char * oid" 12 +holds an Object Identifier in a null terminated string +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the RDN, this specifies +which to get. Use (0) to get the first one. +.IP "unsigned int raw_flag" 12 +If non\-zero returns the raw DER data of the DN part. +.IP "void * buf" 12 +a pointer to a structure to hold the name (may be \fBNULL\fP) +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will extract the part of the name of the Certificate +request subject, specified by the given OID. The output will be +encoded as described in RFC2253. The output string will be ASCII +or UTF\-8 encoded, depending on the certificate data. + +Some helper macros with popular OIDs can be found in gnutls/x509.h +If raw flag is (0), this function will only return known OIDs as +text. Other OIDs will be DER encoded, as described in RFC2253 \-\- +in hex format with a '\#' prefix. You can check about known OIDs +using \fBgnutls_x509_dn_oid_known()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is +not long enough, and in that case the * \fIbuf_size\fP will be +updated with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_dn_oid.3 b/doc/manpages/gnutls_x509_crq_get_dn_oid.3 new file mode 100644 index 0000000..86d50aa --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_dn_oid.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_dn_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_dn_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_dn_oid(gnutls_x509_crq_t " crq ", unsigned " indx ", void * " oid ", size_t * " sizeof_oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a gnutls_x509_crq_t type +.IP "unsigned indx" 12 +Specifies which DN OID to get. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to a structure to hold the name (may be \fBNULL\fP) +.IP "size_t * sizeof_oid" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will extract the requested OID of the name of the +certificate request subject, specified by the given index. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is +not long enough, and in that case the * \fIsizeof_oid\fP will be +updated with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_extension_by_oid.3 b/doc/manpages/gnutls_x509_crq_get_extension_by_oid.3 new file mode 100644 index 0000000..93cb34c --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_extension_by_oid.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_extension_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_extension_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_extension_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", unsigned " indx ", void * " buf ", size_t * " buf_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "const char * oid" 12 +holds an Object Identifier in a null terminated string +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the extensions, this +specifies which to get. Use (0) to get the first one. +.IP "void * buf" 12 +a pointer to a structure to hold the name (may be null) +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will return the extension specified by the OID in +the certificate. The extensions will be returned as binary data +DER encoded, in the provided buffer. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. If the certificate does not +contain the specified extension +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_extension_by_oid2.3 b/doc/manpages/gnutls_x509_crq_get_extension_by_oid2.3 new file mode 100644 index 0000000..7804a27 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_extension_by_oid2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_extension_by_oid2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_extension_by_oid2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_extension_by_oid2(gnutls_x509_crq_t " crq ", const char * " oid ", unsigned " indx ", gnutls_datum_t * " output ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "const char * oid" 12 +holds an Object Identifier in a null terminated string +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the extensions, this +specifies which to get. Use (0) to get the first one. +.IP "gnutls_datum_t * output" 12 +will hold the allocated extension data +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will return the extension specified by the OID in +the certificate. The extensions will be returned as binary data +DER encoded, in the provided buffer. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. If the certificate does not +contain the specified extension +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "SINCE" +3.3.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_extension_data.3 b/doc/manpages/gnutls_x509_crq_get_extension_data.3 new file mode 100644 index 0000000..48c05d4 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_extension_data.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_extension_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_extension_data \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_extension_data(gnutls_x509_crq_t " crq ", unsigned " indx ", void * " data ", size_t * " sizeof_data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned indx" 12 +Specifies which extension number to get. Use (0) to get the first one. +.IP "void * data" 12 +a pointer to a structure to hold the data (may be null) +.IP "size_t * sizeof_data" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the requested extension data in the +certificate. The extension data will be stored as a string in the +provided buffer. + +Use \fBgnutls_x509_crq_get_extension_info()\fP to extract the OID and +critical flag. Use \fBgnutls_x509_crq_get_extension_by_oid()\fP instead, +if you want to get data indexed by the extension OID rather than +sequence. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. If your have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_extension_data2.3 b/doc/manpages/gnutls_x509_crq_get_extension_data2.3 new file mode 100644 index 0000000..86f73c4 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_extension_data2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_extension_data2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_extension_data2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_extension_data2(gnutls_x509_crq_t " crq ", unsigned " indx ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to read. Use (0) to get the first one. +.IP "gnutls_datum_t * data" 12 +will contain the extension DER\-encoded data +.SH "DESCRIPTION" +This function will return the requested extension data in the +certificate request. The extension data will be allocated using +\fBgnutls_malloc()\fP. + +Use \fBgnutls_x509_crq_get_extension_info()\fP to extract the OID. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. If you have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_extension_info.3 b/doc/manpages/gnutls_x509_crq_get_extension_info.3 new file mode 100644 index 0000000..1fe5640 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_extension_info.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_extension_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_extension_info \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_extension_info(gnutls_x509_crq_t " crq ", unsigned " indx ", void * " oid ", size_t * " sizeof_oid ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned indx" 12 +Specifies which extension number to get. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to store the OID +.IP "size_t * sizeof_oid" 12 +initially holds the maximum size of \fIoid\fP , on return +holds actual size of \fIoid\fP . +.IP "unsigned int * critical" 12 +output variable with critical flag, may be NULL. +.SH "DESCRIPTION" +This function will return the requested extension OID in the +certificate, and the critical flag for it. The extension OID will +be stored as a string in the provided buffer. Use +\fBgnutls_x509_crq_get_extension_data()\fP to extract the data. + +If the buffer provided is not long enough to hold the output, then +* \fIsizeof_oid\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be +returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error code in case of an error. If your have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_key_id.3 b/doc/manpages/gnutls_x509_crq_get_key_id.3 new file mode 100644 index 0000000..c6ddd60 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_key_id.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_key_id(gnutls_x509_crq_t " crq ", unsigned int " flags ", unsigned char * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate of type \fBgnutls_x509_crq_t\fP +.IP "unsigned int flags" 12 +should be one of the flags from \fBgnutls_keyid_flags_t\fP +.IP "unsigned char * output_data" 12 +will contain the key ID +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will return a unique ID that depends on the public key +parameters. This ID can be used in checking whether a certificate +corresponds to the given private key. + +If the buffer provided is not long enough to hold the output, then +* \fIoutput_data_size\fP is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will +be returned. The output will normally be a SHA\-1 hash output, +which is 20 bytes. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_key_purpose_oid.3 b/doc/manpages/gnutls_x509_crq_get_key_purpose_oid.3 new file mode 100644 index 0000000..50f1758 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_key_purpose_oid.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_key_purpose_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_key_purpose_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_key_purpose_oid(gnutls_x509_crq_t " crq ", unsigned " indx ", void * " oid ", size_t * " sizeof_oid ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned indx" 12 +This specifies which OID to return, use (0) to get the first one +.IP "void * oid" 12 +a pointer to store the OID (may be \fBNULL\fP) +.IP "size_t * sizeof_oid" 12 +initially holds the size of \fIoid\fP +.IP "unsigned int * critical" 12 +output variable with critical flag, may be \fBNULL\fP. +.SH "DESCRIPTION" +This function will extract the key purpose OIDs of the Certificate +specified by the given index. These are stored in the Extended Key +Usage extension (2.5.29.37). See the GNUTLS_KP_* definitions for +human readable names. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is +not long enough, and in that case the * \fIsizeof_oid\fP will be +updated with the required size. On success 0 is returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_key_rsa_raw.3 b/doc/manpages/gnutls_x509_crq_get_key_rsa_raw.3 new file mode 100644 index 0000000..11d715c --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_key_rsa_raw.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_key_rsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_key_rsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_key_rsa_raw(gnutls_x509_crq_t " crq ", gnutls_datum_t * " m ", gnutls_datum_t * " e ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +Holds the certificate +.IP "gnutls_datum_t * m" 12 +will hold the modulus +.IP "gnutls_datum_t * e" 12 +will hold the public exponent +.SH "DESCRIPTION" +This function will export the RSA public key's parameters found in +the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_key_usage.3 b/doc/manpages/gnutls_x509_crq_get_key_usage.3 new file mode 100644 index 0000000..bcd17a5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_key_usage.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_key_usage" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_key_usage \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_key_usage(gnutls_x509_crq_t " crq ", unsigned int * " key_usage ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned int * key_usage" 12 +where the key usage bits will be stored +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will return certificate's key usage, by reading the +keyUsage X.509 extension (2.5.29.15). The key usage value will +ORed values of the: \fBGNUTLS_KEY_DIGITAL_SIGNATURE\fP, +\fBGNUTLS_KEY_NON_REPUDIATION\fP, \fBGNUTLS_KEY_KEY_ENCIPHERMENT\fP, +\fBGNUTLS_KEY_DATA_ENCIPHERMENT\fP, \fBGNUTLS_KEY_KEY_AGREEMENT\fP, +\fBGNUTLS_KEY_KEY_CERT_SIGN\fP, \fBGNUTLS_KEY_CRL_SIGN\fP, +\fBGNUTLS_KEY_ENCIPHER_ONLY\fP, \fBGNUTLS_KEY_DECIPHER_ONLY\fP. +.SH "RETURNS" +the certificate key usage, or a negative error code in case of +parsing error. If the certificate does not contain the keyUsage +extension \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be +returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_pk_algorithm.3 b/doc/manpages/gnutls_x509_crq_get_pk_algorithm.3 new file mode 100644 index 0000000..159417e --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_pk_algorithm.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_pk_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_pk_algorithm(gnutls_x509_crq_t " crq ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned int * bits" 12 +if bits is non\-\fBNULL\fP it will hold the size of the parameters' in bits +.SH "DESCRIPTION" +This function will return the public key algorithm of a PKCS\fB10\fP +certificate request. + +If bits is non\-\fBNULL\fP, it should have enough size to hold the +parameters size in bits. For RSA the bits returned is the modulus. +For DSA the bits returned are of the public exponent. +.SH "RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_pk_oid.3 b/doc/manpages/gnutls_x509_crq_get_pk_oid.3 new file mode 100644 index 0000000..5436956 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_pk_oid.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_pk_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_pk_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_pk_oid(gnutls_x509_crq_t " crq ", char * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "char * oid" 12 +a pointer to a buffer to hold the OID (may be null) +.IP "size_t * oid_size" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the OID of the public key algorithm +on that certificate request. This function +is useful in the case \fBgnutls_x509_crq_get_pk_algorithm()\fP +returned \fBGNUTLS_PK_UNKNOWN\fP. +.SH "RETURNS" +zero or a negative error code on error. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_private_key_usage_period.3 b/doc/manpages/gnutls_x509_crq_get_private_key_usage_period.3 new file mode 100644 index 0000000..61df3ac --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_private_key_usage_period.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_private_key_usage_period" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_private_key_usage_period \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_private_key_usage_period(gnutls_x509_crq_t " crq ", time_t * " activation ", time_t * " expiration ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "time_t * activation" 12 +The activation time +.IP "time_t * expiration" 12 +The expiration time +.IP "unsigned int * critical" 12 +the extension status +.SH "DESCRIPTION" +This function will return the expiration and activation +times of the private key of the certificate. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_signature_algorithm.3 b/doc/manpages/gnutls_x509_crq_get_signature_algorithm.3 new file mode 100644 index 0000000..8b2c7d7 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_signature_algorithm.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_signature_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_signature_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_signature_algorithm(gnutls_x509_crq_t " crq ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_cr_t\fP type +.SH "DESCRIPTION" +This function will return a value of the \fBgnutls_sign_algorithm_t\fP +enumeration that is the signature algorithm that has been used to +sign this certificate request. + +Since 3.6.0 this function never returns a negative error code. +Error cases and unknown/unsupported signature algorithms are +mapped to \fBGNUTLS_SIGN_UNKNOWN\fP. +.SH "RETURNS" +a \fBgnutls_sign_algorithm_t\fP value +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_signature_oid.3 b/doc/manpages/gnutls_x509_crq_get_signature_oid.3 new file mode 100644 index 0000000..a3f4951 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_signature_oid.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_signature_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_signature_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_signature_oid(gnutls_x509_crq_t " crq ", char * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "char * oid" 12 +a pointer to a buffer to hold the OID (may be null) +.IP "size_t * oid_size" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the OID of the signature algorithm +that has been used to sign this certificate request. This function +is useful in the case \fBgnutls_x509_crq_get_signature_algorithm()\fP +returned \fBGNUTLS_SIGN_UNKNOWN\fP. +.SH "RETURNS" +zero or a negative error code on error. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_spki.3 b/doc/manpages/gnutls_x509_crq_get_spki.3 new file mode 100644 index 0000000..3346510 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_spki.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_spki(gnutls_x509_crq_t " crq ", gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_x509_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will return the public key information of a PKCS\fB10\fP +certificate request. The provided \fIspki\fP must be initialized. +.SH "RETURNS" +Zero on success, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_subject_alt_name.3 b/doc/manpages/gnutls_x509_crq_get_subject_alt_name.3 new file mode 100644 index 0000000..4c4409d --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_subject_alt_name.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_subject_alt_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_subject_alt_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_subject_alt_name(gnutls_x509_crq_t " crq ", unsigned int " seq ", void * " ret ", size_t * " ret_size ", unsigned int * " ret_type ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name, 0 for the +first one, 1 for the second etc. +.IP "void * ret" 12 +is the place where the alternative name will be copied to +.IP "size_t * ret_size" 12 +holds the size of ret. +.IP "unsigned int * ret_type" 12 +holds the \fBgnutls_x509_subject_alt_name_t\fP name type +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +(may be null) +.SH "DESCRIPTION" +This function will return the alternative names, contained in the +given certificate. It is the same as +\fBgnutls_x509_crq_get_subject_alt_name()\fP except for the fact that it +will return the type of the alternative name in \fIret_type\fP even if +the function fails for some reason (i.e. the buffer provided is +not enough). +.SH "RETURNS" +the alternative subject name type on success, one of the +enumerated \fBgnutls_x509_subject_alt_name_t\fP. It will return +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if \fIret_size\fP is not large enough to +hold the value. In that case \fIret_size\fP will be updated with the +required size. If the certificate request does not have an +Alternative name with the specified sequence number then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_subject_alt_othername_oid.3 b/doc/manpages/gnutls_x509_crq_get_subject_alt_othername_oid.3 new file mode 100644 index 0000000..9f0d9fd --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_subject_alt_othername_oid.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_subject_alt_othername_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_subject_alt_othername_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_subject_alt_othername_oid(gnutls_x509_crq_t " crq ", unsigned int " seq ", void * " ret ", size_t * " ret_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) +.IP "void * ret" 12 +is the place where the otherName OID will be copied to +.IP "size_t * ret_size" 12 +holds the size of ret. +.SH "DESCRIPTION" +This function will extract the type OID of an otherName Subject +Alternative Name, contained in the given certificate, and return +the type as an enumerated element. + +This function is only useful if +\fBgnutls_x509_crq_get_subject_alt_name()\fP returned +\fBGNUTLS_SAN_OTHERNAME\fP. +.SH "RETURNS" +the alternative subject name type on success, one of the +enumerated gnutls_x509_subject_alt_name_t. For supported OIDs, +it will return one of the virtual (GNUTLS_SAN_OTHERNAME_*) types, +e.g. \fBGNUTLS_SAN_OTHERNAME_XMPP\fP, and \fBGNUTLS_SAN_OTHERNAME\fP for +unknown OIDs. It will return \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if + \fIret_size\fP is not large enough to hold the value. In that case + \fIret_size\fP will be updated with the required size. If the +certificate does not have an Alternative name with the specified +sequence number and with the otherName type then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_tlsfeatures.3 b/doc/manpages/gnutls_x509_crq_get_tlsfeatures.3 new file mode 100644 index 0000000..d530fcd --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_tlsfeatures.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_tlsfeatures" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_tlsfeatures \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_tlsfeatures(gnutls_x509_crq_t " crq ", gnutls_x509_tlsfeatures_t " features ", unsigned int " flags ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +An X.509 certificate request +.IP "gnutls_x509_tlsfeatures_t features" 12 +If the function succeeds, the +features will be stored in this variable. +.IP "unsigned int flags" 12 +zero or \fBGNUTLS_EXT_FLAG_APPEND\fP +.IP "unsigned int * critical" 12 +the extension status +.SH "DESCRIPTION" +This function will get the X.509 TLS features +extension structure from the certificate request. +The returned structure needs to be freed using +\fBgnutls_x509_tlsfeatures_deinit()\fP. + +When the \fIflags\fP is set to \fBGNUTLS_EXT_FLAG_APPEND\fP, +then if the \fIfeatures\fP structure is empty this function will behave +identically as if the flag was not set. Otherwise if there are elements +in the \fIfeatures\fP structure then they will be merged with. + +Note that \fIfeatures\fP must be initialized prior to calling this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_get_version.3 b/doc/manpages/gnutls_x509_crq_get_version.3 new file mode 100644 index 0000000..ddeb1cc --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_version.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_version \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_get_version(gnutls_x509_crq_t " crq ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.SH "DESCRIPTION" +This function will return the version of the specified Certificate +request. +.SH "RETURNS" +version of certificate request, or a negative error code on +error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_import.3 b/doc/manpages/gnutls_x509_crq_import.3 new file mode 100644 index 0000000..349f5fe --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_import.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_import \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_import(gnutls_x509_crq_t " crq ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +The data to store the parsed certificate request. +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded certificate. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM +.SH "DESCRIPTION" +This function will convert the given DER or PEM encoded certificate +request to a \fBgnutls_x509_crq_t\fP type. The output will be +stored in \fIcrq\fP . + +If the Certificate is PEM encoded it should have a header of "NEW +CERTIFICATE REQUEST". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_init.3 b/doc/manpages/gnutls_x509_crq_init.3 new file mode 100644 index 0000000..901c5bf --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_init(gnutls_x509_crq_t * " crq ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t * crq" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a PKCS\fB10\fP certificate request +structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_print.3 b/doc/manpages/gnutls_x509_crq_print.3 new file mode 100644 index 0000000..6e9428f --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_print.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_print \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_print(gnutls_x509_crq_t " crq ", gnutls_certificate_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +The data to be printed +.IP "gnutls_certificate_print_formats_t format" 12 +Indicate the format to use +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with null terminated string. +.SH "DESCRIPTION" +This function will pretty print a certificate request, suitable for +display to a human. + +The output \fIout\fP needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_privkey_sign.3 b/doc/manpages/gnutls_x509_crq_privkey_sign.3 new file mode 100644 index 0000000..4e5667e --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_privkey_sign.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_privkey_sign" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_privkey_sign \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_x509_crq_privkey_sign(gnutls_x509_crq_t " crq ", gnutls_privkey_t " key ", gnutls_digest_algorithm_t " dig ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_privkey_t key" 12 +holds a private key +.IP "gnutls_digest_algorithm_t dig" 12 +The message digest to use, i.e., \fBGNUTLS_DIG_SHA1\fP +.IP "unsigned int flags" 12 +must be 0 +.SH "DESCRIPTION" +This function will sign the certificate request with a private key. +This must be the same key as the one used in +\fBgnutls_x509_crt_set_key()\fP since a certificate request is self +signed. + +This must be the last step in a certificate request generation +since all the previously set parameters are now signed. + +A known limitation of this function is, that a newly\-signed request will not +be fully functional (e.g., for signature verification), until it +is exported an re\-imported. + +After GnuTLS 3.6.1 the value of \fIdig\fP may be \fBGNUTLS_DIG_UNKNOWN\fP, +and in that case, a suitable but reasonable for the key algorithm will be selected. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +\fBGNUTLS_E_ASN1_VALUE_NOT_FOUND\fP is returned if you didn't set all +information in the certificate request (e.g., the version using +\fBgnutls_x509_crq_set_version()\fP). +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_attribute_by_oid.3 b/doc/manpages/gnutls_x509_crq_set_attribute_by_oid.3 new file mode 100644 index 0000000..16c1481 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_attribute_by_oid.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_attribute_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_attribute_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_attribute_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", void * " buf ", size_t " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "const char * oid" 12 +holds an Object Identifier in a null\-terminated string +.IP "void * buf" 12 +a pointer to a structure that holds the attribute data +.IP "size_t buf_size" 12 +holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will set the attribute in the certificate request +specified by the given Object ID. The provided attribute must be be DER +encoded. + +Attributes in a certificate request is an optional set of data +appended to the request. Their interpretation depends on the CA policy. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_basic_constraints.3 b/doc/manpages/gnutls_x509_crq_set_basic_constraints.3 new file mode 100644 index 0000000..450b2d3 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_basic_constraints.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_basic_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_basic_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_basic_constraints(gnutls_x509_crq_t " crq ", unsigned int " ca ", int " pathLenConstraint ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate request of type \fBgnutls_x509_crq_t\fP +.IP "unsigned int ca" 12 +true(1) or false(0) depending on the Certificate authority status. +.IP "int pathLenConstraint" 12 +non\-negative error codes indicate maximum length of path, +and negative error codes indicate that the pathLenConstraints field should +not be present. +.SH "DESCRIPTION" +This function will set the basicConstraints certificate extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_challenge_password.3 b/doc/manpages/gnutls_x509_crq_set_challenge_password.3 new file mode 100644 index 0000000..dccb002 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_challenge_password.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_challenge_password" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_challenge_password \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_challenge_password(gnutls_x509_crq_t " crq ", const char * " pass ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "const char * pass" 12 +holds a (0)\-terminated password +.SH "DESCRIPTION" +This function will set a challenge password to be used when +revoking the request. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_dn.3 b/doc/manpages/gnutls_x509_crq_set_dn.3 new file mode 100644 index 0000000..9302e22 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_dn.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_dn(gnutls_x509_crq_t " crq ", const char * " dn ", const char ** " err ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate of type \fBgnutls_x509_crq_t\fP +.IP "const char * dn" 12 +a comma separated DN string (RFC4514) +.IP "const char ** err" 12 +indicates the error position (if any) +.SH "DESCRIPTION" +This function will set the DN on the provided certificate. +The input string should be plain ASCII or UTF\-8 encoded. On +DN parsing error \fBGNUTLS_E_PARSING_ERROR\fP is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_dn_by_oid.3 b/doc/manpages/gnutls_x509_crq_set_dn_by_oid.3 new file mode 100644 index 0000000..a31bae5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_dn_by_oid.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_dn_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_dn_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_dn_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", unsigned int " raw_flag ", const void * " data ", unsigned int " sizeof_data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "const char * oid" 12 +holds an Object Identifier in a (0)\-terminated string +.IP "unsigned int raw_flag" 12 +must be 0, or 1 if the data are DER encoded +.IP "const void * data" 12 +a pointer to the input data +.IP "unsigned int sizeof_data" 12 +holds the size of \fIdata\fP +.SH "DESCRIPTION" +This function will set the part of the name of the Certificate +request subject, specified by the given OID. The input string +should be ASCII or UTF\-8 encoded. + +Some helper macros with popular OIDs can be found in gnutls/x509.h +With this function you can only set the known OIDs. You can test +for known OIDs using \fBgnutls_x509_dn_oid_known()\fP. For OIDs that are +not known (by gnutls) you should properly DER encode your data, and +call this function with raw_flag set. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_extension_by_oid.3 b/doc/manpages/gnutls_x509_crq_set_extension_by_oid.3 new file mode 100644 index 0000000..d59faf5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_extension_by_oid.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_extension_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_extension_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_extension_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", const void * " buf ", size_t " sizeof_buf ", unsigned int " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate of type \fBgnutls_x509_crq_t\fP +.IP "const char * oid" 12 +holds an Object Identifier in null terminated string +.IP "const void * buf" 12 +a pointer to a DER encoded data +.IP "size_t sizeof_buf" 12 +holds the size of \fIbuf\fP +.IP "unsigned int critical" 12 +should be non\-zero if the extension is to be marked as critical +.SH "DESCRIPTION" +This function will set an the extension, by the specified OID, in +the certificate request. The extension data should be binary data DER +encoded. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_key.3 b/doc/manpages/gnutls_x509_crq_set_key.3 new file mode 100644 index 0000000..6f4c836 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_key.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_key" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_key \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_key(gnutls_x509_crq_t " crq ", gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_x509_privkey_t key" 12 +holds a private key +.SH "DESCRIPTION" +This function will set the public parameters from the given private +key to the request. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_key_purpose_oid.3 b/doc/manpages/gnutls_x509_crq_set_key_purpose_oid.3 new file mode 100644 index 0000000..e36961e --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_key_purpose_oid.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_key_purpose_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_key_purpose_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_key_purpose_oid(gnutls_x509_crq_t " crq ", const void * " oid ", unsigned int " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate of type \fBgnutls_x509_crq_t\fP +.IP "const void * oid" 12 +a pointer to a null\-terminated string that holds the OID +.IP "unsigned int critical" 12 +Whether this extension will be critical or not +.SH "DESCRIPTION" +This function will set the key purpose OIDs of the Certificate. +These are stored in the Extended Key Usage extension (2.5.29.37) +See the GNUTLS_KP_* definitions for human readable names. + +Subsequent calls to this function will append OIDs to the OID list. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_key_rsa_raw.3 b/doc/manpages/gnutls_x509_crq_set_key_rsa_raw.3 new file mode 100644 index 0000000..10afd15 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_key_rsa_raw.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_key_rsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_key_rsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_key_rsa_raw(gnutls_x509_crq_t " crq ", const gnutls_datum_t * " m ", const gnutls_datum_t * " e ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "const gnutls_datum_t * m" 12 +holds the modulus +.IP "const gnutls_datum_t * e" 12 +holds the public exponent +.SH "DESCRIPTION" +This function will set the public parameters from the given private +key to the request. Only RSA keys are currently supported. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_key_usage.3 b/doc/manpages/gnutls_x509_crq_set_key_usage.3 new file mode 100644 index 0000000..32c19da --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_key_usage.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_key_usage" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_key_usage \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_key_usage(gnutls_x509_crq_t " crq ", unsigned int " usage ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate request of type \fBgnutls_x509_crq_t\fP +.IP "unsigned int usage" 12 +an ORed sequence of the GNUTLS_KEY_* elements. +.SH "DESCRIPTION" +This function will set the keyUsage certificate extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_private_key_usage_period.3 b/doc/manpages/gnutls_x509_crq_set_private_key_usage_period.3 new file mode 100644 index 0000000..d55fab3 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_private_key_usage_period.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_private_key_usage_period" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_private_key_usage_period \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_private_key_usage_period(gnutls_x509_crq_t " crq ", time_t " activation ", time_t " expiration ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate of type \fBgnutls_x509_crq_t\fP +.IP "time_t activation" 12 +The activation time +.IP "time_t expiration" 12 +The expiration time +.SH "DESCRIPTION" +This function will set the private key usage period extension (2.5.29.16). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_pubkey.3 b/doc/manpages/gnutls_x509_crq_set_pubkey.3 new file mode 100644 index 0000000..3d7b3b0 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_pubkey.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_pubkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_pubkey \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_x509_crq_set_pubkey(gnutls_x509_crq_t " crq ", gnutls_pubkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_pubkey_t key" 12 +holds a public key +.SH "DESCRIPTION" +This function will set the public parameters from the given public +key to the request. The \fIkey\fP can be deallocated after that. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_spki.3 b/doc/manpages/gnutls_x509_crq_set_spki.3 new file mode 100644 index 0000000..85c345a --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_spki.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_spki(gnutls_x509_crq_t " crq ", const gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate request of type \fBgnutls_x509_crq_t\fP +.IP "const gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_x509_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will set the certificate request's subject public key +information explicitly. This is intended to be used in the cases +where a single public key (e.g., RSA) can be used for multiple +signature algorithms (RSA PKCS1\-1.5, and RSA\-PSS). + +To export the public key (i.e., the SubjectPublicKeyInfo part), check +\fBgnutls_pubkey_import_x509()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_subject_alt_name.3 b/doc/manpages/gnutls_x509_crq_set_subject_alt_name.3 new file mode 100644 index 0000000..7ce7fb6 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_subject_alt_name.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_subject_alt_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_subject_alt_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_subject_alt_name(gnutls_x509_crq_t " crq ", gnutls_x509_subject_alt_name_t " nt ", const void * " data ", unsigned int " data_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate request of type \fBgnutls_x509_crq_t\fP +.IP "gnutls_x509_subject_alt_name_t nt" 12 +is one of the \fBgnutls_x509_subject_alt_name_t\fP enumerations +.IP "const void * data" 12 +The data to be set +.IP "unsigned int data_size" 12 +The size of data to be set +.IP "unsigned int flags" 12 +\fBGNUTLS_FSAN_SET\fP to clear previous data or +\fBGNUTLS_FSAN_APPEND\fP to append. +.SH "DESCRIPTION" +This function will set the subject alternative name certificate +extension. It can set the following types: +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_subject_alt_othername.3 b/doc/manpages/gnutls_x509_crq_set_subject_alt_othername.3 new file mode 100644 index 0000000..0eb6e38 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_subject_alt_othername.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_subject_alt_othername" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_subject_alt_othername \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_subject_alt_othername(gnutls_x509_crq_t " crq ", const char * " oid ", const void * " data ", unsigned int " data_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +a certificate request of type \fBgnutls_x509_crq_t\fP +.IP "const char * oid" 12 +is the othername OID +.IP "const void * data" 12 +The data to be set +.IP "unsigned int data_size" 12 +The size of data to be set +.IP "unsigned int flags" 12 +\fBGNUTLS_FSAN_SET\fP to clear previous data or +\fBGNUTLS_FSAN_APPEND\fP to append. +.SH "DESCRIPTION" +This function will set the subject alternative name certificate +extension. It can set the following types: + +The values set must be binary values and must be properly DER encoded. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_tlsfeatures.3 b/doc/manpages/gnutls_x509_crq_set_tlsfeatures.3 new file mode 100644 index 0000000..e33d682 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_tlsfeatures.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_tlsfeatures" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_tlsfeatures \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_tlsfeatures(gnutls_x509_crq_t " crq ", gnutls_x509_tlsfeatures_t " features ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +An X.509 certificate request +.IP "gnutls_x509_tlsfeatures_t features" 12 +If the function succeeds, the +features will be added to the certificate +request. +.SH "DESCRIPTION" +This function will set the certificate request's +X.509 TLS extension from the given structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_set_version.3 b/doc/manpages/gnutls_x509_crq_set_version.3 new file mode 100644 index 0000000..ffb7a56 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_version.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_version \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_set_version(gnutls_x509_crq_t " crq ", unsigned int " version ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "unsigned int version" 12 +holds the version number, for v1 Requests must be 1 +.SH "DESCRIPTION" +This function will set the version of the certificate request. For +version 1 requests this must be one. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_sign.3 b/doc/manpages/gnutls_x509_crq_sign.3 new file mode 100644 index 0000000..4c97183 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_sign.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_sign" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_sign \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_sign(gnutls_x509_crq_t " crq ", gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_x509_privkey_t key" 12 +holds a private key +.SH "DESCRIPTION" +This function is the same a \fBgnutls_x509_crq_sign2()\fP with no flags, +and an appropriate hash algorithm. The hash algorithm used may +vary between versions of GnuTLS, and it is tied to the security +level of the issuer's public key. + +A known limitation of this function is, that a newly\-signed request will not +be fully functional (e.g., for signature verification), until it +is exported an re\-imported. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_sign2.3 b/doc/manpages/gnutls_x509_crq_sign2.3 new file mode 100644 index 0000000..d8540b4 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_sign2.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_sign2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_sign2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_sign2(gnutls_x509_crq_t " crq ", gnutls_x509_privkey_t " key ", gnutls_digest_algorithm_t " dig ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP type +.IP "gnutls_x509_privkey_t key" 12 +holds a private key +.IP "gnutls_digest_algorithm_t dig" 12 +The message digest to use, i.e., \fBGNUTLS_DIG_SHA256\fP +.IP "unsigned int flags" 12 +must be 0 +.SH "DESCRIPTION" +This function will sign the certificate request with a private key. +This must be the same key as the one used in +\fBgnutls_x509_crt_set_key()\fP since a certificate request is self +signed. + +This must be the last step in a certificate request generation +since all the previously set parameters are now signed. + +A known limitation of this function is, that a newly\-signed request will not +be fully functional (e.g., for signature verification), until it +is exported an re\-imported. + +After GnuTLS 3.6.1 the value of \fIdig\fP may be \fBGNUTLS_DIG_UNKNOWN\fP, +and in that case, a suitable but reasonable for the key algorithm will be selected. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +\fBGNUTLS_E_ASN1_VALUE_NOT_FOUND\fP is returned if you didn't set all +information in the certificate request (e.g., the version using +\fBgnutls_x509_crq_set_version()\fP). +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crq_verify.3 b/doc/manpages/gnutls_x509_crq_verify.3 new file mode 100644 index 0000000..eb0c4a7 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_verify.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_verify" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_verify \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crq_verify(gnutls_x509_crq_t " crq ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +is the crq to be verified +.IP "unsigned int flags" 12 +Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations. +.SH "DESCRIPTION" +This function will verify self signature in the certificate +request and return its status. +.SH "RETURNS" +In case of a verification failure \fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP +is returned, and zero or positive code on success. + +Since 2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_check_email.3 b/doc/manpages/gnutls_x509_crt_check_email.3 new file mode 100644 index 0000000..01e6eda --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_check_email.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_check_email" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_email \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_crt_check_email(gnutls_x509_crt_t " cert ", const char * " email ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain an gnutls_x509_crt_t type +.IP "const char * email" 12 +A null terminated string that contains an email address (RFC822) +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will check if the given certificate's subject matches +the given email address. +.SH "RETURNS" +non\-zero for a successful match, and zero on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_check_hostname.3 b/doc/manpages/gnutls_x509_crt_check_hostname.3 new file mode 100644 index 0000000..e8c35bd --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_check_hostname.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_check_hostname" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_hostname \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_crt_check_hostname(gnutls_x509_crt_t " cert ", const char * " hostname ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain an gnutls_x509_crt_t type +.IP "const char * hostname" 12 +A null terminated string that contains a DNS name +.SH "DESCRIPTION" +This function will check if the given certificate's subject matches +the given hostname. This is a basic implementation of the matching +described in RFC6125, and takes into account wildcards, +and the DNSName/IPAddress subject alternative name PKIX extension. + +For details see also \fBgnutls_x509_crt_check_hostname2()\fP. +.SH "RETURNS" +non\-zero for a successful match, and zero on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_check_hostname2.3 b/doc/manpages/gnutls_x509_crt_check_hostname2.3 new file mode 100644 index 0000000..b15b39a --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_check_hostname2.3 @@ -0,0 +1,62 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_check_hostname2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_hostname2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_crt_check_hostname2(gnutls_x509_crt_t " cert ", const char * " hostname ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain an gnutls_x509_crt_t type +.IP "const char * hostname" 12 +A null terminated string that contains a DNS name +.IP "unsigned int flags" 12 +gnutls_certificate_verify_flags +.SH "DESCRIPTION" +This function will check if the given certificate's subject matches +the given hostname. This is a basic implementation of the matching +described in RFC6125, and takes into account wildcards, +and the DNSName/IPAddress subject alternative name PKIX extension. + +IPv4 addresses are accepted by this function in the dotted\-decimal +format (e.g, ddd.ddd.ddd.ddd), and IPv6 addresses in the hexadecimal +x:x:x:x:x:x:x:x format. For them the IPAddress subject alternative +name extension is consulted. Previous versions to 3.6.0 of GnuTLS +in case of a non\-match would consult (in a non\-standard extension) +the DNSname and CN fields. This is no longer the case. + +When the flag \fBGNUTLS_VERIFY_DO_NOT_ALLOW_WILDCARDS\fP is specified no +wildcards are considered. Otherwise they are only considered if the +domain name consists of three components or more, and the wildcard +starts at the leftmost position. +When the flag \fBGNUTLS_VERIFY_DO_NOT_ALLOW_IP_MATCHES\fP is specified, +the input will be treated as a DNS name, and matching of textual IP addresses +against the IPAddress part of the alternative name will not be allowed. + +The function \fBgnutls_x509_crt_check_ip()\fP is available for matching +IP addresses. +.SH "RETURNS" +non\-zero for a successful match, and zero on failure. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_check_ip.3 b/doc/manpages/gnutls_x509_crt_check_ip.3 new file mode 100644 index 0000000..6bd7740 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_check_ip.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_check_ip" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_ip \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_crt_check_ip(gnutls_x509_crt_t " cert ", const unsigned char * " ip ", unsigned int " ip_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain an gnutls_x509_crt_t type +.IP "const unsigned char * ip" 12 +A pointer to the raw IP address +.IP "unsigned int ip_size" 12 +the number of bytes in ip (4 or 16) +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will check if the IP allowed IP addresses in +the certificate's subject alternative name match the provided +IP address. +.SH "RETURNS" +non\-zero for a successful match, and zero on failure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_check_issuer.3 b/doc/manpages/gnutls_x509_crt_check_issuer.3 new file mode 100644 index 0000000..89dba0c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_check_issuer.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_check_issuer" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_issuer \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_crt_check_issuer(gnutls_x509_crt_t " cert ", gnutls_x509_crt_t " issuer ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +is the certificate to be checked +.IP "gnutls_x509_crt_t issuer" 12 +is the certificate of a possible issuer +.SH "DESCRIPTION" +This function will check if the given certificate was issued by the +given issuer. It checks the DN fields and the authority +key identifier and subject key identifier fields match. + +If the same certificate is provided at the \fIcert\fP and \fIissuer\fP fields, +it will check whether the certificate is self\-signed. +.SH "RETURNS" +It will return true (1) if the given certificate is issued +by the given issuer, and false (0) if not. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_check_key_purpose.3 b/doc/manpages/gnutls_x509_crt_check_key_purpose.3 new file mode 100644 index 0000000..486cb33 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_check_key_purpose.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_check_key_purpose" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_key_purpose \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_crt_check_key_purpose(gnutls_x509_crt_t " cert ", const char * " purpose ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "const char * purpose" 12 +a key purpose OID (e.g., \fBGNUTLS_KP_CODE_SIGNING\fP) +.IP "unsigned flags" 12 +zero or \fBGNUTLS_KP_FLAG_DISALLOW_ANY\fP +.SH "DESCRIPTION" +This function will check whether the given certificate matches +the provided key purpose. If \fIflags\fP contains \fBGNUTLS_KP_FLAG_ALLOW_ANY\fP then +it a certificate marked for any purpose will not match. +.SH "RETURNS" +zero if the key purpose doesn't match, and non\-zero otherwise. +.SH "SINCE" +3.5.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_check_revocation.3 b/doc/manpages/gnutls_x509_crt_check_revocation.3 new file mode 100644 index 0000000..19aa2b1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_check_revocation.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_check_revocation" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_revocation \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_check_revocation(gnutls_x509_crt_t " cert ", const gnutls_x509_crl_t * " crl_list ", unsigned " crl_list_length ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "const gnutls_x509_crl_t * crl_list" 12 +should contain a list of gnutls_x509_crl_t types +.IP "unsigned crl_list_length" 12 +the length of the crl_list +.SH "DESCRIPTION" +This function will check if the given certificate is +revoked. It is assumed that the CRLs have been verified before. +.SH "RETURNS" +0 if the certificate is NOT revoked, and 1 if it is. A +negative error code is returned on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_cpy_crl_dist_points.3 b/doc/manpages/gnutls_x509_crt_cpy_crl_dist_points.3 new file mode 100644 index 0000000..2fd4896 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_cpy_crl_dist_points.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_cpy_crl_dist_points" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_cpy_crl_dist_points \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_cpy_crl_dist_points(gnutls_x509_crt_t " dst ", gnutls_x509_crt_t " src ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t dst" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_crt_t src" 12 +the certificate where the dist points will be copied from +.SH "DESCRIPTION" +This function will copy the CRL distribution points certificate +extension, from the source to the destination certificate. +This may be useful to copy from a CA certificate to issued ones. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_deinit.3 b/doc/manpages/gnutls_x509_crt_deinit.3 new file mode 100644 index 0000000..6eb355c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_crt_deinit(gnutls_x509_crt_t " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +The data to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a certificate structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_equals.3 b/doc/manpages/gnutls_x509_crt_equals.3 new file mode 100644 index 0000000..c3ccbe9 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_equals.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_equals" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_equals \- This function compares two gnutls_x509_crt_t certificates +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_crt_equals(gnutls_x509_crt_t " cert1 ", gnutls_x509_crt_t " cert2 ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert1" 12 +The first certificate +.IP "gnutls_x509_crt_t cert2" 12 +The second certificate +.SH "DESCRIPTION" +This function will compare two X.509 certificate structures. +.SH "RETURNS" +On equality non\-zero is returned, otherwise zero. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_equals2.3 b/doc/manpages/gnutls_x509_crt_equals2.3 new file mode 100644 index 0000000..fda913c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_equals2.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_equals2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_equals2 \- This function compares a gnutls_x509_crt_t cert with DER data +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_crt_equals2(gnutls_x509_crt_t " cert1 ", const gnutls_datum_t * " der ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert1" 12 +The first certificate +.IP "const gnutls_datum_t * der" 12 +A DER encoded certificate +.SH "DESCRIPTION" +This function will compare an X.509 certificate structures, with DER +encoded certificate data. +.SH "RETURNS" +On equality non\-zero is returned, otherwise zero. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_export.3 b/doc/manpages/gnutls_x509_crt_export.3 new file mode 100644 index 0000000..dc1bc40 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_export.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_export \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_export(gnutls_x509_crt_t " cert ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +Holds the certificate +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "void * output_data" 12 +will contain a certificate PEM or DER encoded +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the certificate to DER or PEM format. + +If the buffer provided is not long enough to hold the output, then +*output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will +be returned. + +If the structure is PEM encoded, it will have a header +of "BEGIN CERTIFICATE". +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_export2.3 b/doc/manpages/gnutls_x509_crt_export2.3 new file mode 100644 index 0000000..bca7cf8 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_export2.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_export2(gnutls_x509_crt_t " cert ", gnutls_x509_crt_fmt_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +Holds the certificate +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "gnutls_datum_t * out" 12 +will contain a certificate PEM or DER encoded +.SH "DESCRIPTION" +This function will export the certificate to DER or PEM format. +The output buffer is allocated using \fBgnutls_malloc()\fP. + +If the structure is PEM encoded, it will have a header +of "BEGIN CERTIFICATE". +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_activation_time.3 b/doc/manpages/gnutls_x509_crt_get_activation_time.3 new file mode 100644 index 0000000..9813b5c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_activation_time.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_activation_time" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_activation_time \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "time_t gnutls_x509_crt_get_activation_time(gnutls_x509_crt_t " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.SH "DESCRIPTION" +This function will return the time this Certificate was or will be +activated. +.SH "RETURNS" +activation time, or (time_t)\-1 on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_authority_info_access.3 b/doc/manpages/gnutls_x509_crt_get_authority_info_access.3 new file mode 100644 index 0000000..bcd42fa --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_authority_info_access.3 @@ -0,0 +1,97 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_authority_info_access" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_authority_info_access \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_authority_info_access(gnutls_x509_crt_t " crt ", unsigned int " seq ", int " what ", gnutls_datum_t * " data ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "unsigned int seq" 12 +specifies the sequence number of the access descriptor (0 for the first one, 1 for the second etc.) +.IP "int what" 12 +what data to get, a \fBgnutls_info_access_what_t\fP type. +.IP "gnutls_datum_t * data" 12 +output data to be freed with \fBgnutls_free()\fP. +.IP "unsigned int * critical" 12 +pointer to output integer that is set to non\-zero if the extension is marked as critical (may be \fBNULL\fP) +.SH "DESCRIPTION" +Note that a simpler API to access the authority info data is provided +by \fBgnutls_x509_aia_get()\fP and \fBgnutls_x509_ext_import_aia()\fP. + +This function extracts the Authority Information Access (AIA) +extension, see RFC 5280 section 4.2.2.1 for more information. The +AIA extension holds a sequence of AccessDescription (AD) data. + +The \fIseq\fP input parameter is used to indicate which member of the +sequence the caller is interested in. The first member is 0, the +second member 1 and so on. When the \fIseq\fP value is out of bounds, +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. + +The type of data returned in \fIdata\fP is specified via \fIwhat\fP which +should be \fBgnutls_info_access_what_t\fP values. + +If \fIwhat\fP is \fBGNUTLS_IA_ACCESSMETHOD_OID\fP then \fIdata\fP will hold the +accessMethod OID (e.g., "1.3.6.1.5.5.7.48.1"). + +If \fIwhat\fP is \fBGNUTLS_IA_ACCESSLOCATION_GENERALNAME_TYPE\fP, \fIdata\fP will +hold the accessLocation GeneralName type (e.g., +"uniformResourceIdentifier"). + +If \fIwhat\fP is \fBGNUTLS_IA_URI\fP, \fIdata\fP will hold the accessLocation URI +data. Requesting this \fIwhat\fP value leads to an error if the +accessLocation is not of the "uniformResourceIdentifier" type. + +If \fIwhat\fP is \fBGNUTLS_IA_OCSP_URI\fP, \fIdata\fP will hold the OCSP URI. +Requesting this \fIwhat\fP value leads to an error if the accessMethod +is not 1.3.6.1.5.5.7.48.1 aka OCSP, or if accessLocation is not of +the "uniformResourceIdentifier" type. In that case \fBGNUTLS_E_UNKNOWN_ALGORITHM\fP +will be returned, and \fIseq\fP should be increased and this function +called again. + +If \fIwhat\fP is \fBGNUTLS_IA_CAISSUERS_URI\fP, \fIdata\fP will hold the caIssuers +URI. Requesting this \fIwhat\fP value leads to an error if the +accessMethod is not 1.3.6.1.5.5.7.48.2 aka caIssuers, or if +accessLocation is not of the "uniformResourceIdentifier" type. +In that case handle as in \fBGNUTLS_IA_OCSP_URI\fP. + +More \fIwhat\fP values may be allocated in the future as needed. + +If \fIdata\fP is NULL, the function does the same without storing the +output data, that is, it will set \fIcritical\fP and do error checking +as usual. + +The value of the critical flag is returned in * \fIcritical\fP . Supply a +NULL \fIcritical\fP if you want the function to make sure the extension +is non\-critical, as required by RFC 5280. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, \fBGNUTLS_E_INVALID_REQUEST\fP on +invalid \fIcrt\fP , \fBGNUTLS_E_CONSTRAINT_ERROR\fP if the extension is +incorrectly marked as critical (use a non\-NULL \fIcritical\fP to +override), \fBGNUTLS_E_UNKNOWN_ALGORITHM\fP if the requested OID does +not match (e.g., when using \fBGNUTLS_IA_OCSP_URI\fP), otherwise a +negative error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_authority_key_gn_serial.3 b/doc/manpages/gnutls_x509_crt_get_authority_key_gn_serial.3 new file mode 100644 index 0000000..532eaec --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_authority_key_gn_serial.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_authority_key_gn_serial" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_authority_key_gn_serial \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_authority_key_gn_serial(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " alt ", size_t * " alt_size ", unsigned int * " alt_type ", void * " serial ", size_t * " serial_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) +.IP "void * alt" 12 +is the place where the alternative name will be copied to +.IP "size_t * alt_size" 12 +holds the size of alt. +.IP "unsigned int * alt_type" 12 +holds the type of the alternative name (one of gnutls_x509_subject_alt_name_t). +.IP "void * serial" 12 +buffer to store the serial number (may be null) +.IP "size_t * serial_size" 12 +Holds the size of the serial field (may be null) +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical (may be null) +.SH "DESCRIPTION" +This function will return the X.509 authority key +identifier when stored as a general name (authorityCertIssuer) +and serial number. + +Because more than one general names might be stored + \fIseq\fP can be used as a counter to request them all until +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_authority_key_id.3 b/doc/manpages/gnutls_x509_crt_get_authority_key_id.3 new file mode 100644 index 0000000..1d966de --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_authority_key_id.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_authority_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_authority_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_authority_key_id(gnutls_x509_crt_t " cert ", void * " id ", size_t * " id_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "void * id" 12 +The place where the identifier will be copied +.IP "size_t * id_size" 12 +Holds the size of the id field. +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical (may be null) +.SH "DESCRIPTION" +This function will return the X.509v3 certificate authority's key +identifier. This is obtained by the X.509 Authority Key +identifier extension field (2.5.29.35). Note that this function +only returns the keyIdentifier field of the extension and +\fBGNUTLS_E_X509_UNSUPPORTED_EXTENSION\fP, if the extension contains +the name and serial number of the certificate. In that case +\fBgnutls_x509_crt_get_authority_key_gn_serial()\fP may be used. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_basic_constraints.3 b/doc/manpages/gnutls_x509_crt_get_basic_constraints.3 new file mode 100644 index 0000000..b56860d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_basic_constraints.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_basic_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_basic_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_basic_constraints(gnutls_x509_crt_t " cert ", unsigned int * " critical ", unsigned int * " ca ", int * " pathlen ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.IP "unsigned int * ca" 12 +pointer to output integer indicating CA status, may be NULL, +value is 1 if the certificate CA flag is set, 0 otherwise. +.IP "int * pathlen" 12 +pointer to output integer indicating path length (may be +NULL), non\-negative error codes indicate a present pathLenConstraint +field and the actual value, \-1 indicate that the field is absent. +.SH "DESCRIPTION" +This function will read the certificate's basic constraints, and +return the certificates CA status. It reads the basicConstraints +X.509 extension (2.5.29.19). +.SH "RETURNS" +If the certificate is a CA a positive value will be +returned, or (0) if the certificate does not have CA flag set. A +negative error code may be returned in case of errors. If the +certificate does not contain the basicConstraints extension +GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_ca_status.3 b/doc/manpages/gnutls_x509_crt_get_ca_status.3 new file mode 100644 index 0000000..0f0db9e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_ca_status.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_ca_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_ca_status \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_ca_status(gnutls_x509_crt_t " cert ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will return certificates CA status, by reading the +basicConstraints X.509 extension (2.5.29.19). If the certificate is +a CA a positive value will be returned, or (0) if the certificate +does not have CA flag set. + +Use \fBgnutls_x509_crt_get_basic_constraints()\fP if you want to read the +pathLenConstraint field too. +.SH "RETURNS" +If the certificate is a CA a positive value will be +returned, or (0) if the certificate does not have CA flag set. A +negative error code may be returned in case of errors. If the +certificate does not contain the basicConstraints extension +GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_crl_dist_points.3 b/doc/manpages/gnutls_x509_crt_get_crl_dist_points.3 new file mode 100644 index 0000000..7d324cd --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_crl_dist_points.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_crl_dist_points" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_crl_dist_points \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_crl_dist_points(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " san ", size_t * " san_size ", unsigned int * " reason_flags ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the distribution point (0 for the first one, 1 for the second etc.) +.IP "void * san" 12 +is the place where the distribution point will be copied to +.IP "size_t * san_size" 12 +holds the size of ret. +.IP "unsigned int * reason_flags" 12 +Revocation reasons. An ORed sequence of flags from \fBgnutls_x509_crl_reason_flags_t\fP. +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical (may be null) +.SH "DESCRIPTION" +This function retrieves the CRL distribution points (2.5.29.31), +contained in the given certificate in the X509v3 Certificate +Extensions. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP and updates \fIret_size\fP if + \fIret_size\fP is not enough to hold the distribution point, or the +type of the distribution point if everything was ok. The type is +one of the enumerated \fBgnutls_x509_subject_alt_name_t\fP. If the +certificate does not have an Alternative name with the specified +sequence number then \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is +returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_dn.3 b/doc/manpages/gnutls_x509_crt_get_dn.3 new file mode 100644 index 0000000..b1c709f --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_dn.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_dn(gnutls_x509_crt_t " cert ", char * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "char * buf" 12 +a pointer to a structure to hold the name (may be null) +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will copy the name of the Certificate in the provided +buffer. The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +The \fIbuf\fP returned will be null terminated and the \fIbuf_size\fP will account +for the trailing null. If \fIbuf\fP is null then only the size will be filled. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_x509_crt_get_dn3()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is not +long enough, and in that case the \fIbuf_size\fP will be updated +with the required size. \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if +the DN does not exist, or another error value on error. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_dn2.3 b/doc/manpages/gnutls_x509_crt_get_dn2.3 new file mode 100644 index 0000000..326bfc1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_dn2.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_dn2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_dn2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_dn2(gnutls_x509_crt_t " cert ", gnutls_datum_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_datum_t * dn" 12 +a pointer to a structure to hold the name; must be freed using \fBgnutls_free()\fP +.SH "DESCRIPTION" +This function will allocate buffer and copy the name of the Certificate. +The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_x509_crt_get_dn3()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_dn3.3 b/doc/manpages/gnutls_x509_crt_get_dn3.3 new file mode 100644 index 0000000..01f278d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_dn3.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_dn3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_dn3 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_dn3(gnutls_x509_crt_t " cert ", gnutls_datum_t * " dn ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_datum_t * dn" 12 +a pointer to a structure to hold the name; must be freed using \fBgnutls_free()\fP +.IP "unsigned flags" 12 +zero or \fBGNUTLS_X509_DN_FLAG_COMPAT\fP +.SH "DESCRIPTION" +This function will allocate buffer and copy the name of the Certificate. +The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +When the flag \fBGNUTLS_X509_DN_FLAG_COMPAT\fP is specified, the output +format will match the format output by previous to 3.5.6 versions of GnuTLS +which was not not fully RFC4514\-compliant. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_dn_by_oid.3 b/doc/manpages/gnutls_x509_crt_get_dn_by_oid.3 new file mode 100644 index 0000000..0d9436e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_dn_by_oid.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_dn_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_dn_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_dn_by_oid(gnutls_x509_crt_t " cert ", const char * " oid ", unsigned " indx ", unsigned int " raw_flag ", void * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the RDN, this specifies which to send. Use (0) to get the first one. +.IP "unsigned int raw_flag" 12 +If non\-zero returns the raw DER data of the DN part. +.IP "void * buf" 12 +a pointer where the DN part will be copied (may be null). +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will extract the part of the name of the Certificate +subject specified by the given OID. The output, if the raw flag is +not used, will be encoded as described in RFC4514. Thus a string +that is ASCII or UTF\-8 encoded, depending on the certificate data. + +Some helper macros with popular OIDs can be found in gnutls/x509.h +If raw flag is (0), this function will only return known OIDs as +text. Other OIDs will be DER encoded, as described in RFC4514 \-\- +in hex format with a '#' prefix. You can check about known OIDs +using \fBgnutls_x509_dn_oid_known()\fP. + +If \fIbuf\fP is null then only the size will be filled. If the \fIraw_flag\fP is not specified the output is always null terminated, although the + \fIbuf_size\fP will not include the null character. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is not +long enough, and in that case the \fIbuf_size\fP will be updated with +the required size. \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if there +are no data in the current index. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_dn_oid.3 b/doc/manpages/gnutls_x509_crt_get_dn_oid.3 new file mode 100644 index 0000000..fee98a7 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_dn_oid.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_dn_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_dn_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_dn_oid(gnutls_x509_crt_t " cert ", unsigned " indx ", void * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned indx" 12 +This specifies which OID to return. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to a buffer to hold the OID (may be null) +.IP "size_t * oid_size" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will extract the OIDs of the name of the Certificate +subject specified by the given index. + +If \fIoid\fP is null then only the size will be filled. The \fIoid\fP returned will be null terminated, although \fIoid_size\fP will not +account for the trailing null. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is not +long enough, and in that case the \fIbuf_size\fP will be updated with +the required size. \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if there +are no data in the current index. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_expiration_time.3 b/doc/manpages/gnutls_x509_crt_get_expiration_time.3 new file mode 100644 index 0000000..21127d5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_expiration_time.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_expiration_time" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_expiration_time \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "time_t gnutls_x509_crt_get_expiration_time(gnutls_x509_crt_t " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.SH "DESCRIPTION" +This function will return the time this certificate was or will be +expired. +.SH "RETURNS" +expiration time, or (time_t)\-1 on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_extension_by_oid.3 b/doc/manpages/gnutls_x509_crt_get_extension_by_oid.3 new file mode 100644 index 0000000..a5ba6a7 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_extension_by_oid.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_extension_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_extension_by_oid(gnutls_x509_crt_t " cert ", const char * " oid ", unsigned " indx ", void * " buf ", size_t * " buf_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the extensions, this specifies which to send. Use (0) to get the first one. +.IP "void * buf" 12 +a pointer to a structure to hold the name (may be null) +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will return the extension specified by the OID in the +certificate. The extensions will be returned as binary data DER +encoded, in the provided buffer. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. If the certificate does not +contain the specified extension +GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_extension_by_oid2.3 b/doc/manpages/gnutls_x509_crt_get_extension_by_oid2.3 new file mode 100644 index 0000000..ad6cf4c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_extension_by_oid2.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_extension_by_oid2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_by_oid2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_extension_by_oid2(gnutls_x509_crt_t " cert ", const char * " oid ", unsigned " indx ", gnutls_datum_t * " output ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the extensions, this specifies which to send. Use (0) to get the first one. +.IP "gnutls_datum_t * output" 12 +will hold the allocated extension data +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will return the extension specified by the OID in the +certificate. The extensions will be returned as binary data DER +encoded, in the provided buffer. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. If the certificate does not +contain the specified extension +GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE will be returned. +.SH "SINCE" +3.3.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_extension_data.3 b/doc/manpages/gnutls_x509_crt_get_extension_data.3 new file mode 100644 index 0000000..df1e10d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_extension_data.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_extension_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_data \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_extension_data(gnutls_x509_crt_t " cert ", unsigned " indx ", void * " data ", size_t * " sizeof_data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to send. Use (0) to get the first one. +.IP "void * data" 12 +a pointer to a structure to hold the data (may be null) +.IP "size_t * sizeof_data" 12 +initially holds the size of \fIdata\fP +.SH "DESCRIPTION" +This function will return the requested extension data in the +certificate. The extension data will be stored in the +provided buffer. + +Use \fBgnutls_x509_crt_get_extension_info()\fP to extract the OID and +critical flag. Use \fBgnutls_x509_crt_get_extension_by_oid()\fP instead, +if you want to get data indexed by the extension OID rather than +sequence. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. If you have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_extension_data2.3 b/doc/manpages/gnutls_x509_crt_get_extension_data2.3 new file mode 100644 index 0000000..c56c423 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_extension_data2.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_extension_data2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_data2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_extension_data2(gnutls_x509_crt_t " cert ", unsigned " indx ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to read. Use (0) to get the first one. +.IP "gnutls_datum_t * data" 12 +will contain the extension DER\-encoded data +.SH "DESCRIPTION" +This function will return the requested by the index extension data in the +certificate. The extension data will be allocated using +\fBgnutls_malloc()\fP. + +Use \fBgnutls_x509_crt_get_extension_info()\fP to extract the OID. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. If you have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_extension_info.3 b/doc/manpages/gnutls_x509_crt_get_extension_info.3 new file mode 100644 index 0000000..8d743ed --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_extension_info.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_extension_info" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_info \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_extension_info(gnutls_x509_crt_t " cert ", unsigned " indx ", void * " oid ", size_t * " oid_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to send. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to a structure to hold the OID +.IP "size_t * oid_size" 12 +initially holds the maximum size of \fIoid\fP , on return +holds actual size of \fIoid\fP . +.IP "unsigned int * critical" 12 +output variable with critical flag, may be NULL. +.SH "DESCRIPTION" +This function will return the requested extension OID in the +certificate, and the critical flag for it. The extension OID will +be stored as a string in the provided buffer. Use +\fBgnutls_x509_crt_get_extension()\fP to extract the data. + +If the buffer provided is not long enough to hold the output, then + \fIoid_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be +returned. The \fIoid\fP returned will be null terminated, although + \fIoid_size\fP will not account for the trailing null (the latter is not +true for GnuTLS prior to 3.6.0). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. If you have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_extension_oid.3 b/doc/manpages/gnutls_x509_crt_get_extension_oid.3 new file mode 100644 index 0000000..53db347 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_extension_oid.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_extension_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_extension_oid(gnutls_x509_crt_t " cert ", unsigned " indx ", void * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned indx" 12 +Specifies which extension OID to send. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to a structure to hold the OID (may be null) +.IP "size_t * oid_size" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the requested extension OID in the certificate. +The extension OID will be stored as a string in the provided buffer. + +The \fIoid\fP returned will be null terminated, although \fIoid_size\fP will not +account for the trailing null. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. If you have reached the +last extension available \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +will be returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_fingerprint.3 b/doc/manpages/gnutls_x509_crt_get_fingerprint.3 new file mode 100644 index 0000000..ce5c6bc --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_fingerprint.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_fingerprint" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_fingerprint \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_fingerprint(gnutls_x509_crt_t " cert ", gnutls_digest_algorithm_t " algo ", void * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_digest_algorithm_t algo" 12 +is a digest algorithm +.IP "void * buf" 12 +a pointer to a structure to hold the fingerprint (may be null) +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will calculate and copy the certificate's fingerprint +in the provided buffer. The fingerprint is a hash of the DER\-encoded +data of the certificate. + +If the buffer is null then only the size will be filled. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is +not long enough, and in that case the *buf_size will be updated +with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_inhibit_anypolicy.3 b/doc/manpages/gnutls_x509_crt_get_inhibit_anypolicy.3 new file mode 100644 index 0000000..09e87b5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_inhibit_anypolicy.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_inhibit_anypolicy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_inhibit_anypolicy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_inhibit_anypolicy(gnutls_x509_crt_t " cert ", unsigned int * " skipcerts ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int * skipcerts" 12 +will hold the number of certificates after which anypolicy is no longer acceptable. +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will return certificate's value of the SkipCerts, i.e., +the Inhibit anyPolicy X.509 extension (2.5.29.54). + +The returned value is the number of additional certificates that +may appear in the path before the anyPolicy is no longer acceptable. +.SH "RETURNS" +zero on success, or a negative error code in case of +parsing error. If the certificate does not contain the Inhibit anyPolicy +extension \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be +returned. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer.3 b/doc/manpages/gnutls_x509_crt_get_issuer.3 new file mode 100644 index 0000000..83deb2b --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer(gnutls_x509_crt_t " cert ", gnutls_x509_dn_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_x509_dn_t * dn" 12 +output variable with pointer to uint8_t DN +.SH "DESCRIPTION" +Return the Certificate's Issuer DN as a \fBgnutls_x509_dn_t\fP data type, +that can be decoded using \fBgnutls_x509_dn_get_rdn_ava()\fP. + +Note that \fIdn\fP should be treated as constant. Because it points +into the \fIcert\fP object, you should not use \fIdn\fP after \fIcert\fP is +deallocated. +.SH "RETURNS" +Returns 0 on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer_alt_name.3 b/doc/manpages/gnutls_x509_crt_get_issuer_alt_name.3 new file mode 100644 index 0000000..f2d03e5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_alt_name.3 @@ -0,0 +1,64 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_alt_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_alt_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer_alt_name(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ian ", size_t * " ian_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) +.IP "void * ian" 12 +is the place where the alternative name will be copied to +.IP "size_t * ian_size" 12 +holds the size of ian. +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical (may be null) +.SH "DESCRIPTION" +This function retrieves the Issuer Alternative Name (2.5.29.18), +contained in the given certificate in the X509v3 Certificate +Extensions. + +When the SAN type is otherName, it will extract the data in the +otherName's value field, and \fBGNUTLS_SAN_OTHERNAME\fP is returned. +You may use \fBgnutls_x509_crt_get_subject_alt_othername_oid()\fP to get +the corresponding OID and the "virtual" SAN types (e.g., +\fBGNUTLS_SAN_OTHERNAME_XMPP\fP). + +If an otherName OID is known, the data will be decoded. Otherwise +the returned data will be DER encoded, and you will have to decode +it yourself. Currently, only the RFC 3920 id\-on\-xmppAddr Issuer +AltName is recognized. +.SH "RETURNS" +the alternative issuer name type on success, one of the +enumerated \fBgnutls_x509_subject_alt_name_t\fP. It will return +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if \fIian_size\fP is not large enough +to hold the value. In that case \fIian_size\fP will be updated with +the required size. If the certificate does not have an +Alternative name with the specified sequence number then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer_alt_name2.3 b/doc/manpages/gnutls_x509_crt_get_issuer_alt_name2.3 new file mode 100644 index 0000000..1332c8d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_alt_name2.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_alt_name2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_alt_name2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer_alt_name2(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ian ", size_t * " ian_size ", unsigned int * " ian_type ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) +.IP "void * ian" 12 +is the place where the alternative name will be copied to +.IP "size_t * ian_size" 12 +holds the size of ret. +.IP "unsigned int * ian_type" 12 +holds the type of the alternative name (one of gnutls_x509_subject_alt_name_t). +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical (may be null) +.SH "DESCRIPTION" +This function will return the alternative names, contained in the +given certificate. It is the same as +\fBgnutls_x509_crt_get_issuer_alt_name()\fP except for the fact that it +will return the type of the alternative name in \fIian_type\fP even if +the function fails for some reason (i.e. the buffer provided is +not enough). +.SH "RETURNS" +the alternative issuer name type on success, one of the +enumerated \fBgnutls_x509_subject_alt_name_t\fP. It will return +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if \fIian_size\fP is not large enough +to hold the value. In that case \fIian_size\fP will be updated with +the required size. If the certificate does not have an +Alternative name with the specified sequence number then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer_alt_othername_oid.3 b/doc/manpages/gnutls_x509_crt_get_issuer_alt_othername_oid.3 new file mode 100644 index 0000000..d49cdb9 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_alt_othername_oid.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_alt_othername_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_alt_othername_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer_alt_othername_oid(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ret ", size_t * " ret_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) +.IP "void * ret" 12 +is the place where the otherName OID will be copied to +.IP "size_t * ret_size" 12 +holds the size of ret. +.SH "DESCRIPTION" +This function will extract the type OID of an otherName Subject +Alternative Name, contained in the given certificate, and return +the type as an enumerated element. + +If \fIoid\fP is null then only the size will be filled. The \fIoid\fP returned will be null terminated, although \fIoid_size\fP will not +account for the trailing null. + +This function is only useful if +\fBgnutls_x509_crt_get_issuer_alt_name()\fP returned +\fBGNUTLS_SAN_OTHERNAME\fP. +.SH "RETURNS" +the alternative issuer name type on success, one of the +enumerated gnutls_x509_subject_alt_name_t. For supported OIDs, it +will return one of the virtual (GNUTLS_SAN_OTHERNAME_*) types, +e.g. \fBGNUTLS_SAN_OTHERNAME_XMPP\fP, and \fBGNUTLS_SAN_OTHERNAME\fP for +unknown OIDs. It will return \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if + \fIret_size\fP is not large enough to hold the value. In that case + \fIret_size\fP will be updated with the required size. If the +certificate does not have an Alternative name with the specified +sequence number and with the otherName type then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer_dn.3 b/doc/manpages/gnutls_x509_crt_get_issuer_dn.3 new file mode 100644 index 0000000..c10d96a --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_dn.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer_dn(gnutls_x509_crt_t " cert ", char * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "char * buf" 12 +a pointer to a structure to hold the name (may be null) +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will copy the name of the Certificate issuer in the +provided buffer. The name will be in the form +"C=xxxx,O=yyyy,CN=zzzz" as described in RFC4514. The output string +will be ASCII or UTF\-8 encoded, depending on the certificate data. + +If \fIbuf\fP is null then only the size will be filled. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_x509_crt_get_issuer_dn3()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is not +long enough, and in that case the \fIbuf_size\fP will be updated +with the required size. \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if +the DN does not exist, or another error value on error. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer_dn2.3 b/doc/manpages/gnutls_x509_crt_get_issuer_dn2.3 new file mode 100644 index 0000000..75e0bb0 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_dn2.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_dn2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_dn2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer_dn2(gnutls_x509_crt_t " cert ", gnutls_datum_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_datum_t * dn" 12 +a pointer to a structure to hold the name; must be freed using \fBgnutls_free()\fP +.SH "DESCRIPTION" +This function will allocate buffer and copy the name of issuer of the Certificate. +The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_x509_crt_get_issuer_dn3()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer_dn3.3 b/doc/manpages/gnutls_x509_crt_get_issuer_dn3.3 new file mode 100644 index 0000000..2b21ad6 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_dn3.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_dn3" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_dn3 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer_dn3(gnutls_x509_crt_t " cert ", gnutls_datum_t * " dn ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_datum_t * dn" 12 +a pointer to a structure to hold the name; must be freed using \fBgnutls_free()\fP +.IP "unsigned flags" 12 +zero or \fBGNUTLS_X509_DN_FLAG_COMPAT\fP +.SH "DESCRIPTION" +This function will allocate buffer and copy the name of issuer of the Certificate. +The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +When the flag \fBGNUTLS_X509_DN_FLAG_COMPAT\fP is specified, the output +format will match the format output by previous to 3.5.6 versions of GnuTLS +which was not not fully RFC4514\-compliant. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer_dn_by_oid.3 b/doc/manpages/gnutls_x509_crt_get_issuer_dn_by_oid.3 new file mode 100644 index 0000000..da8df5b --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_dn_by_oid.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_dn_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_dn_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer_dn_by_oid(gnutls_x509_crt_t " cert ", const char * " oid ", unsigned " indx ", unsigned int " raw_flag ", void * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the RDN, this specifies which to send. Use (0) to get the first one. +.IP "unsigned int raw_flag" 12 +If non\-zero returns the raw DER data of the DN part. +.IP "void * buf" 12 +a pointer to a structure to hold the name (may be null) +.IP "size_t * buf_size" 12 +initially holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will extract the part of the name of the Certificate +issuer specified by the given OID. The output, if the raw flag is not +used, will be encoded as described in RFC4514. Thus a string that is +ASCII or UTF\-8 encoded, depending on the certificate data. + +Some helper macros with popular OIDs can be found in gnutls/x509.h +If raw flag is (0), this function will only return known OIDs as +text. Other OIDs will be DER encoded, as described in RFC4514 \-\- +in hex format with a '#' prefix. You can check about known OIDs +using \fBgnutls_x509_dn_oid_known()\fP. + +If \fIbuf\fP is null then only the size will be filled. If the \fIraw_flag\fP is not specified the output is always null terminated, although the + \fIbuf_size\fP will not include the null character. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is not +long enough, and in that case the \fIbuf_size\fP will be updated with +the required size. \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if there +are no data in the current index. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer_dn_oid.3 b/doc/manpages/gnutls_x509_crt_get_issuer_dn_oid.3 new file mode 100644 index 0000000..f670a55 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_dn_oid.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_dn_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_dn_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer_dn_oid(gnutls_x509_crt_t " cert ", unsigned " indx ", void * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned indx" 12 +This specifies which OID to return. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to a buffer to hold the OID (may be null) +.IP "size_t * oid_size" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will extract the OIDs of the name of the Certificate +issuer specified by the given index. + +If \fIoid\fP is null then only the size will be filled. The \fIoid\fP returned will be null terminated, although \fIoid_size\fP will not +account for the trailing null. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is not +long enough, and in that case the \fIbuf_size\fP will be updated with +the required size. \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if there +are no data in the current index. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_issuer_unique_id.3 b/doc/manpages/gnutls_x509_crt_get_issuer_unique_id.3 new file mode 100644 index 0000000..04ce313 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_unique_id.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_unique_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_unique_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_issuer_unique_id(gnutls_x509_crt_t " crt ", char * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "char * buf" 12 +user allocated memory buffer, will hold the unique id +.IP "size_t * buf_size" 12 +size of user allocated memory buffer (on input), will hold +actual size of the unique ID on return. +.SH "DESCRIPTION" +This function will extract the issuerUniqueID value (if present) for +the given certificate. + +If the user allocated memory buffer is not large enough to hold the +full subjectUniqueID, then a GNUTLS_E_SHORT_MEMORY_BUFFER error will be +returned, and buf_size will be set to the actual length. + +This function had a bug prior to 3.4.8 that prevented the setting +of \fBNULL\fP \fIbuf\fP to discover the \fIbuf_size\fP . To use this function safely +with the older versions the \fIbuf\fP must be a valid buffer that can hold +at least a single byte if \fIbuf_size\fP is zero. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_key_id.3 b/doc/manpages/gnutls_x509_crt_get_key_id.3 new file mode 100644 index 0000000..6e0f1c0 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_key_id.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_key_id(gnutls_x509_crt_t " crt ", unsigned int " flags ", unsigned char * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "unsigned int flags" 12 +should be one of the flags from \fBgnutls_keyid_flags_t\fP +.IP "unsigned char * output_data" 12 +will contain the key ID +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will return a unique ID that depends on the public +key parameters. This ID can be used in checking whether a +certificate corresponds to the given private key. + +If the buffer provided is not long enough to hold the output, then +*output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will +be returned. The output will normally be a SHA\-1 hash output, +which is 20 bytes. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_key_purpose_oid.3 b/doc/manpages/gnutls_x509_crt_get_key_purpose_oid.3 new file mode 100644 index 0000000..f79f976 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_key_purpose_oid.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_key_purpose_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_key_purpose_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_key_purpose_oid(gnutls_x509_crt_t " cert ", unsigned " indx ", void * " oid ", size_t * " oid_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned indx" 12 +This specifies which OID to return. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to a buffer to hold the OID (may be null) +.IP "size_t * oid_size" 12 +initially holds the size of \fIoid\fP +.IP "unsigned int * critical" 12 +output flag to indicate criticality of extension +.SH "DESCRIPTION" +This function will extract the key purpose OIDs of the Certificate +specified by the given index. These are stored in the Extended Key +Usage extension (2.5.29.37) See the GNUTLS_KP_* definitions for +human readable names. + +If \fIoid\fP is null then only the size will be filled. The \fIoid\fP returned will be null terminated, although \fIoid_size\fP will not +account for the trailing null. +.SH "RETURNS" +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the provided buffer is +not long enough, and in that case the *oid_size will be updated +with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_key_usage.3 b/doc/manpages/gnutls_x509_crt_get_key_usage.3 new file mode 100644 index 0000000..7bb5ffc --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_key_usage.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_key_usage" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_key_usage \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_key_usage(gnutls_x509_crt_t " cert ", unsigned int * " key_usage ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int * key_usage" 12 +where the key usage bits will be stored +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will return certificate's key usage, by reading the +keyUsage X.509 extension (2.5.29.15). The key usage value will ORed +values of the: \fBGNUTLS_KEY_DIGITAL_SIGNATURE\fP, +\fBGNUTLS_KEY_NON_REPUDIATION\fP, \fBGNUTLS_KEY_KEY_ENCIPHERMENT\fP, +\fBGNUTLS_KEY_DATA_ENCIPHERMENT\fP, \fBGNUTLS_KEY_KEY_AGREEMENT\fP, +\fBGNUTLS_KEY_KEY_CERT_SIGN\fP, \fBGNUTLS_KEY_CRL_SIGN\fP, +\fBGNUTLS_KEY_ENCIPHER_ONLY\fP, \fBGNUTLS_KEY_DECIPHER_ONLY\fP. +.SH "RETURNS" +zero on success, or a negative error code in case of +parsing error. If the certificate does not contain the keyUsage +extension \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be +returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_name_constraints.3 b/doc/manpages/gnutls_x509_crt_get_name_constraints.3 new file mode 100644 index 0000000..f21c1b4 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_name_constraints.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_name_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_name_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_name_constraints(gnutls_x509_crt_t " crt ", gnutls_x509_name_constraints_t " nc ", unsigned int " flags ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_x509_name_constraints_t nc" 12 +The nameconstraints intermediate type +.IP "unsigned int flags" 12 +zero or \fBGNUTLS_EXT_FLAG_APPEND\fP +.IP "unsigned int * critical" 12 +the extension status +.SH "DESCRIPTION" +This function will return an intermediate type containing +the name constraints of the provided CA certificate. That +structure can be used in combination with \fBgnutls_x509_name_constraints_check()\fP +to verify whether a server's name is in accordance with the constraints. + +When the \fIflags\fP is set to \fBGNUTLS_EXT_FLAG_APPEND\fP, +then if the \fInc\fP structure is empty this function will behave +identically as if the flag was not set. +Otherwise if there are elements in the \fInc\fP structure then the +constraints will be merged with the existing constraints following +RFC5280 p6.1.4 (excluded constraints will be appended, permitted +will be intersected). + +Note that \fInc\fP must be initialized prior to calling this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_pk_algorithm.3 b/doc/manpages/gnutls_x509_crt_get_pk_algorithm.3 new file mode 100644 index 0000000..700e319 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_pk_algorithm.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_pk_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_pk_algorithm(gnutls_x509_crt_t " cert ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int * bits" 12 +if bits is non null it will hold the size of the parameters' in bits +.SH "DESCRIPTION" +This function will return the public key algorithm of an X.509 +certificate. + +If bits is non null, it should have enough size to hold the parameters +size in bits. For RSA the bits returned is the modulus. +For DSA the bits returned are of the public +exponent. + +Unknown/unsupported algorithms are mapped to \fBGNUTLS_PK_UNKNOWN\fP. +.SH "RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_pk_dsa_raw.3 b/doc/manpages/gnutls_x509_crt_get_pk_dsa_raw.3 new file mode 100644 index 0000000..79be7b0 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_pk_dsa_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_pk_dsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_pk_dsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_pk_dsa_raw(gnutls_x509_crt_t " crt ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "gnutls_datum_t * p" 12 +will hold the p +.IP "gnutls_datum_t * q" 12 +will hold the q +.IP "gnutls_datum_t * g" 12 +will hold the g +.IP "gnutls_datum_t * y" 12 +will hold the y +.SH "DESCRIPTION" +This function will export the DSA public key's parameters found in +the given certificate. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_pk_ecc_raw.3 b/doc/manpages/gnutls_x509_crt_get_pk_ecc_raw.3 new file mode 100644 index 0000000..a9fb6d5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_pk_ecc_raw.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_pk_ecc_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_pk_ecc_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_pk_ecc_raw(gnutls_x509_crt_t " crt ", gnutls_ecc_curve_t * " curve ", gnutls_datum_t * " x ", gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve +.IP "gnutls_datum_t * x" 12 +will hold the x\-coordinate +.IP "gnutls_datum_t * y" 12 +will hold the y\-coordinate +.SH "DESCRIPTION" +This function will export the ECC public key's parameters found in +the given certificate. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +In EdDSA curves the \fIy\fP parameter will be \fBNULL\fP and the other parameters +will be in the native format for the curve. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.4.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_pk_gost_raw.3 b/doc/manpages/gnutls_x509_crt_get_pk_gost_raw.3 new file mode 100644 index 0000000..3f7287d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_pk_gost_raw.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_pk_gost_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_pk_gost_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_pk_gost_raw(gnutls_x509_crt_t " crt ", gnutls_ecc_curve_t * " curve ", gnutls_digest_algorithm_t * " digest ", gnutls_gost_paramset_t * " paramset ", gnutls_datum_t * " x ", gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve +.IP "gnutls_digest_algorithm_t * digest" 12 +will hold the digest +.IP "gnutls_gost_paramset_t * paramset" 12 +will hold the GOST parameter set ID +.IP "gnutls_datum_t * x" 12 +will hold the x\-coordinate +.IP "gnutls_datum_t * y" 12 +will hold the y\-coordinate +.SH "DESCRIPTION" +This function will export the GOST public key's parameters found in +the given certificate. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_pk_oid.3 b/doc/manpages/gnutls_x509_crt_get_pk_oid.3 new file mode 100644 index 0000000..8ef2e62 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_pk_oid.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_pk_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_pk_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_pk_oid(gnutls_x509_crt_t " cert ", char * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "char * oid" 12 +a pointer to a buffer to hold the OID (may be null) +.IP "size_t * oid_size" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the OID of the public key algorithm +on that certificate. This is function +is useful in the case \fBgnutls_x509_crt_get_pk_algorithm()\fP +returned \fBGNUTLS_PK_UNKNOWN\fP. +.SH "RETURNS" +zero or a negative error code on error. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_pk_rsa_raw.3 b/doc/manpages/gnutls_x509_crt_get_pk_rsa_raw.3 new file mode 100644 index 0000000..2c532fa --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_pk_rsa_raw.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_pk_rsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_pk_rsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_pk_rsa_raw(gnutls_x509_crt_t " crt ", gnutls_datum_t * " m ", gnutls_datum_t * " e ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "gnutls_datum_t * m" 12 +will hold the modulus +.IP "gnutls_datum_t * e" 12 +will hold the public exponent +.SH "DESCRIPTION" +This function will export the RSA public key's parameters found in +the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_policy.3 b/doc/manpages/gnutls_x509_crt_get_policy.3 new file mode 100644 index 0000000..4027610 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_policy.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_policy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_policy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_policy(gnutls_x509_crt_t " crt ", unsigned " indx ", struct gnutls_x509_policy_st * " policy ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned indx" 12 +This specifies which policy to return. Use (0) to get the first one. +.IP "struct gnutls_x509_policy_st * policy" 12 +A pointer to a policy structure. +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will extract the certificate policy (extension 2.5.29.32) +specified by the given index. + +The policy returned by this function must be deinitialized by using +\fBgnutls_x509_policy_release()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "SINCE" +3.1.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_preferred_hash_algorithm.3 b/doc/manpages/gnutls_x509_crt_get_preferred_hash_algorithm.3 new file mode 100644 index 0000000..3779cef --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_preferred_hash_algorithm.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_preferred_hash_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_preferred_hash_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/compat.h> +.sp +.BI "int gnutls_x509_crt_get_preferred_hash_algorithm(gnutls_x509_crt_t " crt ", gnutls_digest_algorithm_t * " hash ", unsigned int * " mand ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "gnutls_digest_algorithm_t * hash" 12 +The result of the call with the hash algorithm used for signature +.IP "unsigned int * mand" 12 +If non\-zero it means that the algorithm MUST use this hash. May be \fBNULL\fP. +.SH "DESCRIPTION" +This function will read the certificate and return the appropriate digest +algorithm to use for signing with this certificate. Some certificates (i.e. +DSA might not be able to sign without the preferred algorithm). +.SH "DEPRECATED" +Please use \fBgnutls_pubkey_get_preferred_hash_algorithm()\fP. +.SH "RETURNS" +the 0 if the hash algorithm is found. A negative error code is +returned on error. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_private_key_usage_period.3 b/doc/manpages/gnutls_x509_crt_get_private_key_usage_period.3 new file mode 100644 index 0000000..d931c86 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_private_key_usage_period.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_private_key_usage_period" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_private_key_usage_period \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_private_key_usage_period(gnutls_x509_crt_t " cert ", time_t * " activation ", time_t * " expiration ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "time_t * activation" 12 +The activation time +.IP "time_t * expiration" 12 +The expiration time +.IP "unsigned int * critical" 12 +the extension status +.SH "DESCRIPTION" +This function will return the expiration and activation +times of the private key of the certificate. It relies on +the PKIX extension 2.5.29.16 being present. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_proxy.3 b/doc/manpages/gnutls_x509_crt_get_proxy.3 new file mode 100644 index 0000000..b9b0d35 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_proxy.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_proxy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_proxy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_proxy(gnutls_x509_crt_t " cert ", unsigned int * " critical ", int * " pathlen ", char ** " policyLanguage ", char ** " policy ", size_t * " sizeof_policy ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical +.IP "int * pathlen" 12 +pointer to output integer indicating path length (may be +NULL), non\-negative error codes indicate a present pCPathLenConstraint +field and the actual value, \-1 indicate that the field is absent. +.IP "char ** policyLanguage" 12 +output variable with OID of policy language +.IP "char ** policy" 12 +output variable with policy data +.IP "size_t * sizeof_policy" 12 +output variable size of policy data +.SH "DESCRIPTION" +This function will get information from a proxy certificate. It +reads the ProxyCertInfo X.509 extension (1.3.6.1.5.5.7.1.14). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_raw_dn.3 b/doc/manpages/gnutls_x509_crt_get_raw_dn.3 new file mode 100644 index 0000000..c296d36 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_raw_dn.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_raw_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_raw_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_raw_dn(gnutls_x509_crt_t " cert ", gnutls_datum_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_datum_t * dn" 12 +will hold the starting point of the DN +.SH "DESCRIPTION" +This function will return a pointer to the DER encoded DN structure and +the length. This points to allocated data that must be free'd using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_raw_issuer_dn.3 b/doc/manpages/gnutls_x509_crt_get_raw_issuer_dn.3 new file mode 100644 index 0000000..4b9de4c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_raw_issuer_dn.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_raw_issuer_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_raw_issuer_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_raw_issuer_dn(gnutls_x509_crt_t " cert ", gnutls_datum_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_datum_t * dn" 12 +will hold the starting point of the DN +.SH "DESCRIPTION" +This function will return a pointer to the DER encoded DN structure +and the length. This points to allocated data that must be free'd using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value.or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_serial.3 b/doc/manpages/gnutls_x509_crt_get_serial.3 new file mode 100644 index 0000000..531a48b --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_serial.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_serial" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_serial \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_serial(gnutls_x509_crt_t " cert ", void * " result ", size_t * " result_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "void * result" 12 +The place where the serial number will be copied +.IP "size_t * result_size" 12 +Holds the size of the result field. +.SH "DESCRIPTION" +This function will return the X.509 certificate's serial number. +This is obtained by the X509 Certificate serialNumber field. Serial +is not always a 32 or 64bit number. Some CAs use large serial +numbers, thus it may be wise to handle it as something uint8_t. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_signature.3 b/doc/manpages/gnutls_x509_crt_get_signature.3 new file mode 100644 index 0000000..79afbdc --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_signature.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_signature" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_signature \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_signature(gnutls_x509_crt_t " cert ", char * " sig ", size_t * " sig_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "char * sig" 12 +a pointer where the signature part will be copied (may be null). +.IP "size_t * sig_size" 12 +initially holds the size of \fIsig\fP +.SH "DESCRIPTION" +This function will extract the signature field of a certificate. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_signature_algorithm.3 b/doc/manpages/gnutls_x509_crt_get_signature_algorithm.3 new file mode 100644 index 0000000..cd8503e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_signature_algorithm.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_signature_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_signature_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_signature_algorithm(gnutls_x509_crt_t " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.SH "DESCRIPTION" +This function will return a value of the \fBgnutls_sign_algorithm_t\fP +enumeration that is the signature algorithm that has been used to +sign this certificate. + +Since 3.6.0 this function never returns a negative error code. +Error cases and unknown/unsupported signature algorithms are +mapped to \fBGNUTLS_SIGN_UNKNOWN\fP. +.SH "RETURNS" +a \fBgnutls_sign_algorithm_t\fP value +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_signature_oid.3 b/doc/manpages/gnutls_x509_crt_get_signature_oid.3 new file mode 100644 index 0000000..fb32082 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_signature_oid.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_signature_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_signature_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_signature_oid(gnutls_x509_crt_t " cert ", char * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "char * oid" 12 +a pointer to a buffer to hold the OID (may be null) +.IP "size_t * oid_size" 12 +initially holds the size of \fIoid\fP +.SH "DESCRIPTION" +This function will return the OID of the signature algorithm +that has been used to sign this certificate. This is function +is useful in the case \fBgnutls_x509_crt_get_signature_algorithm()\fP +returned \fBGNUTLS_SIGN_UNKNOWN\fP. +.SH "RETURNS" +zero or a negative error code on error. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_spki.3 b/doc/manpages/gnutls_x509_crt_get_spki.3 new file mode 100644 index 0000000..6ff35ef --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_spki.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_spki(gnutls_x509_crt_t " cert ", gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_x509_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will return the public key information of an X.509 +certificate. The provided \fIspki\fP must be initialized. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_subject.3 b/doc/manpages/gnutls_x509_crt_get_subject.3 new file mode 100644 index 0000000..b1844f1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_subject(gnutls_x509_crt_t " cert ", gnutls_x509_dn_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_x509_dn_t * dn" 12 +output variable with pointer to uint8_t DN. +.SH "DESCRIPTION" +Return the Certificate's Subject DN as a \fBgnutls_x509_dn_t\fP data type, +that can be decoded using \fBgnutls_x509_dn_get_rdn_ava()\fP. + +Note that \fIdn\fP should be treated as constant. Because it points +into the \fIcert\fP object, you should not use \fIdn\fP after \fIcert\fP is +deallocated. +.SH "RETURNS" +Returns 0 on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_subject_alt_name.3 b/doc/manpages/gnutls_x509_crt_get_subject_alt_name.3 new file mode 100644 index 0000000..cadd204 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject_alt_name.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject_alt_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_alt_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_subject_alt_name(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " san ", size_t * " san_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) +.IP "void * san" 12 +is the place where the alternative name will be copied to +.IP "size_t * san_size" 12 +holds the size of san. +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical (may be null) +.SH "DESCRIPTION" +This function retrieves the Alternative Name (2.5.29.17), contained +in the given certificate in the X509v3 Certificate Extensions. + +When the SAN type is otherName, it will extract the data in the +otherName's value field, and \fBGNUTLS_SAN_OTHERNAME\fP is returned. +You may use \fBgnutls_x509_crt_get_subject_alt_othername_oid()\fP to get +the corresponding OID and the "virtual" SAN types (e.g., +\fBGNUTLS_SAN_OTHERNAME_XMPP\fP). + +If an otherName OID is known, the data will be decoded. Otherwise +the returned data will be DER encoded, and you will have to decode +it yourself. Currently, only the RFC 3920 id\-on\-xmppAddr SAN is +recognized. +.SH "RETURNS" +the alternative subject name type on success, one of the +enumerated \fBgnutls_x509_subject_alt_name_t\fP. It will return +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if \fIsan_size\fP is not large enough to +hold the value. In that case \fIsan_size\fP will be updated with the +required size. If the certificate does not have an Alternative +name with the specified sequence number then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_subject_alt_name2.3 b/doc/manpages/gnutls_x509_crt_get_subject_alt_name2.3 new file mode 100644 index 0000000..1a552cd --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject_alt_name2.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject_alt_name2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_alt_name2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_subject_alt_name2(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " san ", size_t * " san_size ", unsigned int * " san_type ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) +.IP "void * san" 12 +is the place where the alternative name will be copied to +.IP "size_t * san_size" 12 +holds the size of ret. +.IP "unsigned int * san_type" 12 +holds the type of the alternative name (one of gnutls_x509_subject_alt_name_t). +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical (may be null) +.SH "DESCRIPTION" +This function will return the alternative names, contained in the +given certificate. It is the same as +\fBgnutls_x509_crt_get_subject_alt_name()\fP except for the fact that it +will return the type of the alternative name in \fIsan_type\fP even if +the function fails for some reason (i.e. the buffer provided is +not enough). +.SH "RETURNS" +the alternative subject name type on success, one of the +enumerated \fBgnutls_x509_subject_alt_name_t\fP. It will return +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if \fIsan_size\fP is not large enough +to hold the value. In that case \fIsan_size\fP will be updated with +the required size. If the certificate does not have an +Alternative name with the specified sequence number then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_subject_alt_othername_oid.3 b/doc/manpages/gnutls_x509_crt_get_subject_alt_othername_oid.3 new file mode 100644 index 0000000..05011c1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject_alt_othername_oid.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject_alt_othername_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_alt_othername_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_subject_alt_othername_oid(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "unsigned int seq" 12 +specifies the sequence number of the alt name (0 for the first one, 1 for the second etc.) +.IP "void * oid" 12 +is the place where the otherName OID will be copied to +.IP "size_t * oid_size" 12 +holds the size of ret. +.SH "DESCRIPTION" +This function will extract the type OID of an otherName Subject +Alternative Name, contained in the given certificate, and return +the type as an enumerated element. + +This function is only useful if +\fBgnutls_x509_crt_get_subject_alt_name()\fP returned +\fBGNUTLS_SAN_OTHERNAME\fP. + +If \fIoid\fP is null then only the size will be filled. The \fIoid\fP returned will be null terminated, although \fIoid_size\fP will not +account for the trailing null. +.SH "RETURNS" +the alternative subject name type on success, one of the +enumerated gnutls_x509_subject_alt_name_t. For supported OIDs, it +will return one of the virtual (GNUTLS_SAN_OTHERNAME_*) types, +e.g. \fBGNUTLS_SAN_OTHERNAME_XMPP\fP, and \fBGNUTLS_SAN_OTHERNAME\fP for +unknown OIDs. It will return \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if + \fIian_size\fP is not large enough to hold the value. In that case + \fIian_size\fP will be updated with the required size. If the +certificate does not have an Alternative name with the specified +sequence number and with the otherName type then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_subject_key_id.3 b/doc/manpages/gnutls_x509_crt_get_subject_key_id.3 new file mode 100644 index 0000000..f72f77c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject_key_id.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_subject_key_id(gnutls_x509_crt_t " cert ", void * " ret ", size_t * " ret_size ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "void * ret" 12 +The place where the identifier will be copied +.IP "size_t * ret_size" 12 +Holds the size of the result field. +.IP "unsigned int * critical" 12 +will be non\-zero if the extension is marked as critical (may be null) +.SH "DESCRIPTION" +This function will return the X.509v3 certificate's subject key +identifier. This is obtained by the X.509 Subject Key identifier +extension field (2.5.29.14). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_subject_unique_id.3 b/doc/manpages/gnutls_x509_crt_get_subject_unique_id.3 new file mode 100644 index 0000000..c00685b --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject_unique_id.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject_unique_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_unique_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_subject_unique_id(gnutls_x509_crt_t " crt ", char * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "char * buf" 12 +user allocated memory buffer, will hold the unique id +.IP "size_t * buf_size" 12 +size of user allocated memory buffer (on input), will hold +actual size of the unique ID on return. +.SH "DESCRIPTION" +This function will extract the subjectUniqueID value (if present) for +the given certificate. + +If the user allocated memory buffer is not large enough to hold the +full subjectUniqueID, then a GNUTLS_E_SHORT_MEMORY_BUFFER error will be +returned, and buf_size will be set to the actual length. + +This function had a bug prior to 3.4.8 that prevented the setting +of \fBNULL\fP \fIbuf\fP to discover the \fIbuf_size\fP . To use this function safely +with the older versions the \fIbuf\fP must be a valid buffer that can hold +at least a single byte if \fIbuf_size\fP is zero. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_tlsfeatures.3 b/doc/manpages/gnutls_x509_crt_get_tlsfeatures.3 new file mode 100644 index 0000000..0f24088 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_tlsfeatures.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_tlsfeatures" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_tlsfeatures \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_tlsfeatures(gnutls_x509_crt_t " crt ", gnutls_x509_tlsfeatures_t " features ", unsigned int " flags ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +A X.509 certificate +.IP "gnutls_x509_tlsfeatures_t features" 12 +If the function succeeds, the +features will be stored in this variable. +.IP "unsigned int flags" 12 +zero or \fBGNUTLS_EXT_FLAG_APPEND\fP +.IP "unsigned int * critical" 12 +the extension status +.SH "DESCRIPTION" +This function will get the X.509 TLS features +extension structure from the certificate. The +returned structure needs to be freed using +\fBgnutls_x509_tlsfeatures_deinit()\fP. + +When the \fIflags\fP is set to \fBGNUTLS_EXT_FLAG_APPEND\fP, +then if the \fIfeatures\fP structure is empty this function will behave +identically as if the flag was not set. Otherwise if there are elements +in the \fIfeatures\fP structure then they will be merged with. + +Note that \fIfeatures\fP must be initialized prior to calling this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_get_version.3 b/doc/manpages/gnutls_x509_crt_get_version.3 new file mode 100644 index 0000000..bfc8092 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_version.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_version \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_get_version(gnutls_x509_crt_t " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.SH "DESCRIPTION" +This function will return the version of the specified Certificate. +.SH "RETURNS" +version of certificate, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_import.3 b/doc/manpages/gnutls_x509_crt_import.3 new file mode 100644 index 0000000..77c86eb --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_import.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_import \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_import(gnutls_x509_crt_t " cert ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +The data to store the parsed certificate. +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded certificate. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM +.SH "DESCRIPTION" +This function will convert the given DER or PEM encoded Certificate +to the native gnutls_x509_crt_t format. The output will be stored +in \fIcert\fP . + +If the Certificate is PEM encoded it should have a header of "X509 +CERTIFICATE", or "CERTIFICATE". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_import_pkcs11.3 b/doc/manpages/gnutls_x509_crt_import_pkcs11.3 new file mode 100644 index 0000000..11b8cd2 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_import_pkcs11.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_import_pkcs11" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_import_pkcs11 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_x509_crt_import_pkcs11(gnutls_x509_crt_t " crt ", gnutls_pkcs11_obj_t " pkcs11_crt ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +A certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_pkcs11_obj_t pkcs11_crt" 12 +A PKCS 11 object that contains a certificate +.SH "DESCRIPTION" +This function will import a PKCS 11 certificate to a \fBgnutls_x509_crt_t\fP +structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_import_url.3 b/doc/manpages/gnutls_x509_crt_import_url.3 new file mode 100644 index 0000000..8d1b7ec --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_import_url.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_import_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_import_url \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_import_url(gnutls_x509_crt_t " crt ", const char * " url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +A certificate of type \fBgnutls_x509_crt_t\fP +.IP "const char * url" 12 +A PKCS 11 url +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_* flags for PKCS\fB11\fP URLs or zero otherwise +.SH "DESCRIPTION" +This function will import a certificate present in a PKCS\fB11\fP token +or any type of back\-end that supports URLs. + +In previous versions of gnutls this function was named +gnutls_x509_crt_import_pkcs11_url, and the old name is +an alias to this one. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_init.3 b/doc/manpages/gnutls_x509_crt_init.3 new file mode 100644 index 0000000..da04923 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_init.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_init(gnutls_x509_crt_t * " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t * cert" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize an X.509 certificate structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_list_import.3 b/doc/manpages/gnutls_x509_crt_list_import.3 new file mode 100644 index 0000000..5685f6f --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_list_import.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_list_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_list_import \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_list_import(gnutls_x509_crt_t * " certs ", unsigned int * " cert_max ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t * certs" 12 +Indicates where the parsed list will be copied to. Must not be initialized. +.IP "unsigned int * cert_max" 12 +Initially must hold the maximum number of certs. It will be updated with the number of certs available. +.IP "const gnutls_datum_t * data" 12 +The PEM encoded certificate. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM. +.IP "unsigned int flags" 12 +must be (0) or an OR'd sequence of gnutls_certificate_import_flags. +.SH "DESCRIPTION" +This function will convert the given PEM encoded certificate list +to the native gnutls_x509_crt_t format. The output will be stored +in \fIcerts\fP . They will be automatically initialized. + +The flag \fBGNUTLS_X509_CRT_LIST_IMPORT_FAIL_IF_EXCEED\fP will cause +import to fail if the certificates in the provided buffer are more +than the available structures. The \fBGNUTLS_X509_CRT_LIST_FAIL_IF_UNSORTED\fP +flag will cause the function to fail if the provided list is not +sorted from subject to issuer. + +If the Certificate is PEM encoded it should have a header of "X509 +CERTIFICATE", or "CERTIFICATE". +.SH "RETURNS" +the number of certificates read or a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_list_import2.3 b/doc/manpages/gnutls_x509_crt_list_import2.3 new file mode 100644 index 0000000..d6509c3 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_list_import2.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_list_import2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_list_import2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_list_import2(gnutls_x509_crt_t ** " certs ", unsigned int * " size ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t ** certs" 12 +Will hold the parsed certificate list. +.IP "unsigned int * size" 12 +It will contain the size of the list. +.IP "const gnutls_datum_t * data" 12 +The PEM encoded certificate. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM. +.IP "unsigned int flags" 12 +must be (0) or an OR'd sequence of gnutls_certificate_import_flags. +.SH "DESCRIPTION" +This function will convert the given PEM encoded certificate list +to the native gnutls_x509_crt_t format. The output will be stored +in \fIcerts\fP which will be allocated and initialized. + +If the Certificate is PEM encoded it should have a header of "X509 +CERTIFICATE", or "CERTIFICATE". + +To deinitialize \fIcerts\fP , you need to deinitialize each crt structure +independently, and use \fBgnutls_free()\fP at \fIcerts\fP . +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_list_import_pkcs11.3 b/doc/manpages/gnutls_x509_crt_list_import_pkcs11.3 new file mode 100644 index 0000000..b31f19d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_list_import_pkcs11.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_list_import_pkcs11" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_list_import_pkcs11 \- API function +.SH SYNOPSIS +.B #include <gnutls/pkcs11.h> +.sp +.BI "int gnutls_x509_crt_list_import_pkcs11(gnutls_x509_crt_t * " certs ", unsigned int " cert_max ", gnutls_pkcs11_obj_t * const " objs ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t * certs" 12 +A list of certificates of type \fBgnutls_x509_crt_t\fP +.IP "unsigned int cert_max" 12 +The maximum size of the list +.IP "gnutls_pkcs11_obj_t * const objs" 12 +A list of PKCS 11 objects +.IP "unsigned int flags" 12 +0 for now +.SH "DESCRIPTION" +This function will import a PKCS 11 certificate list to a list of +\fBgnutls_x509_crt_t\fP type. These must not be initialized. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_list_import_url.3 b/doc/manpages/gnutls_x509_crt_list_import_url.3 new file mode 100644 index 0000000..1c9758e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_list_import_url.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_list_import_url" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_list_import_url \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_list_import_url(gnutls_x509_crt_t ** " certs ", unsigned int * " size ", const char * " url ", gnutls_pin_callback_t " pin_fn ", void * " pin_fn_userdata ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t ** certs" 12 +Will hold the allocated certificate list. +.IP "unsigned int * size" 12 +It will contain the size of the list. +.IP "const char * url" 12 +A PKCS 11 url +.IP "gnutls_pin_callback_t pin_fn" 12 +a PIN callback if not globally set +.IP "void * pin_fn_userdata" 12 +parameter for the PIN callback +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_* flags for PKCS\fB11\fP URLs or zero otherwise +.SH "DESCRIPTION" +This function will import a certificate chain present in a PKCS\fB11\fP token +or any type of back\-end that supports URLs. The certificates +must be deinitialized afterwards using \fBgnutls_x509_crt_deinit()\fP +and the returned pointer must be freed using \fBgnutls_free()\fP. + +The URI provided must be the first certificate in the chain; subsequent +certificates will be retrieved using \fBgnutls_pkcs11_get_raw_issuer()\fP or +equivalent functionality for the supported URI. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_list_verify.3 b/doc/manpages/gnutls_x509_crt_list_verify.3 new file mode 100644 index 0000000..24c635e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_list_verify.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_list_verify" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_list_verify \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_list_verify(const gnutls_x509_crt_t * " cert_list ", unsigned " cert_list_length ", const gnutls_x509_crt_t * " CA_list ", unsigned " CA_list_length ", const gnutls_x509_crl_t * " CRL_list ", unsigned " CRL_list_length ", unsigned int " flags ", unsigned int * " verify ");" +.SH ARGUMENTS +.IP "const gnutls_x509_crt_t * cert_list" 12 +is the certificate list to be verified +.IP "unsigned cert_list_length" 12 +holds the number of certificate in cert_list +.IP "const gnutls_x509_crt_t * CA_list" 12 +is the CA list which will be used in verification +.IP "unsigned CA_list_length" 12 +holds the number of CA certificate in CA_list +.IP "const gnutls_x509_crl_t * CRL_list" 12 +holds a list of CRLs. +.IP "unsigned CRL_list_length" 12 +the length of CRL list. +.IP "unsigned int flags" 12 +Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations. +.IP "unsigned int * verify" 12 +will hold the certificate verification output. +.SH "DESCRIPTION" + +This function will try to verify the given certificate list and +return its status. The details of the verification are the same +as in \fBgnutls_x509_trust_list_verify_crt2()\fP. + +You must check the peer's name in order to check if the verified +certificate belongs to the actual peer. + +The certificate verification output will be put in \fIverify\fP and will +be one or more of the gnutls_certificate_status_t enumerated +elements bitwise or'd. For a more detailed verification status use +\fBgnutls_x509_crt_verify()\fP per list element. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_print.3 b/doc/manpages/gnutls_x509_crt_print.3 new file mode 100644 index 0000000..4056442 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_print.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_print \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_print(gnutls_x509_crt_t " cert ", gnutls_certificate_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +The data to be printed +.IP "gnutls_certificate_print_formats_t format" 12 +Indicate the format to use +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with null terminated string. +.SH "DESCRIPTION" +This function will pretty print a X.509 certificate, suitable for +display to a human. + +If the format is \fBGNUTLS_CRT_PRINT_FULL\fP then all fields of the +certificate will be output, on multiple lines. The +\fBGNUTLS_CRT_PRINT_ONELINE\fP format will generate one line with some +selected fields, which is useful for logging purposes. + +The output \fIout\fP needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_privkey_sign.3 b/doc/manpages/gnutls_x509_crt_privkey_sign.3 new file mode 100644 index 0000000..1c3409b --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_privkey_sign.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_privkey_sign" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_privkey_sign \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_x509_crt_privkey_sign(gnutls_x509_crt_t " crt ", gnutls_x509_crt_t " issuer ", gnutls_privkey_t " issuer_key ", gnutls_digest_algorithm_t " dig ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_crt_t issuer" 12 +is the certificate of the certificate issuer +.IP "gnutls_privkey_t issuer_key" 12 +holds the issuer's private key +.IP "gnutls_digest_algorithm_t dig" 12 +The message digest to use, \fBGNUTLS_DIG_SHA256\fP is a safe choice +.IP "unsigned int flags" 12 +must be 0 +.SH "DESCRIPTION" +This function will sign the certificate with the issuer's private key, and +will copy the issuer's information into the certificate. + +This must be the last step in a certificate generation since all +the previously set parameters are now signed. + +A known limitation of this function is, that a newly\-signed certificate will not +be fully functional (e.g., for signature verification), until it +is exported an re\-imported. + +After GnuTLS 3.6.1 the value of \fIdig\fP may be \fBGNUTLS_DIG_UNKNOWN\fP, +and in that case, a suitable but reasonable for the key algorithm will be selected. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_activation_time.3 b/doc/manpages/gnutls_x509_crt_set_activation_time.3 new file mode 100644 index 0000000..a9cd021 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_activation_time.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_activation_time" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_activation_time \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_activation_time(gnutls_x509_crt_t " cert ", time_t " act_time ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "time_t act_time" 12 +The actual time +.SH "DESCRIPTION" +This function will set the time this certificate was or will be +activated. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_authority_info_access.3 b/doc/manpages/gnutls_x509_crt_set_authority_info_access.3 new file mode 100644 index 0000000..ebc5a80 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_authority_info_access.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_authority_info_access" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_authority_info_access \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_authority_info_access(gnutls_x509_crt_t " crt ", int " what ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "int what" 12 +what data to get, a \fBgnutls_info_access_what_t\fP type. +.IP "gnutls_datum_t * data" 12 +output data to be freed with \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function sets the Authority Information Access (AIA) +extension, see RFC 5280 section 4.2.2.1 for more information. + +The type of data stored in \fIdata\fP is specified via \fIwhat\fP which +should be \fBgnutls_info_access_what_t\fP values. + +If \fIwhat\fP is \fBGNUTLS_IA_OCSP_URI\fP, \fIdata\fP will hold the OCSP URI. +If \fIwhat\fP is \fBGNUTLS_IA_CAISSUERS_URI\fP, \fIdata\fP will hold the caIssuers +URI. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_authority_key_id.3 b/doc/manpages/gnutls_x509_crt_set_authority_key_id.3 new file mode 100644 index 0000000..5fc8039 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_authority_key_id.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_authority_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_authority_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_authority_key_id(gnutls_x509_crt_t " cert ", const void * " id ", size_t " id_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const void * id" 12 +The key ID +.IP "size_t id_size" 12 +Holds the size of the key ID field. +.SH "DESCRIPTION" +This function will set the X.509 certificate's authority key ID extension. +Only the keyIdentifier field can be set with this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_basic_constraints.3 b/doc/manpages/gnutls_x509_crt_set_basic_constraints.3 new file mode 100644 index 0000000..1933014 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_basic_constraints.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_basic_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_basic_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_basic_constraints(gnutls_x509_crt_t " crt ", unsigned int " ca ", int " pathLenConstraint ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "unsigned int ca" 12 +true(1) or false(0). Depending on the Certificate authority status. +.IP "int pathLenConstraint" 12 +non\-negative error codes indicate maximum length of path, +and negative error codes indicate that the pathLenConstraints field should +not be present. +.SH "DESCRIPTION" +This function will set the basicConstraints certificate extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_ca_status.3 b/doc/manpages/gnutls_x509_crt_set_ca_status.3 new file mode 100644 index 0000000..a4b32eb --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_ca_status.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_ca_status" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_ca_status \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_ca_status(gnutls_x509_crt_t " crt ", unsigned int " ca ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "unsigned int ca" 12 +true(1) or false(0). Depending on the Certificate authority status. +.SH "DESCRIPTION" +This function will set the basicConstraints certificate extension. +Use \fBgnutls_x509_crt_set_basic_constraints()\fP if you want to control +the pathLenConstraint field too. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_crl_dist_points.3 b/doc/manpages/gnutls_x509_crt_set_crl_dist_points.3 new file mode 100644 index 0000000..a469d1b --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_crl_dist_points.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_crl_dist_points" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_crl_dist_points \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_crl_dist_points(gnutls_x509_crt_t " crt ", gnutls_x509_subject_alt_name_t " type ", const void * " data_string ", unsigned int " reason_flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_subject_alt_name_t type" 12 +is one of the gnutls_x509_subject_alt_name_t enumerations +.IP "const void * data_string" 12 +The data to be set +.IP "unsigned int reason_flags" 12 +revocation reasons +.SH "DESCRIPTION" +This function will set the CRL distribution points certificate extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_crl_dist_points2.3 b/doc/manpages/gnutls_x509_crt_set_crl_dist_points2.3 new file mode 100644 index 0000000..dd02454 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_crl_dist_points2.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_crl_dist_points2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_crl_dist_points2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_crl_dist_points2(gnutls_x509_crt_t " crt ", gnutls_x509_subject_alt_name_t " type ", const void * " data ", unsigned int " data_size ", unsigned int " reason_flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_subject_alt_name_t type" 12 +is one of the gnutls_x509_subject_alt_name_t enumerations +.IP "const void * data" 12 +The data to be set +.IP "unsigned int data_size" 12 +The data size +.IP "unsigned int reason_flags" 12 +revocation reasons +.SH "DESCRIPTION" +This function will set the CRL distribution points certificate extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_crq.3 b/doc/manpages/gnutls_x509_crt_set_crq.3 new file mode 100644 index 0000000..91f9f8a --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_crq.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_crq" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_crq \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_crq(gnutls_x509_crt_t " crt ", gnutls_x509_crq_t " crq ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_crq_t crq" 12 +holds a certificate request +.SH "DESCRIPTION" +This function will set the name and public parameters as well as +the extensions from the given certificate request to the certificate. +Only RSA keys are currently supported. + +Note that this function will only set the \fIcrq\fP if it is self +signed and the signature is correct. See \fBgnutls_x509_crq_sign2()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_crq_extension_by_oid.3 b/doc/manpages/gnutls_x509_crt_set_crq_extension_by_oid.3 new file mode 100644 index 0000000..6bbfb87 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_crq_extension_by_oid.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_crq_extension_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_crq_extension_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_crq_extension_by_oid(gnutls_x509_crt_t " crt ", gnutls_x509_crq_t " crq ", const char * " oid ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_crq_t crq" 12 +holds a certificate request +.IP "const char * oid" 12 +the object identifier of the OID to copy +.IP "unsigned flags" 12 +should be zero +.SH "DESCRIPTION" +This function will set the extension specify by \fIoid\fP from the given request to the +certificate. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_crq_extensions.3 b/doc/manpages/gnutls_x509_crt_set_crq_extensions.3 new file mode 100644 index 0000000..62caf2e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_crq_extensions.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_crq_extensions" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_crq_extensions \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_crq_extensions(gnutls_x509_crt_t " crt ", gnutls_x509_crq_t " crq ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_crq_t crq" 12 +holds a certificate request +.SH "DESCRIPTION" +This function will set the extensions from the given request to the +certificate. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_dn.3 b/doc/manpages/gnutls_x509_crt_set_dn.3 new file mode 100644 index 0000000..3d9f50f --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_dn.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_dn(gnutls_x509_crt_t " crt ", const char * " dn ", const char ** " err ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const char * dn" 12 +a comma separated DN string (RFC4514) +.IP "const char ** err" 12 +indicates the error position (if any) +.SH "DESCRIPTION" +This function will set the DN on the provided certificate. +The input string should be plain ASCII or UTF\-8 encoded. On +DN parsing error \fBGNUTLS_E_PARSING_ERROR\fP is returned. + +Note that DNs are not expected to hold DNS information, and thus +no automatic IDNA conversions are attempted when using this function. +If that is required (e.g., store a domain in CN), process the corresponding +input with \fBgnutls_idna_map()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_dn_by_oid.3 b/doc/manpages/gnutls_x509_crt_set_dn_by_oid.3 new file mode 100644 index 0000000..8c64827 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_dn_by_oid.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_dn_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_dn_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_dn_by_oid(gnutls_x509_crt_t " crt ", const char * " oid ", unsigned int " raw_flag ", const void * " name ", unsigned int " sizeof_name ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const char * oid" 12 +holds an Object Identifier in a null terminated string +.IP "unsigned int raw_flag" 12 +must be 0, or 1 if the data are DER encoded +.IP "const void * name" 12 +a pointer to the name +.IP "unsigned int sizeof_name" 12 +holds the size of \fIname\fP +.SH "DESCRIPTION" +This function will set the part of the name of the Certificate +subject, specified by the given OID. The input string should be +ASCII or UTF\-8 encoded. + +Some helper macros with popular OIDs can be found in gnutls/x509.h +With this function you can only set the known OIDs. You can test +for known OIDs using \fBgnutls_x509_dn_oid_known()\fP. For OIDs that are +not known (by gnutls) you should properly DER encode your data, +and call this function with \fIraw_flag\fP set. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_expiration_time.3 b/doc/manpages/gnutls_x509_crt_set_expiration_time.3 new file mode 100644 index 0000000..cabb200 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_expiration_time.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_expiration_time" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_expiration_time \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_expiration_time(gnutls_x509_crt_t " cert ", time_t " exp_time ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "time_t exp_time" 12 +The actual time +.SH "DESCRIPTION" +This function will set the time this Certificate will expire. +Setting an expiration time to (time_t)\-1 will set +to the no well\-defined expiration date value. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_extension_by_oid.3 b/doc/manpages/gnutls_x509_crt_set_extension_by_oid.3 new file mode 100644 index 0000000..c1fa0aa --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_extension_by_oid.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_extension_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_extension_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_extension_by_oid(gnutls_x509_crt_t " crt ", const char * " oid ", const void * " buf ", size_t " sizeof_buf ", unsigned int " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const char * oid" 12 +holds an Object Identifier in null terminated string +.IP "const void * buf" 12 +a pointer to a DER encoded data +.IP "size_t sizeof_buf" 12 +holds the size of \fIbuf\fP +.IP "unsigned int critical" 12 +should be non\-zero if the extension is to be marked as critical +.SH "DESCRIPTION" +This function will set an the extension, by the specified OID, in +the certificate. The extension data should be binary data DER +encoded. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_flags.3 b/doc/manpages/gnutls_x509_crt_set_flags.3 new file mode 100644 index 0000000..622cd4c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_flags.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_flags" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_flags \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_crt_set_flags(gnutls_x509_crt_t " cert ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +A type \fBgnutls_x509_crt_t\fP +.IP "unsigned int flags" 12 +flags from the \fBgnutls_x509_crt_flags\fP +.SH "DESCRIPTION" +This function will set flags for the specified certificate. +Currently this is useful for the \fBGNUTLS_X509_CRT_FLAG_IGNORE_SANITY\fP +which allows importing certificates even if they have known issues. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_inhibit_anypolicy.3 b/doc/manpages/gnutls_x509_crt_set_inhibit_anypolicy.3 new file mode 100644 index 0000000..29f2d78 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_inhibit_anypolicy.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_inhibit_anypolicy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_inhibit_anypolicy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_inhibit_anypolicy(gnutls_x509_crt_t " crt ", unsigned int " skipcerts ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "unsigned int skipcerts" 12 +number of certificates after which anypolicy is no longer acceptable. +.SH "DESCRIPTION" +This function will set the Inhibit anyPolicy certificate extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_issuer_alt_name.3 b/doc/manpages/gnutls_x509_crt_set_issuer_alt_name.3 new file mode 100644 index 0000000..12f54a5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_issuer_alt_name.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_issuer_alt_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_issuer_alt_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_issuer_alt_name(gnutls_x509_crt_t " crt ", gnutls_x509_subject_alt_name_t " type ", const void * " data ", unsigned int " data_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_subject_alt_name_t type" 12 +is one of the gnutls_x509_subject_alt_name_t enumerations +.IP "const void * data" 12 +The data to be set +.IP "unsigned int data_size" 12 +The size of data to be set +.IP "unsigned int flags" 12 +GNUTLS_FSAN_SET to clear previous data or GNUTLS_FSAN_APPEND to append. +.SH "DESCRIPTION" +This function will set the issuer alternative name certificate +extension. It can set the same types as \fBgnutls_x509_crt_set_subject_alt_name()\fP. + +Since version 3.5.7 the \fBGNUTLS_SAN_RFC822NAME\fP, \fBGNUTLS_SAN_DNSNAME\fP, and +\fBGNUTLS_SAN_OTHERNAME_XMPP\fP are converted to ACE format when necessary. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_issuer_alt_othername.3 b/doc/manpages/gnutls_x509_crt_set_issuer_alt_othername.3 new file mode 100644 index 0000000..8af87ab --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_issuer_alt_othername.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_issuer_alt_othername" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_issuer_alt_othername \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_issuer_alt_othername(gnutls_x509_crt_t " crt ", const char * " oid ", const void * " data ", unsigned int " data_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const char * oid" 12 +The other name OID +.IP "const void * data" 12 +The data to be set +.IP "unsigned int data_size" 12 +The size of data to be set +.IP "unsigned int flags" 12 +GNUTLS_FSAN_SET to clear previous data or GNUTLS_FSAN_APPEND to append. +.SH "DESCRIPTION" +This function will set an "othername" to the issuer alternative name certificate +extension. + +The values set are set as binary values and are expected to have the proper DER encoding. +For convenience the flags \fBGNUTLS_FSAN_ENCODE_OCTET_STRING\fP and \fBGNUTLS_FSAN_ENCODE_UTF8_STRING\fP +can be used to encode the provided data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_issuer_dn.3 b/doc/manpages/gnutls_x509_crt_set_issuer_dn.3 new file mode 100644 index 0000000..39e8c9f --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_issuer_dn.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_issuer_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_issuer_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_issuer_dn(gnutls_x509_crt_t " crt ", const char * " dn ", const char ** " err ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const char * dn" 12 +a comma separated DN string (RFC4514) +.IP "const char ** err" 12 +indicates the error position (if any) +.SH "DESCRIPTION" +This function will set the DN on the provided certificate. +The input string should be plain ASCII or UTF\-8 encoded. On +DN parsing error \fBGNUTLS_E_PARSING_ERROR\fP is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_issuer_dn_by_oid.3 b/doc/manpages/gnutls_x509_crt_set_issuer_dn_by_oid.3 new file mode 100644 index 0000000..84f6364 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_issuer_dn_by_oid.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_issuer_dn_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_issuer_dn_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_issuer_dn_by_oid(gnutls_x509_crt_t " crt ", const char * " oid ", unsigned int " raw_flag ", const void * " name ", unsigned int " sizeof_name ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const char * oid" 12 +holds an Object Identifier in a null terminated string +.IP "unsigned int raw_flag" 12 +must be 0, or 1 if the data are DER encoded +.IP "const void * name" 12 +a pointer to the name +.IP "unsigned int sizeof_name" 12 +holds the size of \fIname\fP +.SH "DESCRIPTION" +This function will set the part of the name of the Certificate +issuer, specified by the given OID. The input string should be +ASCII or UTF\-8 encoded. + +Some helper macros with popular OIDs can be found in gnutls/x509.h +With this function you can only set the known OIDs. You can test +for known OIDs using \fBgnutls_x509_dn_oid_known()\fP. For OIDs that are +not known (by gnutls) you should properly DER encode your data, +and call this function with \fIraw_flag\fP set. + +Normally you do not need to call this function, since the signing +operation will copy the signer's name as the issuer of the +certificate. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_issuer_unique_id.3 b/doc/manpages/gnutls_x509_crt_set_issuer_unique_id.3 new file mode 100644 index 0000000..845c05a --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_issuer_unique_id.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_issuer_unique_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_issuer_unique_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_issuer_unique_id(gnutls_x509_crt_t " cert ", const void * " id ", size_t " id_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const void * id" 12 +The unique ID +.IP "size_t id_size" 12 +Holds the size of the unique ID. +.SH "DESCRIPTION" +This function will set the X.509 certificate's issuer unique ID field. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_key.3 b/doc/manpages/gnutls_x509_crt_set_key.3 new file mode 100644 index 0000000..f841382 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_key.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_key" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_key \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_key(gnutls_x509_crt_t " crt ", gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_privkey_t key" 12 +holds a private key +.SH "DESCRIPTION" +This function will set the public parameters from the given +private key to the certificate. + +To export the public key (i.e., the SubjectPublicKeyInfo part), check +\fBgnutls_pubkey_import_x509()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_key_purpose_oid.3 b/doc/manpages/gnutls_x509_crt_set_key_purpose_oid.3 new file mode 100644 index 0000000..8bc447e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_key_purpose_oid.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_key_purpose_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_key_purpose_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_key_purpose_oid(gnutls_x509_crt_t " cert ", const void * " oid ", unsigned int " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const void * oid" 12 +a pointer to a null terminated string that holds the OID +.IP "unsigned int critical" 12 +Whether this extension will be critical or not +.SH "DESCRIPTION" +This function will set the key purpose OIDs of the Certificate. +These are stored in the Extended Key Usage extension (2.5.29.37) +See the GNUTLS_KP_* definitions for human readable names. + +Subsequent calls to this function will append OIDs to the OID list. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_key_usage.3 b/doc/manpages/gnutls_x509_crt_set_key_usage.3 new file mode 100644 index 0000000..dd09280 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_key_usage.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_key_usage" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_key_usage \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_key_usage(gnutls_x509_crt_t " crt ", unsigned int " usage ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "unsigned int usage" 12 +an ORed sequence of the GNUTLS_KEY_* elements. +.SH "DESCRIPTION" +This function will set the keyUsage certificate extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_name_constraints.3 b/doc/manpages/gnutls_x509_crt_set_name_constraints.3 new file mode 100644 index 0000000..a4d7194 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_name_constraints.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_name_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_name_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_name_constraints(gnutls_x509_crt_t " crt ", gnutls_x509_name_constraints_t " nc ", unsigned int " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +The certificate +.IP "gnutls_x509_name_constraints_t nc" 12 +The nameconstraints structure +.IP "unsigned int critical" 12 +whether this extension will be critical +.SH "DESCRIPTION" +This function will set the provided name constraints to +the certificate extension list. This extension is always +marked as critical. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_pin_function.3 b/doc/manpages/gnutls_x509_crt_set_pin_function.3 new file mode 100644 index 0000000..0bb28fe --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_pin_function.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_pin_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_pin_function \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_crt_set_pin_function(gnutls_x509_crt_t " crt ", gnutls_pin_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +The certificate structure +.IP "gnutls_pin_callback_t fn" 12 +the callback +.IP "void * userdata" 12 +data associated with the callback +.SH "DESCRIPTION" +This function will set a callback function to be used when +it is required to access a protected object. This function overrides +the global function set using \fBgnutls_pkcs11_set_pin_function()\fP. + +Note that this callback is currently used only during the import +of a PKCS \fB11\fP certificate with \fBgnutls_x509_crt_import_url()\fP. +.SH "SINCE" +3.1.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_policy.3 b/doc/manpages/gnutls_x509_crt_set_policy.3 new file mode 100644 index 0000000..2539bf7 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_policy.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_policy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_policy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_policy(gnutls_x509_crt_t " crt ", const struct gnutls_x509_policy_st * " policy ", unsigned int " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "const struct gnutls_x509_policy_st * policy" 12 +A pointer to a policy +.IP "unsigned int critical" 12 +use non\-zero if the extension is marked as critical +.SH "DESCRIPTION" +This function will set the certificate policy extension (2.5.29.32). +Multiple calls to this function append a new policy. + +Note the maximum text size for the qualifier \fBGNUTLS_X509_QUALIFIER_NOTICE\fP +is 200 characters. This function will fail with \fBGNUTLS_E_INVALID_REQUEST\fP +if this is exceeded. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_private_key_usage_period.3 b/doc/manpages/gnutls_x509_crt_set_private_key_usage_period.3 new file mode 100644 index 0000000..997e1ab --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_private_key_usage_period.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_private_key_usage_period" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_private_key_usage_period \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_private_key_usage_period(gnutls_x509_crt_t " crt ", time_t " activation ", time_t " expiration ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "time_t activation" 12 +The activation time +.IP "time_t expiration" 12 +The expiration time +.SH "DESCRIPTION" +This function will set the private key usage period extension (2.5.29.16). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_proxy.3 b/doc/manpages/gnutls_x509_crt_set_proxy.3 new file mode 100644 index 0000000..bd63402 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_proxy.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_proxy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_proxy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_proxy(gnutls_x509_crt_t " crt ", int " pathLenConstraint ", const char * " policyLanguage ", const char * " policy ", size_t " sizeof_policy ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "int pathLenConstraint" 12 +non\-negative error codes indicate maximum length of path, +and negative error codes indicate that the pathLenConstraints field should +not be present. +.IP "const char * policyLanguage" 12 +OID describing the language of \fIpolicy\fP . +.IP "const char * policy" 12 +uint8_t byte array with policy language, can be \fBNULL\fP +.IP "size_t sizeof_policy" 12 +size of \fIpolicy\fP . +.SH "DESCRIPTION" +This function will set the proxyCertInfo extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_proxy_dn.3 b/doc/manpages/gnutls_x509_crt_set_proxy_dn.3 new file mode 100644 index 0000000..bb4f856 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_proxy_dn.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_proxy_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_proxy_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_proxy_dn(gnutls_x509_crt_t " crt ", gnutls_x509_crt_t " eecrt ", unsigned int " raw_flag ", const void * " name ", unsigned int " sizeof_name ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a gnutls_x509_crt_t type with the new proxy cert +.IP "gnutls_x509_crt_t eecrt" 12 +the end entity certificate that will be issuing the proxy +.IP "unsigned int raw_flag" 12 +must be 0, or 1 if the CN is DER encoded +.IP "const void * name" 12 +a pointer to the CN name, may be NULL (but MUST then be added later) +.IP "unsigned int sizeof_name" 12 +holds the size of \fIname\fP +.SH "DESCRIPTION" +This function will set the subject in \fIcrt\fP to the end entity's + \fIeecrt\fP subject name, and add a single Common Name component \fIname\fP of size \fIsizeof_name\fP . This corresponds to the required proxy +certificate naming style. Note that if \fIname\fP is \fBNULL\fP, you MUST +set it later by using \fBgnutls_x509_crt_set_dn_by_oid()\fP or similar. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_pubkey.3 b/doc/manpages/gnutls_x509_crt_set_pubkey.3 new file mode 100644 index 0000000..6dd2531 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_pubkey.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_pubkey" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_pubkey \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_x509_crt_set_pubkey(gnutls_x509_crt_t " crt ", gnutls_pubkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +should contain a \fBgnutls_x509_crt_t\fP type +.IP "gnutls_pubkey_t key" 12 +holds a public key +.SH "DESCRIPTION" +This function will set the public parameters from the given public +key to the certificate. The \fIkey\fP can be deallocated after that. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_serial.3 b/doc/manpages/gnutls_x509_crt_set_serial.3 new file mode 100644 index 0000000..624c40b --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_serial.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_serial" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_serial \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_serial(gnutls_x509_crt_t " cert ", const void * " serial ", size_t " serial_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const void * serial" 12 +The serial number +.IP "size_t serial_size" 12 +Holds the size of the serial field. +.SH "DESCRIPTION" +This function will set the X.509 certificate's serial number. +While the serial number is an integer, it is often handled +as an opaque field by several CAs. For this reason this function +accepts any kind of data as a serial number. To be consistent +with the X.509/PKIX specifications the provided \fIserial\fP should be +a big\-endian positive number (i.e. its leftmost bit should be zero). + +The size of the serial is restricted to 20 bytes maximum by RFC5280. +This function allows writing more than 20 bytes but the generated +certificates in that case may be rejected by other implementations. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_spki.3 b/doc/manpages/gnutls_x509_crt_set_spki.3 new file mode 100644 index 0000000..c0f8447 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_spki.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_spki(gnutls_x509_crt_t " crt ", const gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_x509_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will set the certificate's subject public key +information explicitly. This is intended to be used in the cases +where a single public key (e.g., RSA) can be used for multiple +signature algorithms (RSA PKCS1\-1.5, and RSA\-PSS). + +To export the public key (i.e., the SubjectPublicKeyInfo part), check +\fBgnutls_pubkey_import_x509()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_subject_alt_name.3 b/doc/manpages/gnutls_x509_crt_set_subject_alt_name.3 new file mode 100644 index 0000000..719f43c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_subject_alt_name.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_subject_alt_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_subject_alt_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_subject_alt_name(gnutls_x509_crt_t " crt ", gnutls_x509_subject_alt_name_t " type ", const void * " data ", unsigned int " data_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_subject_alt_name_t type" 12 +is one of the gnutls_x509_subject_alt_name_t enumerations +.IP "const void * data" 12 +The data to be set +.IP "unsigned int data_size" 12 +The size of data to be set +.IP "unsigned int flags" 12 +GNUTLS_FSAN_SET to clear previous data or GNUTLS_FSAN_APPEND to append. +.SH "DESCRIPTION" +This function will set the subject alternative name certificate +extension. It can set the following types: \fBGNUTLS_SAN_DNSNAME\fP as a text string, +\fBGNUTLS_SAN_RFC822NAME\fP as a text string, \fBGNUTLS_SAN_URI\fP as a text string, +\fBGNUTLS_SAN_IPADDRESS\fP as a binary IP address (4 or 16 bytes), +\fBGNUTLS_SAN_OTHERNAME_XMPP\fP as a UTF8 string (since 3.5.0). + +Since version 3.5.7 the \fBGNUTLS_SAN_RFC822NAME\fP, \fBGNUTLS_SAN_DNSNAME\fP, and +\fBGNUTLS_SAN_OTHERNAME_XMPP\fP are converted to ACE format when necessary. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_subject_alt_othername.3 b/doc/manpages/gnutls_x509_crt_set_subject_alt_othername.3 new file mode 100644 index 0000000..f8c9338 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_subject_alt_othername.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_subject_alt_othername" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_subject_alt_othername \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_subject_alt_othername(gnutls_x509_crt_t " crt ", const char * " oid ", const void * " data ", unsigned int " data_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const char * oid" 12 +The other name OID +.IP "const void * data" 12 +The data to be set +.IP "unsigned int data_size" 12 +The size of data to be set +.IP "unsigned int flags" 12 +GNUTLS_FSAN_SET to clear previous data or GNUTLS_FSAN_APPEND to append. +.SH "DESCRIPTION" +This function will set an "othername" to the subject alternative name certificate +extension. + +The values set are set as binary values and are expected to have the proper DER encoding. +For convenience the flags \fBGNUTLS_FSAN_ENCODE_OCTET_STRING\fP and \fBGNUTLS_FSAN_ENCODE_UTF8_STRING\fP +can be used to encode the provided data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_subject_alternative_name.3 b/doc/manpages/gnutls_x509_crt_set_subject_alternative_name.3 new file mode 100644 index 0000000..a736295 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_subject_alternative_name.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_subject_alternative_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_subject_alternative_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_subject_alternative_name(gnutls_x509_crt_t " crt ", gnutls_x509_subject_alt_name_t " type ", const char * " data_string ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_subject_alt_name_t type" 12 +is one of the gnutls_x509_subject_alt_name_t enumerations +.IP "const char * data_string" 12 +The data to be set, a (0) terminated string +.SH "DESCRIPTION" +This function will set the subject alternative name certificate +extension. This function assumes that data can be expressed as a null +terminated string. + +The name of the function is unfortunate since it is inconsistent with +\fBgnutls_x509_crt_get_subject_alt_name()\fP. + +See \fBgnutls_x509_crt_set_subject_alt_name()\fP for more information. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_subject_key_id.3 b/doc/manpages/gnutls_x509_crt_set_subject_key_id.3 new file mode 100644 index 0000000..b20f471 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_subject_key_id.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_subject_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_subject_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_subject_key_id(gnutls_x509_crt_t " cert ", const void * " id ", size_t " id_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const void * id" 12 +The key ID +.IP "size_t id_size" 12 +Holds the size of the subject key ID field. +.SH "DESCRIPTION" +This function will set the X.509 certificate's subject key ID +extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_subject_unique_id.3 b/doc/manpages/gnutls_x509_crt_set_subject_unique_id.3 new file mode 100644 index 0000000..36777f9 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_subject_unique_id.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_subject_unique_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_subject_unique_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_subject_unique_id(gnutls_x509_crt_t " cert ", const void * " id ", size_t " id_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "const void * id" 12 +The unique ID +.IP "size_t id_size" 12 +Holds the size of the unique ID. +.SH "DESCRIPTION" +This function will set the X.509 certificate's subject unique ID field. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_tlsfeatures.3 b/doc/manpages/gnutls_x509_crt_set_tlsfeatures.3 new file mode 100644 index 0000000..21692ac --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_tlsfeatures.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_tlsfeatures" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_tlsfeatures \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_tlsfeatures(gnutls_x509_crt_t " crt ", gnutls_x509_tlsfeatures_t " features ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +A X.509 certificate +.IP "gnutls_x509_tlsfeatures_t features" 12 +If the function succeeds, the +features will be added to the certificate. +.SH "DESCRIPTION" +This function will set the certificates +X.509 TLS extension from the given structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_set_version.3 b/doc/manpages/gnutls_x509_crt_set_version.3 new file mode 100644 index 0000000..ba5fcb3 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_version.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_version \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_set_version(gnutls_x509_crt_t " crt ", unsigned int " version ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "unsigned int version" 12 +holds the version number. For X.509v1 certificates must be 1. +.SH "DESCRIPTION" +This function will set the version of the certificate. This must +be one for X.509 version 1, and so on. Plain certificates without +extensions must have version set to one. + +To create well\-formed certificates, you must specify version 3 if +you use any certificate extensions. Extensions are created by +functions such as \fBgnutls_x509_crt_set_subject_alt_name()\fP +or \fBgnutls_x509_crt_set_key_usage()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_sign.3 b/doc/manpages/gnutls_x509_crt_sign.3 new file mode 100644 index 0000000..4ac46e7 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_sign.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_sign" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_sign \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_sign(gnutls_x509_crt_t " crt ", gnutls_x509_crt_t " issuer ", gnutls_x509_privkey_t " issuer_key ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_crt_t issuer" 12 +is the certificate of the certificate issuer +.IP "gnutls_x509_privkey_t issuer_key" 12 +holds the issuer's private key +.SH "DESCRIPTION" +This function is the same a \fBgnutls_x509_crt_sign2()\fP with no flags, +and an appropriate hash algorithm. The hash algorithm used may +vary between versions of GnuTLS, and it is tied to the security +level of the issuer's public key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_sign2.3 b/doc/manpages/gnutls_x509_crt_sign2.3 new file mode 100644 index 0000000..8fc8668 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_sign2.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_sign2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_sign2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_sign2(gnutls_x509_crt_t " crt ", gnutls_x509_crt_t " issuer ", gnutls_x509_privkey_t " issuer_key ", gnutls_digest_algorithm_t " dig ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +a certificate of type \fBgnutls_x509_crt_t\fP +.IP "gnutls_x509_crt_t issuer" 12 +is the certificate of the certificate issuer +.IP "gnutls_x509_privkey_t issuer_key" 12 +holds the issuer's private key +.IP "gnutls_digest_algorithm_t dig" 12 +The message digest to use, \fBGNUTLS_DIG_SHA256\fP is a safe choice +.IP "unsigned int flags" 12 +must be 0 +.SH "DESCRIPTION" +This function will sign the certificate with the issuer's private key, and +will copy the issuer's information into the certificate. + +This must be the last step in a certificate generation since all +the previously set parameters are now signed. + +A known limitation of this function is, that a newly\-signed certificate will not +be fully functional (e.g., for signature verification), until it +is exported an re\-imported. + +After GnuTLS 3.6.1 the value of \fIdig\fP may be \fBGNUTLS_DIG_UNKNOWN\fP, +and in that case, a suitable but reasonable for the key algorithm will be selected. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_verify.3 b/doc/manpages/gnutls_x509_crt_verify.3 new file mode 100644 index 0000000..f7237f1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_verify.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_verify" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_verify \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_verify(gnutls_x509_crt_t " cert ", const gnutls_x509_crt_t * " CA_list ", unsigned " CA_list_length ", unsigned int " flags ", unsigned int * " verify ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +is the certificate to be verified +.IP "const gnutls_x509_crt_t * CA_list" 12 +is one certificate that is considered to be trusted one +.IP "unsigned CA_list_length" 12 +holds the number of CA certificate in CA_list +.IP "unsigned int flags" 12 +Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations. +.IP "unsigned int * verify" 12 +will hold the certificate verification output. +.SH "DESCRIPTION" +This function will try to verify the given certificate and return +its status. Note that a verification error does not imply a negative +return status. In that case the \fIverify\fP status is set. + +The details of the verification are the same +as in \fBgnutls_x509_trust_list_verify_crt2()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_crt_verify_data2.3 b/doc/manpages/gnutls_x509_crt_verify_data2.3 new file mode 100644 index 0000000..81ab033 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_verify_data2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_verify_data2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_verify_data2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_crt_verify_data2(gnutls_x509_crt_t " crt ", gnutls_sign_algorithm_t " algo ", unsigned int " flags ", const gnutls_datum_t * " data ", const gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate to verify with +.IP "gnutls_sign_algorithm_t algo" 12 +The signature algorithm used +.IP "unsigned int flags" 12 +Zero or an OR list of \fBgnutls_certificate_verify_flags\fP +.IP "const gnutls_datum_t * data" 12 +holds the signed data +.IP "const gnutls_datum_t * signature" 12 +contains the signature +.SH "DESCRIPTION" +This function will verify the given signed data, using the +parameters from the certificate. +.SH "RETURNS" +In case of a verification failure \fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP +is returned, \fBGNUTLS_E_EXPIRED\fP or \fBGNUTLS_E_NOT_YET_ACTIVATED\fP on expired +or not yet activated certificate and zero or positive code on success. + +Note that since GnuTLS 3.5.6 this function introduces checks in the +end certificate ( \fIcrt\fP ), including time checks and key usage checks. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ct_sct_get.3 b/doc/manpages/gnutls_x509_ct_sct_get.3 new file mode 100644 index 0000000..5e830f1 --- /dev/null +++ b/doc/manpages/gnutls_x509_ct_sct_get.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ct_sct_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ct_sct_get \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ct_sct_get(const gnutls_x509_ct_scts_t " scts ", unsigned " idx ", time_t * " timestamp ", gnutls_datum_t * " logid ", gnutls_sign_algorithm_t * " sigalg ", gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "const gnutls_x509_ct_scts_t scts" 12 +A list of SCTs +.IP "unsigned idx" 12 +The index of the target SCT in the list +.IP "time_t * timestamp" 12 +The timestamp of the SCT +.IP "gnutls_datum_t * logid" 12 +The LogID field of the SCT; must be freed with \fBgnutls_free()\fP +.IP "gnutls_sign_algorithm_t * sigalg" 12 +The signature algorithm +.IP "gnutls_datum_t * signature" 12 +The signature of the SCT; must be freed with \fBgnutls_free()\fP +.SH "DESCRIPTION" +This function will return a specific SCT (Signed Certificate Timestamp) +stored in the SCT list \fIscts\fP . + +The datums holding the SCT's LogId and signature will be allocated +using \fBgnutls_malloc()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) will be returned on success, +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if \fIidx\fP exceeds the number of SCTs in the list +or a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ct_sct_get_version.3 b/doc/manpages/gnutls_x509_ct_sct_get_version.3 new file mode 100644 index 0000000..72687be --- /dev/null +++ b/doc/manpages/gnutls_x509_ct_sct_get_version.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ct_sct_get_version" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ct_sct_get_version \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ct_sct_get_version(gnutls_x509_ct_scts_t " scts ", unsigned " idx ", unsigned int * " version_out ");" +.SH ARGUMENTS +.IP "gnutls_x509_ct_scts_t scts" 12 +A list of SCTs +.IP "unsigned idx" 12 +The index of the target SCT in the list +.IP "unsigned int * version_out" 12 +The version of the target SCT. +.SH "DESCRIPTION" +This function obtains the version of the SCT at the given position +in the SCT list. + +The version of that SCT will be placed on \fIversion_out\fP . + +Return : \fBGNUTLS_E_SUCCESS\fP (0) is returned on success, +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP if \fIidx\fP exceeds the number of SCTs in the list +and \fBGNUTLS_E_INVALID_REQUEST\fP if the SCT's version is different than 1, as that's currently +the only defined version. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_deinit.3 b/doc/manpages/gnutls_x509_dn_deinit.3 new file mode 100644 index 0000000..b168901 --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_deinit.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_dn_deinit(gnutls_x509_dn_t " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t dn" 12 +a DN uint8_t object pointer. +.SH "DESCRIPTION" +This function deallocates the DN object as returned by +\fBgnutls_x509_dn_import()\fP. +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_export.3 b/doc/manpages/gnutls_x509_dn_export.3 new file mode 100644 index 0000000..05b9cd1 --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_export.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_export \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_dn_export(gnutls_x509_dn_t " dn ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t dn" 12 +Holds the uint8_t DN object +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "void * output_data" 12 +will contain a DN PEM or DER encoded +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the DN to DER or PEM format. + +If the buffer provided is not long enough to hold the output, then +* \fIoutput_data_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP +will be returned. + +If the structure is PEM encoded, it will have a header +of "BEGIN NAME". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_export2.3 b/doc/manpages/gnutls_x509_dn_export2.3 new file mode 100644 index 0000000..d17a477 --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_export2.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_dn_export2(gnutls_x509_dn_t " dn ", gnutls_x509_crt_fmt_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t dn" 12 +Holds the uint8_t DN object +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "gnutls_datum_t * out" 12 +will contain a DN PEM or DER encoded +.SH "DESCRIPTION" +This function will export the DN to DER or PEM format. + +The output buffer is allocated using \fBgnutls_malloc()\fP. + +If the structure is PEM encoded, it will have a header +of "BEGIN NAME". +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_get_rdn_ava.3 b/doc/manpages/gnutls_x509_dn_get_rdn_ava.3 new file mode 100644 index 0000000..479547b --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_get_rdn_ava.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_get_rdn_ava" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_get_rdn_ava \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_dn_get_rdn_ava(gnutls_x509_dn_t " dn ", int " irdn ", int " iava ", gnutls_x509_ava_st * " ava ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t dn" 12 +a pointer to DN +.IP "int irdn" 12 +index of RDN +.IP "int iava" 12 +index of AVA. +.IP "gnutls_x509_ava_st * ava" 12 +Pointer to structure which will hold output information. +.SH "DESCRIPTION" +Get pointers to data within the DN. The format of the \fIava\fP structure +is shown below. + +struct gnutls_x509_ava_st { +gnutls_datum_t oid; +gnutls_datum_t value; +unsigned long value_tag; +}; + +The X.509 distinguished name is a sequence of sequences of strings +and this is what the \fIirdn\fP and \fIiava\fP indexes model. + +Note that \fIava\fP will contain pointers into the \fIdn\fP structure which +in turns points to the original certificate. Thus you should not +modify any data or deallocate any of those. + +This is a low\-level function that requires the caller to do the +value conversions when necessary (e.g. from UCS\-2). +.SH "RETURNS" +Returns 0 on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_get_str.3 b/doc/manpages/gnutls_x509_dn_get_str.3 new file mode 100644 index 0000000..311dcdc --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_get_str.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_get_str" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_get_str \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_dn_get_str(gnutls_x509_dn_t " dn ", gnutls_datum_t * " str ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t dn" 12 +a pointer to DN +.IP "gnutls_datum_t * str" 12 +a datum that will hold the name +.SH "DESCRIPTION" +This function will allocate buffer and copy the name in the provided DN. +The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_get_str2.3 b/doc/manpages/gnutls_x509_dn_get_str2.3 new file mode 100644 index 0000000..ccf2944 --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_get_str2.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_get_str2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_get_str2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_dn_get_str2(gnutls_x509_dn_t " dn ", gnutls_datum_t * " str ", unsigned " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t dn" 12 +a pointer to DN +.IP "gnutls_datum_t * str" 12 +a datum that will hold the name +.IP "unsigned flags" 12 +zero or \fBGNUTLS_X509_DN_FLAG_COMPAT\fP +.SH "DESCRIPTION" +This function will allocate buffer and copy the name in the provided DN. +The name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as +described in RFC4514. The output string will be ASCII or UTF\-8 +encoded, depending on the certificate data. + +When the flag \fBGNUTLS_X509_DN_FLAG_COMPAT\fP is specified, the output +format will match the format output by previous to 3.5.6 versions of GnuTLS +which was not not fully RFC4514\-compliant. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.7 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_import.3 b/doc/manpages/gnutls_x509_dn_import.3 new file mode 100644 index 0000000..9857e1f --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_import.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_import \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_dn_import(gnutls_x509_dn_t " dn ", const gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t dn" 12 +the structure that will hold the imported DN +.IP "const gnutls_datum_t * data" 12 +should contain a DER encoded RDN sequence +.SH "DESCRIPTION" +This function parses an RDN sequence and stores the result to a +\fBgnutls_x509_dn_t\fP type. The data must have been initialized +with \fBgnutls_x509_dn_init()\fP. You may use \fBgnutls_x509_dn_get_rdn_ava()\fP to +decode the DN. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_init.3 b/doc/manpages/gnutls_x509_dn_init.3 new file mode 100644 index 0000000..9a6d56e --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_init.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_dn_init(gnutls_x509_dn_t * " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t * dn" 12 +the object to be initialized +.SH "DESCRIPTION" +This function initializes a \fBgnutls_x509_dn_t\fP type. + +The object returned must be deallocated using +\fBgnutls_x509_dn_deinit()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_oid_known.3 b/doc/manpages/gnutls_x509_dn_oid_known.3 new file mode 100644 index 0000000..22bd704 --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_oid_known.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_oid_known" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_oid_known \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_dn_oid_known(const char * " oid ");" +.SH ARGUMENTS +.IP "const char * oid" 12 +holds an Object Identifier in a null terminated string +.SH "DESCRIPTION" +This function will inform about known DN OIDs. This is useful since +functions like \fBgnutls_x509_crt_set_dn_by_oid()\fP use the information +on known OIDs to properly encode their input. Object Identifiers +that are not known are not encoded by these functions, and their +input is stored directly into the ASN.1 structure. In that case of +unknown OIDs, you have the responsibility of DER encoding your +data. +.SH "RETURNS" +1 on known OIDs and 0 otherwise. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_oid_name.3 b/doc/manpages/gnutls_x509_dn_oid_name.3 new file mode 100644 index 0000000..a836d8b --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_oid_name.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_oid_name" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_oid_name \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "const char * gnutls_x509_dn_oid_name(const char * " oid ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const char * oid" 12 +holds an Object Identifier in a null terminated string +.IP "unsigned int flags" 12 +0 or GNUTLS_X509_DN_OID_* +.SH "DESCRIPTION" +This function will return the name of a known DN OID. If +\fBGNUTLS_X509_DN_OID_RETURN_OID\fP is specified this function +will return the given OID if no descriptive name has been +found. +.SH "RETURNS" +A null terminated string or NULL otherwise. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_dn_set_str.3 b/doc/manpages/gnutls_x509_dn_set_str.3 new file mode 100644 index 0000000..3c44b24 --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_set_str.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_set_str" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_set_str \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_dn_set_str(gnutls_x509_dn_t " dn ", const char * " str ", const char ** " err ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t dn" 12 +a pointer to DN +.IP "const char * str" 12 +a comma separated DN string (RFC4514) +.IP "const char ** err" 12 +indicates the error position (if any) +.SH "DESCRIPTION" +This function will set the DN on the provided DN structure. +The input string should be plain ASCII or UTF\-8 encoded. On +DN parsing error \fBGNUTLS_E_PARSING_ERROR\fP is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_ct_export_scts.3 b/doc/manpages/gnutls_x509_ext_ct_export_scts.3 new file mode 100644 index 0000000..c80ac67 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_ct_export_scts.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_ct_export_scts" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_ct_export_scts \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_ct_export_scts(const gnutls_x509_ct_scts_t " scts ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "const gnutls_x509_ct_scts_t scts" 12 +An initialized SCT list +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed with \fBgnutls_free()\fP +.SH "DESCRIPTION" +This function will convert the provided list of SCTs to a DER\-encoded +SignedCertificateTimestampList extension (1.3.6.1.4.1.11129.2.4.2). +The output data in \fIext\fP will be allocated using \fBgnutls_malloc()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_ct_import_scts.3 b/doc/manpages/gnutls_x509_ext_ct_import_scts.3 new file mode 100644 index 0000000..8518abf --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_ct_import_scts.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_ct_import_scts" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_ct_import_scts \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_ct_import_scts(const gnutls_datum_t * " ext ", gnutls_x509_ct_scts_t " scts ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +a DER\-encoded extension +.IP "gnutls_x509_ct_scts_t scts" 12 +The SCT list +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will read a SignedCertificateTimestampList structure +from the DER data of the X.509 Certificate Transparency SCT extension +(OID 1.3.6.1.4.1.11129.2.4.2). + +The list of SCTs (Signed Certificate Timestamps) is placed on \fIscts\fP , +which must be previously initialized with \fBgnutls_x509_ext_ct_scts_init()\fP. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success or a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_ct_scts_deinit.3 b/doc/manpages/gnutls_x509_ext_ct_scts_deinit.3 new file mode 100644 index 0000000..143f4cd --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_ct_scts_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_ct_scts_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_ct_scts_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "void gnutls_x509_ext_ct_scts_deinit(gnutls_x509_ct_scts_t " scts ");" +.SH ARGUMENTS +.IP "gnutls_x509_ct_scts_t scts" 12 +The SCT list +.SH "DESCRIPTION" +This function will deinitialize a Certificate Transparency SCT list. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_ct_scts_init.3 b/doc/manpages/gnutls_x509_ext_ct_scts_init.3 new file mode 100644 index 0000000..d3e36cc --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_ct_scts_init.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_ct_scts_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_ct_scts_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_ct_scts_init(gnutls_x509_ct_scts_t * " scts ");" +.SH ARGUMENTS +.IP "gnutls_x509_ct_scts_t * scts" 12 +The SCT list +.SH "DESCRIPTION" +This function will initialize a Certificate Transparency SCT list. +.SH "RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, otherwise a negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_deinit.3 b/doc/manpages/gnutls_x509_ext_deinit.3 new file mode 100644 index 0000000..43d3907 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_ext_deinit(gnutls_x509_ext_st * " ext ");" +.SH ARGUMENTS +.IP "gnutls_x509_ext_st * ext" 12 +The extensions structure +.SH "DESCRIPTION" +This function will deinitialize an extensions structure. +.SH "SINCE" +3.3.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_aia.3 b/doc/manpages/gnutls_x509_ext_export_aia.3 new file mode 100644 index 0000000..d17c166 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_aia.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_aia" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_aia \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_aia(gnutls_x509_aia_t " aia ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "gnutls_x509_aia_t aia" 12 +The authority info access +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will DER encode the Authority Information Access (AIA) +extension; see RFC 5280 section 4.2.2.1 for more information on the +extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_authority_key_id.3 b/doc/manpages/gnutls_x509_ext_export_authority_key_id.3 new file mode 100644 index 0000000..b541de2 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_authority_key_id.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_authority_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_authority_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_authority_key_id(gnutls_x509_aki_t " aki ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "gnutls_x509_aki_t aki" 12 +An initialized authority key identifier +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the provided key identifier to a +DER\-encoded PKIX AuthorityKeyIdentifier extension. +The output data in \fIext\fP will be allocated using +\fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_basic_constraints.3 b/doc/manpages/gnutls_x509_ext_export_basic_constraints.3 new file mode 100644 index 0000000..c53c88e --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_basic_constraints.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_basic_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_basic_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_basic_constraints(unsigned int " ca ", int " pathlen ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "unsigned int ca" 12 +non\-zero for a CA +.IP "int pathlen" 12 +The path length constraint (set to \-1 for no constraint) +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the parameters provided to a basic constraints +DER encoded extension (2.5.29.19). +The \fIext\fP data will be allocated using +\fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_crl_dist_points.3 b/doc/manpages/gnutls_x509_ext_export_crl_dist_points.3 new file mode 100644 index 0000000..06a7764 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_crl_dist_points.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_crl_dist_points" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_crl_dist_points \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_crl_dist_points(gnutls_x509_crl_dist_points_t " cdp ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_dist_points_t cdp" 12 +A pointer to an initialized CRL distribution points. +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the provided policies, to a certificate policy +DER encoded extension (2.5.29.31). + +The \fIext\fP data will be allocated using \fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_inhibit_anypolicy.3 b/doc/manpages/gnutls_x509_ext_export_inhibit_anypolicy.3 new file mode 100644 index 0000000..d2f47cb --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_inhibit_anypolicy.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_inhibit_anypolicy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_inhibit_anypolicy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_inhibit_anypolicy(unsigned int " skipcerts ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "unsigned int skipcerts" 12 +number of certificates after which anypolicy is no longer acceptable. +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the \fIskipcerts\fP value to a DER +encoded Inhibit AnyPolicy PKIX extension. The \fIext\fP data will be allocated using +\fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_key_purposes.3 b/doc/manpages/gnutls_x509_ext_export_key_purposes.3 new file mode 100644 index 0000000..b06a988 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_key_purposes.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_key_purposes" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_key_purposes \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_key_purposes(gnutls_x509_key_purposes_t " p ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "gnutls_x509_key_purposes_t p" 12 +The key purposes +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the key purposes type to a +DER\-encoded PKIX ExtKeyUsageSyntax (2.5.29.37) extension. The output data in + \fIext\fP will be allocated using \fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_key_usage.3 b/doc/manpages/gnutls_x509_ext_export_key_usage.3 new file mode 100644 index 0000000..26606be --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_key_usage.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_key_usage" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_key_usage \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_key_usage(unsigned int " usage ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "unsigned int usage" 12 +an ORed sequence of the GNUTLS_KEY_* elements. +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the keyUsage bit string to a DER +encoded PKIX extension. The \fIext\fP data will be allocated using +\fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_name_constraints.3 b/doc/manpages/gnutls_x509_ext_export_name_constraints.3 new file mode 100644 index 0000000..e200fb4 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_name_constraints.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_name_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_name_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_name_constraints(gnutls_x509_name_constraints_t " nc ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "gnutls_x509_name_constraints_t nc" 12 +The nameconstraints +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the provided name constraints type to a +DER\-encoded PKIX NameConstraints (2.5.29.30) extension. The output data in + \fIext\fP will be allocated using \fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_policies.3 b/doc/manpages/gnutls_x509_ext_export_policies.3 new file mode 100644 index 0000000..c191beb --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_policies.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_policies" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_policies \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_policies(gnutls_x509_policies_t " policies ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "gnutls_x509_policies_t policies" 12 +A pointer to an initialized policies. +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the provided policies, to a certificate policy +DER encoded extension (2.5.29.32). + +The \fIext\fP data will be allocated using \fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_private_key_usage_period.3 b/doc/manpages/gnutls_x509_ext_export_private_key_usage_period.3 new file mode 100644 index 0000000..b940227 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_private_key_usage_period.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_private_key_usage_period" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_private_key_usage_period \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_private_key_usage_period(time_t " activation ", time_t " expiration ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "time_t activation" 12 +The activation time +.IP "time_t expiration" 12 +The expiration time +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the periods provided to a private key +usage DER encoded extension (2.5.29.16). +The \fIext\fP data will be allocated using +\fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_proxy.3 b/doc/manpages/gnutls_x509_ext_export_proxy.3 new file mode 100644 index 0000000..aaf1031 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_proxy.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_proxy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_proxy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_proxy(int " pathLenConstraint ", const char * " policyLanguage ", const char * " policy ", size_t " sizeof_policy ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "int pathLenConstraint" 12 +A negative value will remove the path length constraint, +while non\-negative values will be set as the length of the pathLenConstraints field. +.IP "const char * policyLanguage" 12 +OID describing the language of \fIpolicy\fP . +.IP "const char * policy" 12 +uint8_t byte array with policy language, can be \fBNULL\fP +.IP "size_t sizeof_policy" 12 +size of \fIpolicy\fP . +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the parameters provided to a proxyCertInfo extension. + +The \fIext\fP data will be allocated using \fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_subject_alt_names.3 b/doc/manpages/gnutls_x509_ext_export_subject_alt_names.3 new file mode 100644 index 0000000..d76c113 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_subject_alt_names.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_subject_alt_names" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_subject_alt_names \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_subject_alt_names(gnutls_subject_alt_names_t " sans ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "gnutls_subject_alt_names_t sans" 12 +The alternative names +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the provided alternative names structure to a +DER\-encoded SubjectAltName PKIX extension. The output data in \fIext\fP will be allocated using +\fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_subject_key_id.3 b/doc/manpages/gnutls_x509_ext_export_subject_key_id.3 new file mode 100644 index 0000000..6c8d816 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_subject_key_id.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_subject_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_subject_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_subject_key_id(const gnutls_datum_t * " id ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * id" 12 +The key identifier +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the provided key identifier to a +DER\-encoded PKIX SubjectKeyIdentifier extension. +The output data in \fIext\fP will be allocated using +\fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_export_tlsfeatures.3 b/doc/manpages/gnutls_x509_ext_export_tlsfeatures.3 new file mode 100644 index 0000000..0bee08b --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_export_tlsfeatures.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_export_tlsfeatures" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_export_tlsfeatures \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_export_tlsfeatures(gnutls_x509_tlsfeatures_t " f ", gnutls_datum_t * " ext ");" +.SH ARGUMENTS +.IP "gnutls_x509_tlsfeatures_t f" 12 +The features structure +.IP "gnutls_datum_t * ext" 12 +The DER\-encoded extension data; must be freed using \fBgnutls_free()\fP. +.SH "DESCRIPTION" +This function will convert the provided TLS features structure structure to a +DER\-encoded TLS features PKIX extension. The output data in \fIext\fP will be allocated using +\fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_aia.3 b/doc/manpages/gnutls_x509_ext_import_aia.3 new file mode 100644 index 0000000..7756fb0 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_aia.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_aia" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_aia \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_aia(const gnutls_datum_t * " ext ", gnutls_x509_aia_t " aia ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +The DER\-encoded extension data +.IP "gnutls_x509_aia_t aia" 12 +The authority info access +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function extracts the Authority Information Access (AIA) +extension from the provided DER\-encoded data; see RFC 5280 section 4.2.2.1 +for more information on the extension. The +AIA extension holds a sequence of AccessDescription (AD) data. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_authority_key_id.3 b/doc/manpages/gnutls_x509_ext_import_authority_key_id.3 new file mode 100644 index 0000000..4c1563f --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_authority_key_id.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_authority_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_authority_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_authority_key_id(const gnutls_datum_t * " ext ", gnutls_x509_aki_t " aki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +a DER encoded extension +.IP "gnutls_x509_aki_t aki" 12 +An initialized authority key identifier type +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will return the subject key ID stored in the provided +AuthorityKeyIdentifier extension. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_basic_constraints.3 b/doc/manpages/gnutls_x509_ext_import_basic_constraints.3 new file mode 100644 index 0000000..3826520 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_basic_constraints.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_basic_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_basic_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_basic_constraints(const gnutls_datum_t * " ext ", unsigned int * " ca ", int * " pathlen ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +the DER encoded extension data +.IP "unsigned int * ca" 12 +will be non zero if the CA status is true +.IP "int * pathlen" 12 +the path length constraint; will be set to \-1 for no limit +.SH "DESCRIPTION" +This function will return the CA status and path length constraint +as written in the PKIX extension 2.5.29.19. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_crl_dist_points.3 b/doc/manpages/gnutls_x509_ext_import_crl_dist_points.3 new file mode 100644 index 0000000..7b1c2be --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_crl_dist_points.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_crl_dist_points" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_crl_dist_points \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_crl_dist_points(const gnutls_datum_t * " ext ", gnutls_x509_crl_dist_points_t " cdp ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +the DER encoded extension data +.IP "gnutls_x509_crl_dist_points_t cdp" 12 +A pointer to an initialized CRL distribution points. +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will extract the CRL distribution points extension (2.5.29.31) +and store it into the provided type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_inhibit_anypolicy.3 b/doc/manpages/gnutls_x509_ext_import_inhibit_anypolicy.3 new file mode 100644 index 0000000..388a130 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_inhibit_anypolicy.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_inhibit_anypolicy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_inhibit_anypolicy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_inhibit_anypolicy(const gnutls_datum_t * " ext ", unsigned int * " skipcerts ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +the DER encoded extension data +.IP "unsigned int * skipcerts" 12 +will hold the number of certificates after which anypolicy is no longer acceptable. +.SH "DESCRIPTION" +This function will return certificate's value of SkipCerts, +by reading the DER data of the Inhibit anyPolicy X.509 extension (2.5.29.54). + +The \fIskipcerts\fP value is the number of additional certificates that +may appear in the path before the anyPolicy (\fBGNUTLS_X509_OID_POLICY_ANY\fP) +is no longer acceptable. +.SH "RETURNS" +zero, or a negative error code in case of +parsing error. If the certificate does not contain the Inhibit anyPolicy +extension \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be +returned. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_key_purposes.3 b/doc/manpages/gnutls_x509_ext_import_key_purposes.3 new file mode 100644 index 0000000..f7125ff --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_key_purposes.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_key_purposes" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_key_purposes \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_key_purposes(const gnutls_datum_t * " ext ", gnutls_x509_key_purposes_t " p ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +The DER\-encoded extension data +.IP "gnutls_x509_key_purposes_t p" 12 +The key purposes +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will extract the key purposes in the provided DER\-encoded +ExtKeyUsageSyntax PKIX extension, to a \fBgnutls_x509_key_purposes_t\fP type. +The data must be initialized. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_key_usage.3 b/doc/manpages/gnutls_x509_ext_import_key_usage.3 new file mode 100644 index 0000000..b2b4b4f --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_key_usage.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_key_usage" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_key_usage \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_key_usage(const gnutls_datum_t * " ext ", unsigned int * " key_usage ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +the DER encoded extension data +.IP "unsigned int * key_usage" 12 +where the key usage bits will be stored +.SH "DESCRIPTION" +This function will return certificate's key usage, by reading the DER +data of the keyUsage X.509 extension (2.5.29.15). The key usage value will ORed +values of the: \fBGNUTLS_KEY_DIGITAL_SIGNATURE\fP, +\fBGNUTLS_KEY_NON_REPUDIATION\fP, \fBGNUTLS_KEY_KEY_ENCIPHERMENT\fP, +\fBGNUTLS_KEY_DATA_ENCIPHERMENT\fP, \fBGNUTLS_KEY_KEY_AGREEMENT\fP, +\fBGNUTLS_KEY_KEY_CERT_SIGN\fP, \fBGNUTLS_KEY_CRL_SIGN\fP, +\fBGNUTLS_KEY_ENCIPHER_ONLY\fP, \fBGNUTLS_KEY_DECIPHER_ONLY\fP. +.SH "RETURNS" +the certificate key usage, or a negative error code in case of +parsing error. If the certificate does not contain the keyUsage +extension \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be +returned. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_name_constraints.3 b/doc/manpages/gnutls_x509_ext_import_name_constraints.3 new file mode 100644 index 0000000..7bfcf4e --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_name_constraints.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_name_constraints" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_name_constraints \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_name_constraints(const gnutls_datum_t * " ext ", gnutls_x509_name_constraints_t " nc ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +a DER encoded extension +.IP "gnutls_x509_name_constraints_t nc" 12 +The nameconstraints +.IP "unsigned int flags" 12 +zero or \fBGNUTLS_NAME_CONSTRAINTS_FLAG_APPEND\fP +.SH "DESCRIPTION" +This function will return an intermediate type containing +the name constraints of the provided NameConstraints extension. That +can be used in combination with \fBgnutls_x509_name_constraints_check()\fP +to verify whether a server's name is in accordance with the constraints. + +When the \fIflags\fP is set to \fBGNUTLS_NAME_CONSTRAINTS_FLAG_APPEND\fP, then if +the \fInc\fP type is empty this function will behave identically as if the flag was not set. +Otherwise if there are elements in the \fInc\fP structure then the +constraints will be merged with the existing constraints following +RFC5280 p6.1.4 (excluded constraints will be appended, permitted +will be intersected). + +Note that \fInc\fP must be initialized prior to calling this function. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_policies.3 b/doc/manpages/gnutls_x509_ext_import_policies.3 new file mode 100644 index 0000000..4c5dccc --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_policies.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_policies" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_policies \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_policies(const gnutls_datum_t * " ext ", gnutls_x509_policies_t " policies ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +the DER encoded extension data +.IP "gnutls_x509_policies_t policies" 12 +A pointer to an initialized policies. +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will extract the certificate policy extension (2.5.29.32) +and store it the provided policies. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_private_key_usage_period.3 b/doc/manpages/gnutls_x509_ext_import_private_key_usage_period.3 new file mode 100644 index 0000000..3ea7c48 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_private_key_usage_period.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_private_key_usage_period" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_private_key_usage_period \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_private_key_usage_period(const gnutls_datum_t * " ext ", time_t * " activation ", time_t * " expiration ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +the DER encoded extension data +.IP "time_t * activation" 12 +Will hold the activation time +.IP "time_t * expiration" 12 +Will hold the expiration time +.SH "DESCRIPTION" +This function will return the expiration and activation +times of the private key as written in the +PKIX extension 2.5.29.16. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_proxy.3 b/doc/manpages/gnutls_x509_ext_import_proxy.3 new file mode 100644 index 0000000..20cd82c --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_proxy.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_proxy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_proxy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_proxy(const gnutls_datum_t * " ext ", int * " pathlen ", char ** " policyLanguage ", char ** " policy ", size_t * " sizeof_policy ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +the DER encoded extension data +.IP "int * pathlen" 12 +pointer to output integer indicating path length (may be +NULL), non\-negative error codes indicate a present pCPathLenConstraint +field and the actual value, \-1 indicate that the field is absent. +.IP "char ** policyLanguage" 12 +output variable with OID of policy language +.IP "char ** policy" 12 +output variable with policy data +.IP "size_t * sizeof_policy" 12 +output variable with size of policy data +.SH "DESCRIPTION" +This function will return the information from a proxy certificate +extension. It reads the ProxyCertInfo X.509 extension (1.3.6.1.5.5.7.1.14). +The \fIpolicyLanguage\fP and \fIpolicy\fP values must be deinitialized using \fBgnutls_free()\fP after use. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_subject_alt_names.3 b/doc/manpages/gnutls_x509_ext_import_subject_alt_names.3 new file mode 100644 index 0000000..c5fb517 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_subject_alt_names.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_subject_alt_names" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_subject_alt_names \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_subject_alt_names(const gnutls_datum_t * " ext ", gnutls_subject_alt_names_t " sans ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +The DER\-encoded extension data +.IP "gnutls_subject_alt_names_t sans" 12 +The alternative names +.IP "unsigned int flags" 12 +should be zero +.SH "DESCRIPTION" +This function will export the alternative names in the provided DER\-encoded +SubjectAltName PKIX extension, to a \fBgnutls_subject_alt_names_t\fP type. \fIsans\fP must be initialized. + +This function will succeed even if there no subject alternative names +in the structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_subject_key_id.3 b/doc/manpages/gnutls_x509_ext_import_subject_key_id.3 new file mode 100644 index 0000000..d54639b --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_subject_key_id.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_subject_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_subject_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_subject_key_id(const gnutls_datum_t * " ext ", gnutls_datum_t * " id ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +a DER encoded extension +.IP "gnutls_datum_t * id" 12 +will contain the subject key ID +.SH "DESCRIPTION" +This function will return the subject key ID stored in the provided +SubjectKeyIdentifier extension. The ID will be allocated using +\fBgnutls_malloc()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_import_tlsfeatures.3 b/doc/manpages/gnutls_x509_ext_import_tlsfeatures.3 new file mode 100644 index 0000000..aaf5373 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_import_tlsfeatures.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_import_tlsfeatures" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_import_tlsfeatures \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_ext_import_tlsfeatures(const gnutls_datum_t * " ext ", gnutls_x509_tlsfeatures_t " f ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * ext" 12 +The DER\-encoded extension data +.IP "gnutls_x509_tlsfeatures_t f" 12 +The features structure +.IP "unsigned int flags" 12 +zero or \fBGNUTLS_EXT_FLAG_APPEND\fP +.SH "DESCRIPTION" +This function will export the features in the provided DER\-encoded +TLS Features PKIX extension, to a \fBgnutls_x509_tlsfeatures_t\fP type. \fIf\fP must be initialized. + +When the \fIflags\fP is set to \fBGNUTLS_EXT_FLAG_APPEND\fP, +then if the \fIfeatures\fP structure is empty this function will behave +identically as if the flag was not set. Otherwise if there are elements +in the \fIfeatures\fP structure then they will be merged with. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_ext_print.3 b/doc/manpages/gnutls_x509_ext_print.3 new file mode 100644 index 0000000..eb40811 --- /dev/null +++ b/doc/manpages/gnutls_x509_ext_print.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_ext_print" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_ext_print \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_ext_print(gnutls_x509_ext_st * " exts ", unsigned int " exts_size ", gnutls_certificate_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_ext_st * exts" 12 +The data to be printed +.IP "unsigned int exts_size" 12 +the number of available structures +.IP "gnutls_certificate_print_formats_t format" 12 +Indicate the format to use +.IP "gnutls_datum_t * out" 12 +Newly allocated datum with null terminated string. +.SH "DESCRIPTION" +This function will pretty print X.509 certificate extensions, +suitable for display to a human. + +The output \fIout\fP needs to be deallocated using \fBgnutls_free()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_key_purpose_deinit.3 b/doc/manpages/gnutls_x509_key_purpose_deinit.3 new file mode 100644 index 0000000..a92ce48 --- /dev/null +++ b/doc/manpages/gnutls_x509_key_purpose_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_key_purpose_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_key_purpose_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "void gnutls_x509_key_purpose_deinit(gnutls_x509_key_purposes_t " p ");" +.SH ARGUMENTS +.IP "gnutls_x509_key_purposes_t p" 12 +The key purposes +.SH "DESCRIPTION" +This function will deinitialize a key purposes type. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_key_purpose_get.3 b/doc/manpages/gnutls_x509_key_purpose_get.3 new file mode 100644 index 0000000..7debab2 --- /dev/null +++ b/doc/manpages/gnutls_x509_key_purpose_get.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_key_purpose_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_key_purpose_get \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_key_purpose_get(gnutls_x509_key_purposes_t " p ", unsigned " idx ", gnutls_datum_t * " oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_key_purposes_t p" 12 +The key purposes +.IP "unsigned idx" 12 +The index of the key purpose to retrieve +.IP "gnutls_datum_t * oid" 12 +Will hold the object identifier of the key purpose (to be treated as constant) +.SH "DESCRIPTION" +This function will retrieve the specified by the index key purpose in the +purposes type. The object identifier will be a null terminated string. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the index is out of bounds, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_key_purpose_init.3 b/doc/manpages/gnutls_x509_key_purpose_init.3 new file mode 100644 index 0000000..1dd4ac9 --- /dev/null +++ b/doc/manpages/gnutls_x509_key_purpose_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_key_purpose_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_key_purpose_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_key_purpose_init(gnutls_x509_key_purposes_t * " p ");" +.SH ARGUMENTS +.IP "gnutls_x509_key_purposes_t * p" 12 +The key purposes +.SH "DESCRIPTION" +This function will initialize an alternative names type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_key_purpose_set.3 b/doc/manpages/gnutls_x509_key_purpose_set.3 new file mode 100644 index 0000000..38c0239 --- /dev/null +++ b/doc/manpages/gnutls_x509_key_purpose_set.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_key_purpose_set" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_key_purpose_set \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_key_purpose_set(gnutls_x509_key_purposes_t " p ", const char * " oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_key_purposes_t p" 12 +The key purposes +.IP "const char * oid" 12 +The object identifier of the key purpose +.SH "DESCRIPTION" +This function will store the specified key purpose in the +purposes. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0), otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_name_constraints_add_excluded.3 b/doc/manpages/gnutls_x509_name_constraints_add_excluded.3 new file mode 100644 index 0000000..bc1a165 --- /dev/null +++ b/doc/manpages/gnutls_x509_name_constraints_add_excluded.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_name_constraints_add_excluded" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_name_constraints_add_excluded \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_name_constraints_add_excluded(gnutls_x509_name_constraints_t " nc ", gnutls_x509_subject_alt_name_t " type ", const gnutls_datum_t * " name ");" +.SH ARGUMENTS +.IP "gnutls_x509_name_constraints_t nc" 12 +The nameconstraints +.IP "gnutls_x509_subject_alt_name_t type" 12 +The type of the constraints +.IP "const gnutls_datum_t * name" 12 +The data of the constraints +.SH "DESCRIPTION" +This function will add a name constraint to the list of excluded +constraints. The constraints \fItype\fP can be any of the following types: +\fBGNUTLS_SAN_DNSNAME\fP, \fBGNUTLS_SAN_RFC822NAME\fP, \fBGNUTLS_SAN_DN\fP, +\fBGNUTLS_SAN_URI\fP, \fBGNUTLS_SAN_IPADDRESS\fP. For the latter, an IP address +in network byte order is expected, followed by its network mask (which is +4 bytes in IPv4 or 16\-bytes in IPv6). +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_name_constraints_add_permitted.3 b/doc/manpages/gnutls_x509_name_constraints_add_permitted.3 new file mode 100644 index 0000000..332749a --- /dev/null +++ b/doc/manpages/gnutls_x509_name_constraints_add_permitted.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_name_constraints_add_permitted" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_name_constraints_add_permitted \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_name_constraints_add_permitted(gnutls_x509_name_constraints_t " nc ", gnutls_x509_subject_alt_name_t " type ", const gnutls_datum_t * " name ");" +.SH ARGUMENTS +.IP "gnutls_x509_name_constraints_t nc" 12 +The nameconstraints +.IP "gnutls_x509_subject_alt_name_t type" 12 +The type of the constraints +.IP "const gnutls_datum_t * name" 12 +The data of the constraints +.SH "DESCRIPTION" +This function will add a name constraint to the list of permitted +constraints. The constraints \fItype\fP can be any of the following types: +\fBGNUTLS_SAN_DNSNAME\fP, \fBGNUTLS_SAN_RFC822NAME\fP, \fBGNUTLS_SAN_DN\fP, +\fBGNUTLS_SAN_URI\fP, \fBGNUTLS_SAN_IPADDRESS\fP. For the latter, an IP address +in network byte order is expected, followed by its network mask. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_name_constraints_check.3 b/doc/manpages/gnutls_x509_name_constraints_check.3 new file mode 100644 index 0000000..2ff0c85 --- /dev/null +++ b/doc/manpages/gnutls_x509_name_constraints_check.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_name_constraints_check" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_name_constraints_check \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_name_constraints_check(gnutls_x509_name_constraints_t " nc ", gnutls_x509_subject_alt_name_t " type ", const gnutls_datum_t * " name ");" +.SH ARGUMENTS +.IP "gnutls_x509_name_constraints_t nc" 12 +the extracted name constraints +.IP "gnutls_x509_subject_alt_name_t type" 12 +the type of the constraint to check (of type gnutls_x509_subject_alt_name_t) +.IP "const gnutls_datum_t * name" 12 +the name to be checked +.SH "DESCRIPTION" +This function will check the provided name against the constraints in + \fInc\fP using the RFC5280 rules. Currently this function is limited to DNS +names, emails and IP addresses (of type \fBGNUTLS_SAN_DNSNAME\fP, +\fBGNUTLS_SAN_RFC822NAME\fP and \fBGNUTLS_SAN_IPADDRESS\fP). +.SH "RETURNS" +zero if the provided name is not acceptable, and non\-zero otherwise. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_name_constraints_check_crt.3 b/doc/manpages/gnutls_x509_name_constraints_check_crt.3 new file mode 100644 index 0000000..c942aa2 --- /dev/null +++ b/doc/manpages/gnutls_x509_name_constraints_check_crt.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_name_constraints_check_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_name_constraints_check_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_name_constraints_check_crt(gnutls_x509_name_constraints_t " nc ", gnutls_x509_subject_alt_name_t " type ", gnutls_x509_crt_t " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_name_constraints_t nc" 12 +the extracted name constraints +.IP "gnutls_x509_subject_alt_name_t type" 12 +the type of the constraint to check (of type gnutls_x509_subject_alt_name_t) +.IP "gnutls_x509_crt_t cert" 12 +the certificate to be checked +.SH "DESCRIPTION" +This function will check the provided certificate names against the constraints in + \fInc\fP using the RFC5280 rules. It will traverse all the certificate's names and +alternative names. + +Currently this function is limited to DNS +names and emails (of type \fBGNUTLS_SAN_DNSNAME\fP and \fBGNUTLS_SAN_RFC822NAME\fP). +.SH "RETURNS" +zero if the provided name is not acceptable, and non\-zero otherwise. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_name_constraints_deinit.3 b/doc/manpages/gnutls_x509_name_constraints_deinit.3 new file mode 100644 index 0000000..183f20e --- /dev/null +++ b/doc/manpages/gnutls_x509_name_constraints_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_name_constraints_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_name_constraints_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_name_constraints_deinit(gnutls_x509_name_constraints_t " nc ");" +.SH ARGUMENTS +.IP "gnutls_x509_name_constraints_t nc" 12 +The nameconstraints +.SH "DESCRIPTION" +This function will deinitialize a name constraints type. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_name_constraints_get_excluded.3 b/doc/manpages/gnutls_x509_name_constraints_get_excluded.3 new file mode 100644 index 0000000..c8acbe9 --- /dev/null +++ b/doc/manpages/gnutls_x509_name_constraints_get_excluded.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_name_constraints_get_excluded" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_name_constraints_get_excluded \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_name_constraints_get_excluded(gnutls_x509_name_constraints_t " nc ", unsigned " idx ", unsigned * " type ", gnutls_datum_t * " name ");" +.SH ARGUMENTS +.IP "gnutls_x509_name_constraints_t nc" 12 +the extracted name constraints +.IP "unsigned idx" 12 +the index of the constraint +.IP "unsigned * type" 12 +the type of the constraint (of type gnutls_x509_subject_alt_name_t) +.IP "gnutls_datum_t * name" 12 +the name in the constraint (of the specific type) +.SH "DESCRIPTION" +This function will return an intermediate type containing +the name constraints of the provided CA certificate. That +structure can be used in combination with \fBgnutls_x509_name_constraints_check()\fP +to verify whether a server's name is in accordance with the constraints. + +The name should be treated as constant and valid for the lifetime of \fInc\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_name_constraints_get_permitted.3 b/doc/manpages/gnutls_x509_name_constraints_get_permitted.3 new file mode 100644 index 0000000..1d367c3 --- /dev/null +++ b/doc/manpages/gnutls_x509_name_constraints_get_permitted.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_name_constraints_get_permitted" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_name_constraints_get_permitted \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_name_constraints_get_permitted(gnutls_x509_name_constraints_t " nc ", unsigned " idx ", unsigned * " type ", gnutls_datum_t * " name ");" +.SH ARGUMENTS +.IP "gnutls_x509_name_constraints_t nc" 12 +the extracted name constraints +.IP "unsigned idx" 12 +the index of the constraint +.IP "unsigned * type" 12 +the type of the constraint (of type gnutls_x509_subject_alt_name_t) +.IP "gnutls_datum_t * name" 12 +the name in the constraint (of the specific type) +.SH "DESCRIPTION" +This function will return an intermediate type containing +the name constraints of the provided CA certificate. That +structure can be used in combination with \fBgnutls_x509_name_constraints_check()\fP +to verify whether a server's name is in accordance with the constraints. + +The name should be treated as constant and valid for the lifetime of \fInc\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the extension is not present, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_name_constraints_init.3 b/doc/manpages/gnutls_x509_name_constraints_init.3 new file mode 100644 index 0000000..c9f4715 --- /dev/null +++ b/doc/manpages/gnutls_x509_name_constraints_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_name_constraints_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_name_constraints_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_name_constraints_init(gnutls_x509_name_constraints_t * " nc ");" +.SH ARGUMENTS +.IP "gnutls_x509_name_constraints_t * nc" 12 +The nameconstraints +.SH "DESCRIPTION" +This function will initialize a name constraints type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_othername_to_virtual.3 b/doc/manpages/gnutls_x509_othername_to_virtual.3 new file mode 100644 index 0000000..0aae1b7 --- /dev/null +++ b/doc/manpages/gnutls_x509_othername_to_virtual.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_othername_to_virtual" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_othername_to_virtual \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_othername_to_virtual(const char * " oid ", const gnutls_datum_t * " othername ", unsigned int * " virt_type ", gnutls_datum_t * " virt ");" +.SH ARGUMENTS +.IP "const char * oid" 12 +The othername object identifier +.IP "const gnutls_datum_t * othername" 12 +The othername data +.IP "unsigned int * virt_type" 12 +GNUTLS_SAN_OTHERNAME_XXX +.IP "gnutls_datum_t * virt" 12 +allocated printable data +.SH "DESCRIPTION" +This function will parse and convert the othername data to a virtual +type supported by gnutls. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_policies_deinit.3 b/doc/manpages/gnutls_x509_policies_deinit.3 new file mode 100644 index 0000000..7b349ba --- /dev/null +++ b/doc/manpages/gnutls_x509_policies_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_policies_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_policies_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "void gnutls_x509_policies_deinit(gnutls_x509_policies_t " policies ");" +.SH ARGUMENTS +.IP "gnutls_x509_policies_t policies" 12 +The authority key identifier +.SH "DESCRIPTION" +This function will deinitialize an authority key identifier type. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_policies_get.3 b/doc/manpages/gnutls_x509_policies_get.3 new file mode 100644 index 0000000..2fb78de --- /dev/null +++ b/doc/manpages/gnutls_x509_policies_get.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_policies_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_policies_get \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_policies_get(gnutls_x509_policies_t " policies ", unsigned int " seq ", struct gnutls_x509_policy_st * " policy ");" +.SH ARGUMENTS +.IP "gnutls_x509_policies_t policies" 12 +The policies +.IP "unsigned int seq" 12 +The index of the name to get +.IP "struct gnutls_x509_policy_st * policy" 12 +Will hold the policy +.SH "DESCRIPTION" +This function will return a specific policy as stored in +the \fIpolicies\fP type. The returned values should be treated as constant +and valid for the lifetime of \fIpolicies\fP . + +The any policy OID is available as the \fBGNUTLS_X509_OID_POLICY_ANY\fP macro. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +if the index is out of bounds, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_policies_init.3 b/doc/manpages/gnutls_x509_policies_init.3 new file mode 100644 index 0000000..be3dea3 --- /dev/null +++ b/doc/manpages/gnutls_x509_policies_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_policies_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_policies_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_policies_init(gnutls_x509_policies_t * " policies ");" +.SH ARGUMENTS +.IP "gnutls_x509_policies_t * policies" 12 +The authority key ID +.SH "DESCRIPTION" +This function will initialize an authority key ID type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_policies_set.3 b/doc/manpages/gnutls_x509_policies_set.3 new file mode 100644 index 0000000..f7d3245 --- /dev/null +++ b/doc/manpages/gnutls_x509_policies_set.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_policies_set" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_policies_set \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_policies_set(gnutls_x509_policies_t " policies ", const struct gnutls_x509_policy_st * " policy ");" +.SH ARGUMENTS +.IP "gnutls_x509_policies_t policies" 12 +An initialized policies +.IP "const struct gnutls_x509_policy_st * policy" 12 +Contains the policy to set +.SH "DESCRIPTION" +This function will store the specified policy in +the provided \fIpolicies\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0), otherwise a negative error value. +.SH "SINCE" +3.3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_policy_release.3 b/doc/manpages/gnutls_x509_policy_release.3 new file mode 100644 index 0000000..5bcac4f --- /dev/null +++ b/doc/manpages/gnutls_x509_policy_release.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_policy_release" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_policy_release \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_policy_release(struct gnutls_x509_policy_st * " policy ");" +.SH ARGUMENTS +.IP "struct gnutls_x509_policy_st * policy" 12 +a certificate policy +.SH "DESCRIPTION" +This function will deinitialize all memory associated with the provided + \fIpolicy\fP . The policy is allocated using \fBgnutls_x509_crt_get_policy()\fP. +.SH "SINCE" +3.1.5 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_cpy.3 b/doc/manpages/gnutls_x509_privkey_cpy.3 new file mode 100644 index 0000000..fc53f82 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_cpy.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_cpy" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_cpy \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_cpy(gnutls_x509_privkey_t " dst ", gnutls_x509_privkey_t " src ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t dst" 12 +The destination key, which should be initialized. +.IP "gnutls_x509_privkey_t src" 12 +The source key +.SH "DESCRIPTION" +This function will copy a private key from source to destination +key. Destination has to be initialized. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_deinit.3 b/doc/manpages/gnutls_x509_privkey_deinit.3 new file mode 100644 index 0000000..ce27f4b --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_deinit.3 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_privkey_deinit(gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The key to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize a private key structure. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_export.3 b/doc/manpages/gnutls_x509_privkey_export.3 new file mode 100644 index 0000000..537f4ca --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_export(gnutls_x509_privkey_t " key ", gnutls_x509_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +Holds the key +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "void * output_data" 12 +will contain a private key PEM or DER encoded +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the private key to a PKCS\fB1\fP structure for +RSA or RSA\-PSS keys, and integer sequence for DSA keys. Other keys types +will be exported in PKCS\fB8\fP form. + +If the structure is PEM encoded, it will have a header +of "BEGIN RSA PRIVATE KEY". + +It is recommended to use \fBgnutls_x509_privkey_export_pkcs8()\fP instead +of this function, when a consistent output format is required. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_export2.3 b/doc/manpages/gnutls_x509_privkey_export2.3 new file mode 100644 index 0000000..56d86e4 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export2.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_export2(gnutls_x509_privkey_t " key ", gnutls_x509_crt_fmt_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +Holds the key +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "gnutls_datum_t * out" 12 +will contain a private key PEM or DER encoded +.SH "DESCRIPTION" +This function will export the private key to a PKCS\fB1\fP structure for +RSA or RSA\-PSS keys, and integer sequence for DSA keys. Other keys types +will be exported in PKCS\fB8\fP form. + +The output buffer is allocated using \fBgnutls_malloc()\fP. + +It is recommended to use \fBgnutls_x509_privkey_export2_pkcs8()\fP instead +of this function, when a consistent output format is required. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. + +Since 3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_export2_pkcs8.3 b/doc/manpages/gnutls_x509_privkey_export2_pkcs8.3 new file mode 100644 index 0000000..433f4d3 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export2_pkcs8.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export2_pkcs8" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export2_pkcs8 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_export2_pkcs8(gnutls_x509_privkey_t " key ", gnutls_x509_crt_fmt_t " format ", const char * " password ", unsigned int " flags ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +Holds the key +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "const char * password" 12 +the password that will be used to encrypt the key. +.IP "unsigned int flags" 12 +an ORed sequence of gnutls_pkcs_encrypt_flags_t +.IP "gnutls_datum_t * out" 12 +will contain a private key PEM or DER encoded +.SH "DESCRIPTION" +This function will export the private key to a PKCS8 structure. +Both RSA and DSA keys can be exported. For DSA keys we use +PKCS \fB11\fP definitions. If the flags do not specify the encryption +cipher, then the default 3DES (PBES2) will be used. + +The \fIpassword\fP can be either ASCII or UTF\-8 in the default PBES2 +encryption schemas, or ASCII for the PKCS12 schemas. + +The output buffer is allocated using \fBgnutls_malloc()\fP. + +If the structure is PEM encoded, it will have a header +of "BEGIN ENCRYPTED PRIVATE KEY" or "BEGIN PRIVATE KEY" if +encryption is not used. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. + +Since 3.1.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_export_dsa_raw.3 b/doc/manpages/gnutls_x509_privkey_export_dsa_raw.3 new file mode 100644 index 0000000..6375957 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_dsa_raw.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_dsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_dsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_export_dsa_raw(gnutls_x509_privkey_t " key ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ", gnutls_datum_t * " x ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.IP "gnutls_datum_t * p" 12 +will hold the p +.IP "gnutls_datum_t * q" 12 +will hold the q +.IP "gnutls_datum_t * g" 12 +will hold the g +.IP "gnutls_datum_t * y" 12 +will hold the y +.IP "gnutls_datum_t * x" 12 +will hold the x +.SH "DESCRIPTION" +This function will export the DSA private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_export_ecc_raw.3 b/doc/manpages/gnutls_x509_privkey_export_ecc_raw.3 new file mode 100644 index 0000000..cc9b05f --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_ecc_raw.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_ecc_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_ecc_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_export_ecc_raw(gnutls_x509_privkey_t " key ", gnutls_ecc_curve_t * " curve ", gnutls_datum_t * " x ", gnutls_datum_t * " y ", gnutls_datum_t * " k ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve +.IP "gnutls_datum_t * x" 12 +will hold the x\-coordinate +.IP "gnutls_datum_t * y" 12 +will hold the y\-coordinate +.IP "gnutls_datum_t * k" 12 +will hold the private key +.SH "DESCRIPTION" +This function will export the ECC private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. + +In EdDSA curves the \fIy\fP parameter will be \fBNULL\fP and the other parameters +will be in the native format for the curve. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_export_gost_raw.3 b/doc/manpages/gnutls_x509_privkey_export_gost_raw.3 new file mode 100644 index 0000000..3d859f3 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_gost_raw.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_gost_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_gost_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_export_gost_raw(gnutls_x509_privkey_t " key ", gnutls_ecc_curve_t * " curve ", gnutls_digest_algorithm_t * " digest ", gnutls_gost_paramset_t * " paramset ", gnutls_datum_t * " x ", gnutls_datum_t * " y ", gnutls_datum_t * " k ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.IP "gnutls_ecc_curve_t * curve" 12 +will hold the curve +.IP "gnutls_digest_algorithm_t * digest" 12 +will hold the digest +.IP "gnutls_gost_paramset_t * paramset" 12 +will hold the GOST parameter set ID +.IP "gnutls_datum_t * x" 12 +will hold the x\-coordinate +.IP "gnutls_datum_t * y" 12 +will hold the y\-coordinate +.IP "gnutls_datum_t * k" 12 +will hold the private key +.SH "DESCRIPTION" +This function will export the GOST private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "NOTE" +parameters will be stored with least significant byte first. On +version 3.6.3 this was incorrectly returned in big\-endian format. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_export_pkcs8.3 b/doc/manpages/gnutls_x509_privkey_export_pkcs8.3 new file mode 100644 index 0000000..d58aac5 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_pkcs8.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_pkcs8" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_pkcs8 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_export_pkcs8(gnutls_x509_privkey_t " key ", gnutls_x509_crt_fmt_t " format ", const char * " password ", unsigned int " flags ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +Holds the key +.IP "gnutls_x509_crt_fmt_t format" 12 +the format of output params. One of PEM or DER. +.IP "const char * password" 12 +the password that will be used to encrypt the key. +.IP "unsigned int flags" 12 +an ORed sequence of gnutls_pkcs_encrypt_flags_t +.IP "void * output_data" 12 +will contain a private key PEM or DER encoded +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will export the private key to a PKCS8 structure. +Both RSA and DSA keys can be exported. For DSA keys we use +PKCS \fB11\fP definitions. If the flags do not specify the encryption +cipher, then the default 3DES (PBES2) will be used. + +The \fIpassword\fP can be either ASCII or UTF\-8 in the default PBES2 +encryption schemas, or ASCII for the PKCS12 schemas. + +If the buffer provided is not long enough to hold the output, then +*output_data_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will +be returned. + +If the structure is PEM encoded, it will have a header +of "BEGIN ENCRYPTED PRIVATE KEY" or "BEGIN PRIVATE KEY" if +encryption is not used. +.SH "RETURNS" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_export_rsa_raw.3 b/doc/manpages/gnutls_x509_privkey_export_rsa_raw.3 new file mode 100644 index 0000000..b25bb2f --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_rsa_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_rsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_rsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_export_rsa_raw(gnutls_x509_privkey_t " key ", gnutls_datum_t * " m ", gnutls_datum_t * " e ", gnutls_datum_t * " d ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " u ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.IP "gnutls_datum_t * m" 12 +will hold the modulus +.IP "gnutls_datum_t * e" 12 +will hold the public exponent +.IP "gnutls_datum_t * d" 12 +will hold the private exponent +.IP "gnutls_datum_t * p" 12 +will hold the first prime (p) +.IP "gnutls_datum_t * q" 12 +will hold the second prime (q) +.IP "gnutls_datum_t * u" 12 +will hold the coefficient +.SH "DESCRIPTION" +This function will export the RSA private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_export_rsa_raw2.3 b/doc/manpages/gnutls_x509_privkey_export_rsa_raw2.3 new file mode 100644 index 0000000..1da74c0 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_rsa_raw2.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_rsa_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_rsa_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_export_rsa_raw2(gnutls_x509_privkey_t " key ", gnutls_datum_t * " m ", gnutls_datum_t * " e ", gnutls_datum_t * " d ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " u ", gnutls_datum_t * " e1 ", gnutls_datum_t * " e2 ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.IP "gnutls_datum_t * m" 12 +will hold the modulus +.IP "gnutls_datum_t * e" 12 +will hold the public exponent +.IP "gnutls_datum_t * d" 12 +will hold the private exponent +.IP "gnutls_datum_t * p" 12 +will hold the first prime (p) +.IP "gnutls_datum_t * q" 12 +will hold the second prime (q) +.IP "gnutls_datum_t * u" 12 +will hold the coefficient +.IP "gnutls_datum_t * e1" 12 +will hold e1 = d mod (p\-1) +.IP "gnutls_datum_t * e2" 12 +will hold e2 = d mod (q\-1) +.SH "DESCRIPTION" +This function will export the RSA private key's parameters found +in the given structure. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_fix.3 b/doc/manpages/gnutls_x509_privkey_fix.3 new file mode 100644 index 0000000..8bcb850 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_fix.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_fix" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_fix \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_fix(gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.SH "DESCRIPTION" +This function will recalculate the secondary parameters in a key. +In RSA keys, this can be the coefficient and exponent1,2. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_generate.3 b/doc/manpages/gnutls_x509_privkey_generate.3 new file mode 100644 index 0000000..d34e954 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_generate.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_generate" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_generate \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_generate(gnutls_x509_privkey_t " key ", gnutls_pk_algorithm_t " algo ", unsigned int " bits ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +an initialized key +.IP "gnutls_pk_algorithm_t algo" 12 +is one of the algorithms in \fBgnutls_pk_algorithm_t\fP. +.IP "unsigned int bits" 12 +the size of the parameters to generate +.IP "unsigned int flags" 12 +Must be zero or flags from \fBgnutls_privkey_flags_t\fP. +.SH "DESCRIPTION" +This function will generate a random private key. Note that this +function must be called on an initialized private key. + +The flag \fBGNUTLS_PRIVKEY_FLAG_PROVABLE\fP +instructs the key generation process to use algorithms like Shawe\-Taylor +(from FIPS PUB186\-4) which generate provable parameters out of a seed +for RSA and DSA keys. See \fBgnutls_x509_privkey_generate2()\fP for more +information. + +Note that when generating an elliptic curve key, the curve +can be substituted in the place of the bits parameter using the +\fBGNUTLS_CURVE_TO_BITS()\fP macro. The input to the macro is any curve from +\fBgnutls_ecc_curve_t\fP. + +For DSA keys, if the subgroup size needs to be specified check +the \fBGNUTLS_SUBGROUP_TO_BITS()\fP macro. + +It is recommended to do not set the number of \fIbits\fP directly, use \fBgnutls_sec_param_to_pk_bits()\fP instead . + +See also \fBgnutls_privkey_generate()\fP, \fBgnutls_x509_privkey_generate2()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_generate2.3 b/doc/manpages/gnutls_x509_privkey_generate2.3 new file mode 100644 index 0000000..1e45bc5 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_generate2.3 @@ -0,0 +1,72 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_generate2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_generate2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_generate2(gnutls_x509_privkey_t " key ", gnutls_pk_algorithm_t " algo ", unsigned int " bits ", unsigned int " flags ", const gnutls_keygen_data_st * " data ", unsigned " data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.IP "gnutls_pk_algorithm_t algo" 12 +is one of the algorithms in \fBgnutls_pk_algorithm_t\fP. +.IP "unsigned int bits" 12 +the size of the modulus +.IP "unsigned int flags" 12 +Must be zero or flags from \fBgnutls_privkey_flags_t\fP. +.IP "const gnutls_keygen_data_st * data" 12 +Allow specifying \fBgnutls_keygen_data_st\fP types such as the seed to be used. +.IP "unsigned data_size" 12 +The number of \fIdata\fP available. +.SH "DESCRIPTION" +This function will generate a random private key. Note that this +function must be called on an initialized private key. + +The flag \fBGNUTLS_PRIVKEY_FLAG_PROVABLE\fP +instructs the key generation process to use algorithms like Shawe\-Taylor +(from FIPS PUB186\-4) which generate provable parameters out of a seed +for RSA and DSA keys. On DSA keys the PQG parameters are generated using the +seed, while on RSA the two primes. To specify an explicit seed +(by default a random seed is used), use the \fIdata\fP with a \fBGNUTLS_KEYGEN_SEED\fP +type. + +Note that when generating an elliptic curve key, the curve +can be substituted in the place of the bits parameter using the +\fBGNUTLS_CURVE_TO_BITS()\fP macro. + +To export the generated keys in memory or in files it is recommended to use the +PKCS\fB8\fP form as it can handle all key types, and can store additional parameters +such as the seed, in case of provable RSA or DSA keys. +Generated keys can be exported in memory using \fBgnutls_privkey_export_x509()\fP, +and then with \fBgnutls_x509_privkey_export2_pkcs8()\fP. + +If key generation is part of your application, avoid setting the number +of bits directly, and instead use \fBgnutls_sec_param_to_pk_bits()\fP. +That way the generated keys will adapt to the security levels +of the underlying GnuTLS library. + +See also \fBgnutls_privkey_generate2()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_get_key_id.3 b/doc/manpages/gnutls_x509_privkey_get_key_id.3 new file mode 100644 index 0000000..a4be1c0 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_get_key_id.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_get_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_get_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_get_key_id(gnutls_x509_privkey_t " key ", unsigned int " flags ", unsigned char * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.IP "unsigned int flags" 12 +should be one of the flags from \fBgnutls_keyid_flags_t\fP +.IP "unsigned char * output_data" 12 +will contain the key ID +.IP "size_t * output_data_size" 12 +holds the size of output_data (and will be +replaced by the actual size of parameters) +.SH "DESCRIPTION" +This function will return a unique ID that depends on the public key +parameters. This ID can be used in checking whether a certificate +corresponds to the given key. + +If the buffer provided is not long enough to hold the output, then +* \fIoutput_data_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will +be returned. The output will normally be a SHA\-1 hash output, +which is 20 bytes. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_get_pk_algorithm.3 b/doc/manpages/gnutls_x509_privkey_get_pk_algorithm.3 new file mode 100644 index 0000000..f401631 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_get_pk_algorithm.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_get_pk_algorithm" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_get_pk_algorithm(gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +should contain a \fBgnutls_x509_privkey_t\fP type +.SH "DESCRIPTION" +This function will return the public key algorithm of a private +key. +.SH "RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_get_pk_algorithm2.3 b/doc/manpages/gnutls_x509_privkey_get_pk_algorithm2.3 new file mode 100644 index 0000000..e402e1f --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_get_pk_algorithm2.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_get_pk_algorithm2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_get_pk_algorithm2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_get_pk_algorithm2(gnutls_x509_privkey_t " key ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +should contain a \fBgnutls_x509_privkey_t\fP type +.IP "unsigned int * bits" 12 +The number of bits in the public key algorithm +.SH "DESCRIPTION" +This function will return the public key algorithm of a private +key. +.SH "RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_get_seed.3 b/doc/manpages/gnutls_x509_privkey_get_seed.3 new file mode 100644 index 0000000..cb1e8fd --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_get_seed.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_get_seed" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_get_seed \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_get_seed(gnutls_x509_privkey_t " key ", gnutls_digest_algorithm_t * " digest ", void * " seed ", size_t * " seed_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +should contain a \fBgnutls_x509_privkey_t\fP type +.IP "gnutls_digest_algorithm_t * digest" 12 +if non\-NULL it will contain the digest algorithm used for key generation (if applicable) +.IP "void * seed" 12 +where seed will be copied to +.IP "size_t * seed_size" 12 +originally holds the size of \fIseed\fP , will be updated with actual size +.SH "DESCRIPTION" +This function will return the seed that was used to generate the +given private key. That function will succeed only if the key was generated +as a provable key. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_get_spki.3 b/doc/manpages/gnutls_x509_privkey_get_spki.3 new file mode 100644 index 0000000..f31afa0 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_get_spki.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_get_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_get_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_get_spki(gnutls_x509_privkey_t " key ", gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +should contain a \fBgnutls_x509_privkey_t\fP type +.IP "gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_x509_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will return the public key information of a private +key. The provided \fIspki\fP must be initialized. +.SH "RETURNS" +Zero on success, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_import.3 b/doc/manpages/gnutls_x509_privkey_import.3 new file mode 100644 index 0000000..cdc413c --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_import(gnutls_x509_privkey_t " key ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The data to store the parsed key +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded certificate. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM +.SH "DESCRIPTION" +This function will convert the given DER or PEM encoded key to the +native \fBgnutls_x509_privkey_t\fP format. The output will be stored in + \fIkey\fP . + +If the key is PEM encoded it should have a header that contains "PRIVATE +KEY". Note that this function falls back to PKCS \fB8\fP decoding without +password, if the default format fails to import. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_import2.3 b/doc/manpages/gnutls_x509_privkey_import2.3 new file mode 100644 index 0000000..23c6393 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import2.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_import2(gnutls_x509_privkey_t " key ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", const char * " password ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The data to store the parsed key +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded key. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM +.IP "const char * password" 12 +A password (optional) +.IP "unsigned int flags" 12 +an ORed sequence of gnutls_pkcs_encrypt_flags_t +.SH "DESCRIPTION" +This function will import the given DER or PEM encoded key, to +the native \fBgnutls_x509_privkey_t\fP format, irrespective of the +input format. The input format is auto\-detected. + +The supported formats are basic unencrypted key, PKCS8, PKCS12, +and the openssl format. + +If the provided key is encrypted but no password was given, then +\fBGNUTLS_E_DECRYPTION_FAILED\fP is returned. Since GnuTLS 3.4.0 this +function will utilize the PIN callbacks if any. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_import_dsa_raw.3 b/doc/manpages/gnutls_x509_privkey_import_dsa_raw.3 new file mode 100644 index 0000000..8e2cc5f --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_dsa_raw.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_dsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_dsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_import_dsa_raw(gnutls_x509_privkey_t " key ", const gnutls_datum_t * " p ", const gnutls_datum_t * " q ", const gnutls_datum_t * " g ", const gnutls_datum_t * " y ", const gnutls_datum_t * " x ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The data to store the parsed key +.IP "const gnutls_datum_t * p" 12 +holds the p +.IP "const gnutls_datum_t * q" 12 +holds the q +.IP "const gnutls_datum_t * g" 12 +holds the g +.IP "const gnutls_datum_t * y" 12 +holds the y (optional) +.IP "const gnutls_datum_t * x" 12 +holds the x +.SH "DESCRIPTION" +This function will convert the given DSA raw parameters to the +native \fBgnutls_x509_privkey_t\fP format. The output will be stored +in \fIkey\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_import_ecc_raw.3 b/doc/manpages/gnutls_x509_privkey_import_ecc_raw.3 new file mode 100644 index 0000000..f7b319a --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_ecc_raw.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_ecc_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_ecc_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_import_ecc_raw(gnutls_x509_privkey_t " key ", gnutls_ecc_curve_t " curve ", const gnutls_datum_t * " x ", const gnutls_datum_t * " y ", const gnutls_datum_t * " k ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The data to store the parsed key +.IP "gnutls_ecc_curve_t curve" 12 +holds the curve +.IP "const gnutls_datum_t * x" 12 +holds the x\-coordinate +.IP "const gnutls_datum_t * y" 12 +holds the y\-coordinate +.IP "const gnutls_datum_t * k" 12 +holds the k +.SH "DESCRIPTION" +This function will convert the given elliptic curve parameters to the +native \fBgnutls_x509_privkey_t\fP format. The output will be stored +in \fIkey\fP . For EdDSA keys, the \fIx\fP and \fIk\fP values must be in the +native to curve format. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_import_gost_raw.3 b/doc/manpages/gnutls_x509_privkey_import_gost_raw.3 new file mode 100644 index 0000000..8af0452 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_gost_raw.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_gost_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_gost_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_import_gost_raw(gnutls_x509_privkey_t " key ", gnutls_ecc_curve_t " curve ", gnutls_digest_algorithm_t " digest ", gnutls_gost_paramset_t " paramset ", const gnutls_datum_t * " x ", const gnutls_datum_t * " y ", const gnutls_datum_t * " k ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The data to store the parsed key +.IP "gnutls_ecc_curve_t curve" 12 +holds the curve +.IP "gnutls_digest_algorithm_t digest" 12 +will hold the digest +.IP "gnutls_gost_paramset_t paramset" 12 +will hold the GOST parameter set ID +.IP "const gnutls_datum_t * x" 12 +holds the x\-coordinate +.IP "const gnutls_datum_t * y" 12 +holds the y\-coordinate +.IP "const gnutls_datum_t * k" 12 +holds the k (private key) +.SH "DESCRIPTION" +This function will convert the given GOST private key's parameters to the +native \fBgnutls_x509_privkey_t\fP format. The output will be stored +in \fIkey\fP . \fIdigest\fP should be one of GNUTLS_DIG_GOSR_94, +GNUTLS_DIG_STREEBOG_256 or GNUTLS_DIG_STREEBOG_512. If \fIparamset\fP is set to +GNUTLS_GOST_PARAMSET_UNKNOWN default one will be selected depending on + \fIdigest\fP . +.SH "NOTE" +parameters should be stored with least significant byte first. On +version 3.6.3 big\-endian format was used incorrectly. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.3 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_import_openssl.3 b/doc/manpages/gnutls_x509_privkey_import_openssl.3 new file mode 100644 index 0000000..9ffdf86 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_openssl.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_openssl" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_openssl \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_import_openssl(gnutls_x509_privkey_t " key ", const gnutls_datum_t * " data ", const char * " password ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The data to store the parsed key +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded key. +.IP "const char * password" 12 +the password to decrypt the key (if it is encrypted). +.SH "DESCRIPTION" +This function will convert the given PEM encrypted to +the native gnutls_x509_privkey_t format. The +output will be stored in \fIkey\fP . + +The \fIpassword\fP should be in ASCII. If the password is not provided +or wrong then \fBGNUTLS_E_DECRYPTION_FAILED\fP will be returned. + +If the Certificate is PEM encoded it should have a header of +"PRIVATE KEY" and the "DEK\-Info" header. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_import_pkcs8.3 b/doc/manpages/gnutls_x509_privkey_import_pkcs8.3 new file mode 100644 index 0000000..e66386e --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_pkcs8.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_pkcs8" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_pkcs8 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_import_pkcs8(gnutls_x509_privkey_t " key ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", const char * " password ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The data to store the parsed key +.IP "const gnutls_datum_t * data" 12 +The DER or PEM encoded key. +.IP "gnutls_x509_crt_fmt_t format" 12 +One of DER or PEM +.IP "const char * password" 12 +the password to decrypt the key (if it is encrypted). +.IP "unsigned int flags" 12 +0 if encrypted or GNUTLS_PKCS_PLAIN if not encrypted. +.SH "DESCRIPTION" +This function will convert the given DER or PEM encoded PKCS8 2.0 +encrypted key to the native gnutls_x509_privkey_t format. The +output will be stored in \fIkey\fP . Both RSA and DSA keys can be +imported, and flags can only be used to indicate an unencrypted +key. + +The \fIpassword\fP can be either ASCII or UTF\-8 in the default PBES2 +encryption schemas, or ASCII for the PKCS12 schemas. + +If the Certificate is PEM encoded it should have a header of +"ENCRYPTED PRIVATE KEY", or "PRIVATE KEY". You only need to +specify the flags if the key is DER encoded, since in that case +the encryption status cannot be auto\-detected. + +If the \fBGNUTLS_PKCS_PLAIN\fP flag is specified and the supplied data +are encrypted then \fBGNUTLS_E_DECRYPTION_FAILED\fP is returned. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_import_rsa_raw.3 b/doc/manpages/gnutls_x509_privkey_import_rsa_raw.3 new file mode 100644 index 0000000..8ebda4a --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_rsa_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_rsa_raw" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_rsa_raw \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_import_rsa_raw(gnutls_x509_privkey_t " key ", const gnutls_datum_t * " m ", const gnutls_datum_t * " e ", const gnutls_datum_t * " d ", const gnutls_datum_t * " p ", const gnutls_datum_t * " q ", const gnutls_datum_t * " u ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The data to store the parsed key +.IP "const gnutls_datum_t * m" 12 +holds the modulus +.IP "const gnutls_datum_t * e" 12 +holds the public exponent +.IP "const gnutls_datum_t * d" 12 +holds the private exponent +.IP "const gnutls_datum_t * p" 12 +holds the first prime (p) +.IP "const gnutls_datum_t * q" 12 +holds the second prime (q) +.IP "const gnutls_datum_t * u" 12 +holds the coefficient +.SH "DESCRIPTION" +This function will convert the given RSA raw parameters to the +native \fBgnutls_x509_privkey_t\fP format. The output will be stored in + \fIkey\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_import_rsa_raw2.3 b/doc/manpages/gnutls_x509_privkey_import_rsa_raw2.3 new file mode 100644 index 0000000..0b1e29b --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_rsa_raw2.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_rsa_raw2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_rsa_raw2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_import_rsa_raw2(gnutls_x509_privkey_t " key ", const gnutls_datum_t * " m ", const gnutls_datum_t * " e ", const gnutls_datum_t * " d ", const gnutls_datum_t * " p ", const gnutls_datum_t * " q ", const gnutls_datum_t * " u ", const gnutls_datum_t * " e1 ", const gnutls_datum_t * " e2 ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The data to store the parsed key +.IP "const gnutls_datum_t * m" 12 +holds the modulus +.IP "const gnutls_datum_t * e" 12 +holds the public exponent +.IP "const gnutls_datum_t * d" 12 +holds the private exponent +.IP "const gnutls_datum_t * p" 12 +holds the first prime (p) +.IP "const gnutls_datum_t * q" 12 +holds the second prime (q) +.IP "const gnutls_datum_t * u" 12 +holds the coefficient (optional) +.IP "const gnutls_datum_t * e1" 12 +holds e1 = d mod (p\-1) (optional) +.IP "const gnutls_datum_t * e2" 12 +holds e2 = d mod (q\-1) (optional) +.SH "DESCRIPTION" +This function will convert the given RSA raw parameters to the +native \fBgnutls_x509_privkey_t\fP format. The output will be stored in + \fIkey\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_init.3 b/doc/manpages/gnutls_x509_privkey_init.3 new file mode 100644 index 0000000..f3d6483 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_init.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_init(gnutls_x509_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t * key" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a private key type. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_sec_param.3 b/doc/manpages/gnutls_x509_privkey_sec_param.3 new file mode 100644 index 0000000..fd8337c --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_sec_param.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_sec_param" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_sec_param \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "gnutls_sec_param_t gnutls_x509_privkey_sec_param(gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.SH "DESCRIPTION" +This function will return the security parameter appropriate with +this private key. +.SH "RETURNS" +On success, a valid security parameter is returned otherwise +\fBGNUTLS_SEC_PARAM_UNKNOWN\fP is returned. +.SH "SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_set_flags.3 b/doc/manpages/gnutls_x509_privkey_set_flags.3 new file mode 100644 index 0000000..c2c9123 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_set_flags.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_set_flags" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_set_flags \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_privkey_set_flags(gnutls_x509_privkey_t " key ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +A key of type \fBgnutls_x509_privkey_t\fP +.IP "unsigned int flags" 12 +flags from the \fBgnutls_privkey_flags\fP +.SH "DESCRIPTION" +This function will set flags for the specified private key, after +it is generated. Currently this is useful for the \fBGNUTLS_PRIVKEY_FLAG_EXPORT_COMPAT\fP +to allow exporting a "provable" private key in backwards compatible way. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_set_pin_function.3 b/doc/manpages/gnutls_x509_privkey_set_pin_function.3 new file mode 100644 index 0000000..98907c4 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_set_pin_function.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_set_pin_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_set_pin_function \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_privkey_set_pin_function(gnutls_x509_privkey_t " privkey ", gnutls_pin_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t privkey" 12 +The certificate structure +.IP "gnutls_pin_callback_t fn" 12 +the callback +.IP "void * userdata" 12 +data associated with the callback +.SH "DESCRIPTION" +This function will set a callback function to be used when +it is required to access a protected object. This function overrides +the global function set using \fBgnutls_pkcs11_set_pin_function()\fP. + +Note that this callback is used when decrypting a key. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_set_spki.3 b/doc/manpages/gnutls_x509_privkey_set_spki.3 new file mode 100644 index 0000000..d58b5d5 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_set_spki.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_set_spki" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_set_spki \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_set_spki(gnutls_x509_privkey_t " key ", const gnutls_x509_spki_t " spki ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +should contain a \fBgnutls_x509_privkey_t\fP type +.IP "const gnutls_x509_spki_t spki" 12 +a SubjectPublicKeyInfo structure of type \fBgnutls_x509_spki_t\fP +.IP "unsigned int flags" 12 +must be zero +.SH "DESCRIPTION" +This function will return the public key information of a private +key. The provided \fIspki\fP must be initialized. +.SH "RETURNS" +Zero on success, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_sign_data.3 b/doc/manpages/gnutls_x509_privkey_sign_data.3 new file mode 100644 index 0000000..dc08360 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_sign_data.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_sign_data" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_sign_data \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_sign_data(gnutls_x509_privkey_t " key ", gnutls_digest_algorithm_t " digest ", unsigned int " flags ", const gnutls_datum_t * " data ", void * " signature ", size_t * " signature_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.IP "gnutls_digest_algorithm_t digest" 12 +should be a digest algorithm +.IP "unsigned int flags" 12 +should be 0 for now +.IP "const gnutls_datum_t * data" 12 +holds the data to be signed +.IP "void * signature" 12 +will contain the signature +.IP "size_t * signature_size" 12 +holds the size of signature (and will be replaced +by the new size) +.SH "DESCRIPTION" +This function will sign the given data using a signature algorithm +supported by the private key. Signature algorithms are always used +together with a hash functions. Different hash functions may be +used for the RSA algorithm, but only SHA\-1 for the DSA keys. + +If the buffer provided is not long enough to hold the output, then +* \fIsignature_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will +be returned. + +Use \fBgnutls_x509_crt_get_preferred_hash_algorithm()\fP to determine +the hash algorithm. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_sign_hash.3 b/doc/manpages/gnutls_x509_privkey_sign_hash.3 new file mode 100644 index 0000000..ff18020 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_sign_hash.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_sign_hash" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_sign_hash \- API function +.SH SYNOPSIS +.B #include <gnutls/compat.h> +.sp +.BI "int gnutls_x509_privkey_sign_hash(gnutls_x509_privkey_t " key ", const gnutls_datum_t * " hash ", gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.IP "const gnutls_datum_t * hash" 12 +holds the data to be signed +.IP "gnutls_datum_t * signature" 12 +will contain newly allocated signature +.SH "DESCRIPTION" +This function will sign the given hash using the private key. Do not +use this function directly unless you know what it is. Typical signing +requires the data to be hashed and stored in special formats +(e.g. BER Digest\-Info for RSA). + +This API is provided only for backwards compatibility, and thus +restricted to RSA, DSA and ECDSA key types. For other key types please +use \fBgnutls_privkey_sign_hash()\fP and \fBgnutls_privkey_sign_data()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. + +Deprecated in: 2.12.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_verify_params.3 b/doc/manpages/gnutls_x509_privkey_verify_params.3 new file mode 100644 index 0000000..c55ccdf --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_verify_params.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_verify_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_verify_params \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_verify_params(gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +a key +.SH "DESCRIPTION" +This function will verify the private key parameters. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_privkey_verify_seed.3 b/doc/manpages/gnutls_x509_privkey_verify_seed.3 new file mode 100644 index 0000000..206fc6e --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_verify_seed.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_verify_seed" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_verify_seed \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_privkey_verify_seed(gnutls_x509_privkey_t " key ", gnutls_digest_algorithm_t " digest ", const void * " seed ", size_t " seed_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +should contain a \fBgnutls_x509_privkey_t\fP type +.IP "gnutls_digest_algorithm_t digest" 12 +it contains the digest algorithm used for key generation (if applicable) +.IP "const void * seed" 12 +the seed of the key to be checked with +.IP "size_t seed_size" 12 +holds the size of \fIseed\fP +.SH "DESCRIPTION" +This function will verify that the given private key was generated from +the provided seed. If \fIseed\fP is \fBNULL\fP then the seed stored in the \fIkey\fP 's structure +will be used for verification. +.SH "RETURNS" +In case of a verification failure \fBGNUTLS_E_PRIVKEY_VERIFICATION_ERROR\fP +is returned, and zero or positive code on success. +.SH "SINCE" +3.5.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_rdn_get.3 b/doc/manpages/gnutls_x509_rdn_get.3 new file mode 100644 index 0000000..4769a4a --- /dev/null +++ b/doc/manpages/gnutls_x509_rdn_get.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_rdn_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_rdn_get \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_rdn_get(const gnutls_datum_t * " idn ", char * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * idn" 12 +should contain a DER encoded RDN sequence +.IP "char * buf" 12 +a pointer to a structure to hold the peer's name +.IP "size_t * buf_size" 12 +holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will return the name of the given RDN sequence. The +name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in +RFC4514. + +This function does not output a fully RFC4514 compliant string, if +that is required see \fBgnutls_x509_rdn_get2()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned and * \fIbuf_size\fP is +updated if the provided buffer is not long enough, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_rdn_get2.3 b/doc/manpages/gnutls_x509_rdn_get2.3 new file mode 100644 index 0000000..9825879 --- /dev/null +++ b/doc/manpages/gnutls_x509_rdn_get2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_rdn_get2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_rdn_get2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_rdn_get2(const gnutls_datum_t * " idn ", gnutls_datum_t * " str ", unsigned " flags ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * idn" 12 +should contain a DER encoded RDN sequence +.IP "gnutls_datum_t * str" 12 +a datum that will hold the name +.IP "unsigned flags" 12 +zero of \fBGNUTLS_X509_DN_FLAG_COMPAT\fP +.SH "DESCRIPTION" +This function will return the name of the given RDN sequence. The +name will be in the form "C=xxxx,O=yyyy,CN=zzzz" as described in +RFC4514. + +When the flag \fBGNUTLS_X509_DN_FLAG_COMPAT\fP is specified, the output +format will match the format output by previous to 3.5.6 versions of GnuTLS +which was not not fully RFC4514\-compliant. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned and * \fIbuf_size\fP is +updated if the provided buffer is not long enough, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_rdn_get_by_oid.3 b/doc/manpages/gnutls_x509_rdn_get_by_oid.3 new file mode 100644 index 0000000..874586f --- /dev/null +++ b/doc/manpages/gnutls_x509_rdn_get_by_oid.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_rdn_get_by_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_rdn_get_by_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_rdn_get_by_oid(const gnutls_datum_t * " idn ", const char * " oid ", unsigned " indx ", unsigned int " raw_flag ", void * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * idn" 12 +should contain a DER encoded RDN sequence +.IP "const char * oid" 12 +an Object Identifier +.IP "unsigned indx" 12 +In case multiple same OIDs exist in the RDN indicates which +to send. Use 0 for the first one. +.IP "unsigned int raw_flag" 12 +If non\-zero then the raw DER data are returned. +.IP "void * buf" 12 +a pointer to a structure to hold the peer's name +.IP "size_t * buf_size" 12 +holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will return the name of the given Object identifier, +of the RDN sequence. The name will be encoded using the rules +from RFC4514. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned and * \fIbuf_size\fP is +updated if the provided buffer is not long enough, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_rdn_get_oid.3 b/doc/manpages/gnutls_x509_rdn_get_oid.3 new file mode 100644 index 0000000..26a84d2 --- /dev/null +++ b/doc/manpages/gnutls_x509_rdn_get_oid.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_rdn_get_oid" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_rdn_get_oid \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_rdn_get_oid(const gnutls_datum_t * " idn ", unsigned " indx ", void * " buf ", size_t * " buf_size ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * idn" 12 +should contain a DER encoded RDN sequence +.IP "unsigned indx" 12 +Indicates which OID to return. Use 0 for the first one. +.IP "void * buf" 12 +a pointer to a structure to hold the peer's name OID +.IP "size_t * buf_size" 12 +holds the size of \fIbuf\fP +.SH "DESCRIPTION" +This function will return the specified Object identifier, of the +RDN sequence. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned and * \fIbuf_size\fP is +updated if the provided buffer is not long enough, otherwise a +negative error value. +.SH "SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_spki_deinit.3 b/doc/manpages/gnutls_x509_spki_deinit.3 new file mode 100644 index 0000000..65c1142 --- /dev/null +++ b/doc/manpages/gnutls_x509_spki_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_spki_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_spki_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_spki_deinit(gnutls_x509_spki_t " spki ");" +.SH ARGUMENTS +.IP "gnutls_x509_spki_t spki" 12 +the SubjectPublicKeyInfo structure +.SH "DESCRIPTION" +This function will deinitialize a SubjectPublicKeyInfo structure. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_spki_get_rsa_pss_params.3 b/doc/manpages/gnutls_x509_spki_get_rsa_pss_params.3 new file mode 100644 index 0000000..9b29ae6 --- /dev/null +++ b/doc/manpages/gnutls_x509_spki_get_rsa_pss_params.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_spki_get_rsa_pss_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_spki_get_rsa_pss_params \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_spki_get_rsa_pss_params(gnutls_x509_spki_t " spki ", gnutls_digest_algorithm_t * " dig ", unsigned int * " salt_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_spki_t spki" 12 +the SubjectPublicKeyInfo structure +.IP "gnutls_digest_algorithm_t * dig" 12 +if non\-NULL, it will hold the digest algorithm +.IP "unsigned int * salt_size" 12 +if non\-NULL, it will hold the salt size +.SH "DESCRIPTION" +This function will get the public key algorithm parameters +of RSA\-PSS type. +.SH "RETURNS" +zero if the parameters are present or a negative +value on error. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_spki_init.3 b/doc/manpages/gnutls_x509_spki_init.3 new file mode 100644 index 0000000..94003a9 --- /dev/null +++ b/doc/manpages/gnutls_x509_spki_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_spki_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_spki_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_spki_init(gnutls_x509_spki_t * " spki ");" +.SH ARGUMENTS +.IP "gnutls_x509_spki_t * spki" 12 +A pointer to the type to be initialized +.SH "DESCRIPTION" +This function will initialize a SubjectPublicKeyInfo structure used +in PKIX. The structure is used to set additional parameters +in the public key information field of a certificate. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_spki_set_rsa_pss_params.3 b/doc/manpages/gnutls_x509_spki_set_rsa_pss_params.3 new file mode 100644 index 0000000..7a13a27 --- /dev/null +++ b/doc/manpages/gnutls_x509_spki_set_rsa_pss_params.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_spki_set_rsa_pss_params" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_spki_set_rsa_pss_params \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_spki_set_rsa_pss_params(gnutls_x509_spki_t " spki ", gnutls_digest_algorithm_t " dig ", unsigned int " salt_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_spki_t spki" 12 +the SubjectPublicKeyInfo structure +.IP "gnutls_digest_algorithm_t dig" 12 +a digest algorithm of type \fBgnutls_digest_algorithm_t\fP +.IP "unsigned int salt_size" 12 +the size of salt string +.SH "DESCRIPTION" +This function will set the public key parameters for +an RSA\-PSS algorithm, in the SubjectPublicKeyInfo structure. +.SH "SINCE" +3.6.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_tlsfeatures_add.3 b/doc/manpages/gnutls_x509_tlsfeatures_add.3 new file mode 100644 index 0000000..1b4506c --- /dev/null +++ b/doc/manpages/gnutls_x509_tlsfeatures_add.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_tlsfeatures_add" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_tlsfeatures_add \- API function +.SH SYNOPSIS +.B #include <gnutls/x509-ext.h> +.sp +.BI "int gnutls_x509_tlsfeatures_add(gnutls_x509_tlsfeatures_t " f ", unsigned int " feature ");" +.SH ARGUMENTS +.IP "gnutls_x509_tlsfeatures_t f" 12 +The TLS features +.IP "unsigned int feature" 12 +The feature to add +.SH "DESCRIPTION" +This function will append a feature to the X.509 TLS features +extension structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_tlsfeatures_check_crt.3 b/doc/manpages/gnutls_x509_tlsfeatures_check_crt.3 new file mode 100644 index 0000000..1c537ca --- /dev/null +++ b/doc/manpages/gnutls_x509_tlsfeatures_check_crt.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_tlsfeatures_check_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_tlsfeatures_check_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "unsigned gnutls_x509_tlsfeatures_check_crt(gnutls_x509_tlsfeatures_t " feat ", gnutls_x509_crt_t " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_tlsfeatures_t feat" 12 +a set of TLSFeatures +.IP "gnutls_x509_crt_t cert" 12 +the certificate to be checked +.SH "DESCRIPTION" +This function will check the provided certificate against the TLSFeatures +set in \fIfeat\fP using the RFC7633 p.4.2.2 rules. It will check whether the certificate +contains the features in \fIfeat\fP or a superset. +.SH "RETURNS" +non\-zero if the provided certificate complies, and zero otherwise. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_tlsfeatures_deinit.3 b/doc/manpages/gnutls_x509_tlsfeatures_deinit.3 new file mode 100644 index 0000000..4f4df15 --- /dev/null +++ b/doc/manpages/gnutls_x509_tlsfeatures_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_tlsfeatures_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_tlsfeatures_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_tlsfeatures_deinit(gnutls_x509_tlsfeatures_t " f ");" +.SH ARGUMENTS +.IP "gnutls_x509_tlsfeatures_t f" 12 +The TLS features +.SH "DESCRIPTION" +This function will deinitialize a X.509 TLS features extension structure +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_tlsfeatures_get.3 b/doc/manpages/gnutls_x509_tlsfeatures_get.3 new file mode 100644 index 0000000..c913f5c --- /dev/null +++ b/doc/manpages/gnutls_x509_tlsfeatures_get.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_tlsfeatures_get" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_tlsfeatures_get \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_tlsfeatures_get(gnutls_x509_tlsfeatures_t " f ", unsigned " idx ", unsigned int * " feature ");" +.SH ARGUMENTS +.IP "gnutls_x509_tlsfeatures_t f" 12 +The TLS features +.IP "unsigned idx" 12 +The index of the feature to get +.IP "unsigned int * feature" 12 +If the function succeeds, the feature will be stored in this variable +.SH "DESCRIPTION" +This function will get a feature from the X.509 TLS features +extension structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_tlsfeatures_init.3 b/doc/manpages/gnutls_x509_tlsfeatures_init.3 new file mode 100644 index 0000000..02a17c4 --- /dev/null +++ b/doc/manpages/gnutls_x509_tlsfeatures_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_tlsfeatures_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_tlsfeatures_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_tlsfeatures_init(gnutls_x509_tlsfeatures_t * " f ");" +.SH ARGUMENTS +.IP "gnutls_x509_tlsfeatures_t * f" 12 +The TLS features +.SH "DESCRIPTION" +This function will initialize a X.509 TLS features extension structure +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error value. +.SH "SINCE" +3.5.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_add_cas.3 b/doc/manpages/gnutls_x509_trust_list_add_cas.3 new file mode 100644 index 0000000..95a287c --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_add_cas.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_add_cas" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_cas \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_add_cas(gnutls_x509_trust_list_t " list ", const gnutls_x509_crt_t * " clist ", unsigned " clist_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const gnutls_x509_crt_t * clist" 12 +A list of CAs +.IP "unsigned clist_size" 12 +The length of the CA list +.IP "unsigned int flags" 12 +flags from \fBgnutls_trust_list_flags_t\fP +.SH "DESCRIPTION" +This function will add the given certificate authorities +to the trusted list. The CAs in \fIclist\fP must not be deinitialized +during the lifetime of \fIlist\fP . + +If the flag \fBGNUTLS_TL_NO_DUPLICATES\fP is specified, then +this function will ensure that no duplicates will be +present in the final trust list. + +If the flag \fBGNUTLS_TL_NO_DUPLICATE_KEY\fP is specified, then +this function will ensure that no certificates with the +same key are present in the final trust list. + +If either \fBGNUTLS_TL_NO_DUPLICATE_KEY\fP or \fBGNUTLS_TL_NO_DUPLICATES\fP +are given, \fBgnutls_x509_trust_list_deinit()\fP must be called with parameter + \fIall\fP being 1. +.SH "RETURNS" +The number of added elements is returned; that includes +duplicate entries. +.SH "SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_add_crls.3 b/doc/manpages/gnutls_x509_trust_list_add_crls.3 new file mode 100644 index 0000000..ed41e85 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_add_crls.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_add_crls" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_crls \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_add_crls(gnutls_x509_trust_list_t " list ", const gnutls_x509_crl_t * " crl_list ", unsigned " crl_size ", unsigned int " flags ", unsigned int " verification_flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const gnutls_x509_crl_t * crl_list" 12 +A list of CRLs +.IP "unsigned crl_size" 12 +The length of the CRL list +.IP "unsigned int flags" 12 +flags from \fBgnutls_trust_list_flags_t\fP +.IP "unsigned int verification_flags" 12 +gnutls_certificate_verify_flags if flags specifies GNUTLS_TL_VERIFY_CRL +.SH "DESCRIPTION" +This function will add the given certificate revocation lists +to the trusted list. The CRLs in \fIcrl_list\fP must not be deinitialized +during the lifetime of \fIlist\fP . + +This function must be called after \fBgnutls_x509_trust_list_add_cas()\fP +to allow verifying the CRLs for validity. If the flag \fBGNUTLS_TL_NO_DUPLICATES\fP +is given, then the final CRL list will not contain duplicate entries. + +If the flag \fBGNUTLS_TL_NO_DUPLICATES\fP is given, \fBgnutls_x509_trust_list_deinit()\fP must be +called with parameter \fIall\fP being 1. + +If flag \fBGNUTLS_TL_VERIFY_CRL\fP is given the CRLs will be verified before being added, +and if verification fails, they will be skipped. +.SH "RETURNS" +The number of added elements is returned; that includes +duplicate entries. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_add_named_crt.3 b/doc/manpages/gnutls_x509_trust_list_add_named_crt.3 new file mode 100644 index 0000000..59b8629 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_add_named_crt.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_add_named_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_named_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_add_named_crt(gnutls_x509_trust_list_t " list ", gnutls_x509_crt_t " cert ", const void * " name ", size_t " name_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "gnutls_x509_crt_t cert" 12 +A certificate +.IP "const void * name" 12 +An identifier for the certificate +.IP "size_t name_size" 12 +The size of the identifier +.IP "unsigned int flags" 12 +should be 0. +.SH "DESCRIPTION" +This function will add the given certificate to the trusted +list and associate it with a name. The certificate will not be +be used for verification with \fBgnutls_x509_trust_list_verify_crt()\fP +but with \fBgnutls_x509_trust_list_verify_named_crt()\fP or +\fBgnutls_x509_trust_list_verify_crt2()\fP \- the latter only since +GnuTLS 3.4.0 and if a hostname is provided. + +In principle this function can be used to set individual "server" +certificates that are trusted by the user for that specific server +but for no other purposes. + +The certificate \fIcert\fP must not be deinitialized during the lifetime +of the \fIlist\fP . +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_add_system_trust.3 b/doc/manpages/gnutls_x509_trust_list_add_system_trust.3 new file mode 100644 index 0000000..ed53ca4 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_add_system_trust.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_add_system_trust" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_system_trust \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_add_system_trust(gnutls_x509_trust_list_t " list ", unsigned int " tl_flags ", unsigned int " tl_vflags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The structure of the list +.IP "unsigned int tl_flags" 12 +GNUTLS_TL_* +.IP "unsigned int tl_vflags" 12 +gnutls_certificate_verify_flags if flags specifies GNUTLS_TL_VERIFY_CRL +.SH "DESCRIPTION" +This function adds the system's default trusted certificate +authorities to the trusted list. Note that on unsupported systems +this function returns \fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP. + +This function implies the flag \fBGNUTLS_TL_NO_DUPLICATES\fP. +.SH "RETURNS" +The number of added elements or a negative error code on error. +.SH "SINCE" +3.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_add_trust_dir.3 b/doc/manpages/gnutls_x509_trust_list_add_trust_dir.3 new file mode 100644 index 0000000..ad74768 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_add_trust_dir.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_add_trust_dir" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_trust_dir \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_add_trust_dir(gnutls_x509_trust_list_t " list ", const char * " ca_dir ", const char * " crl_dir ", gnutls_x509_crt_fmt_t " type ", unsigned int " tl_flags ", unsigned int " tl_vflags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const char * ca_dir" 12 +A directory containing the CAs (optional) +.IP "const char * crl_dir" 12 +A directory containing a list of CRLs (optional) +.IP "gnutls_x509_crt_fmt_t type" 12 +The format of the certificates +.IP "unsigned int tl_flags" 12 +flags from \fBgnutls_trust_list_flags_t\fP +.IP "unsigned int tl_vflags" 12 +gnutls_certificate_verify_flags if flags specifies GNUTLS_TL_VERIFY_CRL +.SH "DESCRIPTION" +This function will add the given certificate authorities +to the trusted list. Only directories are accepted by +this function. +.SH "RETURNS" +The number of added elements is returned. +.SH "SINCE" +3.3.6 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_add_trust_file.3 b/doc/manpages/gnutls_x509_trust_list_add_trust_file.3 new file mode 100644 index 0000000..599ec01 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_add_trust_file.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_add_trust_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_trust_file \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_add_trust_file(gnutls_x509_trust_list_t " list ", const char * " ca_file ", const char * " crl_file ", gnutls_x509_crt_fmt_t " type ", unsigned int " tl_flags ", unsigned int " tl_vflags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const char * ca_file" 12 +A file containing a list of CAs (optional) +.IP "const char * crl_file" 12 +A file containing a list of CRLs (optional) +.IP "gnutls_x509_crt_fmt_t type" 12 +The format of the certificates +.IP "unsigned int tl_flags" 12 +flags from \fBgnutls_trust_list_flags_t\fP +.IP "unsigned int tl_vflags" 12 +gnutls_certificate_verify_flags if flags specifies GNUTLS_TL_VERIFY_CRL +.SH "DESCRIPTION" +This function will add the given certificate authorities +to the trusted list. PKCS \fB11\fP URLs are also accepted, instead +of files, by this function. A PKCS \fB11\fP URL implies a trust +database (a specially marked module in p11\-kit); the URL "pkcs11:" +implies all trust databases in the system. Only a single URL specifying +trust databases can be set; they cannot be stacked with multiple calls. +.SH "RETURNS" +The number of added elements is returned. +.SH "SINCE" +3.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_add_trust_mem.3 b/doc/manpages/gnutls_x509_trust_list_add_trust_mem.3 new file mode 100644 index 0000000..0ab8bba --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_add_trust_mem.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_add_trust_mem" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_trust_mem \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_add_trust_mem(gnutls_x509_trust_list_t " list ", const gnutls_datum_t * " cas ", const gnutls_datum_t * " crls ", gnutls_x509_crt_fmt_t " type ", unsigned int " tl_flags ", unsigned int " tl_vflags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const gnutls_datum_t * cas" 12 +A buffer containing a list of CAs (optional) +.IP "const gnutls_datum_t * crls" 12 +A buffer containing a list of CRLs (optional) +.IP "gnutls_x509_crt_fmt_t type" 12 +The format of the certificates +.IP "unsigned int tl_flags" 12 +flags from \fBgnutls_trust_list_flags_t\fP +.IP "unsigned int tl_vflags" 12 +gnutls_certificate_verify_flags if flags specifies GNUTLS_TL_VERIFY_CRL +.SH "DESCRIPTION" +This function will add the given certificate authorities +to the trusted list. + +If this function is used \fBgnutls_x509_trust_list_deinit()\fP must be called +with parameter \fIall\fP being 1. +.SH "RETURNS" +The number of added elements is returned. +.SH "SINCE" +3.1 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_deinit.3 b/doc/manpages/gnutls_x509_trust_list_deinit.3 new file mode 100644 index 0000000..8a4dc7b --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_deinit.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_trust_list_deinit(gnutls_x509_trust_list_t " list ", unsigned int " all ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list to be deinitialized +.IP "unsigned int all" 12 +if non\-zero it will deinitialize all the certificates and CRLs contained in the structure. +.SH "DESCRIPTION" +This function will deinitialize a trust list. Note that the + \fIall\fP flag should be typically non\-zero unless you have specified +your certificates using \fBgnutls_x509_trust_list_add_cas()\fP and you +want to prevent them from being deinitialized by this function. +.SH "SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_get_issuer.3 b/doc/manpages/gnutls_x509_trust_list_get_issuer.3 new file mode 100644 index 0000000..b77685b --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_get_issuer.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_get_issuer" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_get_issuer \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_get_issuer(gnutls_x509_trust_list_t " list ", gnutls_x509_crt_t " cert ", gnutls_x509_crt_t * " issuer ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "gnutls_x509_crt_t cert" 12 +is the certificate to find issuer for +.IP "gnutls_x509_crt_t * issuer" 12 +Will hold the issuer if any. Should be treated as constant +unless \fBGNUTLS_TL_GET_COPY\fP is set in \fIflags\fP . +.IP "unsigned int flags" 12 +flags from \fBgnutls_trust_list_flags_t\fP (\fBGNUTLS_TL_GET_COPY\fP is applicable) +.SH "DESCRIPTION" +This function will find the issuer of the given certificate. +If the flag \fBGNUTLS_TL_GET_COPY\fP is specified a copy of the issuer +will be returned which must be freed using \fBgnutls_x509_crt_deinit()\fP. +In that case the provided \fIissuer\fP must not be initialized. + +Note that the flag \fBGNUTLS_TL_GET_COPY\fP is required for this function +to work with PKCS\fB11\fP trust lists in a thread\-safe way. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_get_issuer_by_dn.3 b/doc/manpages/gnutls_x509_trust_list_get_issuer_by_dn.3 new file mode 100644 index 0000000..38c51ff --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_get_issuer_by_dn.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_get_issuer_by_dn" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_get_issuer_by_dn \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_get_issuer_by_dn(gnutls_x509_trust_list_t " list ", const gnutls_datum_t * " dn ", gnutls_x509_crt_t * " issuer ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const gnutls_datum_t * dn" 12 +is the issuer's DN +.IP "gnutls_x509_crt_t * issuer" 12 +Will hold the issuer if any. Should be deallocated after use. +.IP "unsigned int flags" 12 +Use zero +.SH "DESCRIPTION" +This function will find the issuer with the given name, and +return a copy of the issuer, which must be freed using \fBgnutls_x509_crt_deinit()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_get_issuer_by_subject_key_id.3 b/doc/manpages/gnutls_x509_trust_list_get_issuer_by_subject_key_id.3 new file mode 100644 index 0000000..dc5bdc3 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_get_issuer_by_subject_key_id.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_get_issuer_by_subject_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_get_issuer_by_subject_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_get_issuer_by_subject_key_id(gnutls_x509_trust_list_t " list ", const gnutls_datum_t * " dn ", const gnutls_datum_t * " spki ", gnutls_x509_crt_t * " issuer ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const gnutls_datum_t * dn" 12 +is the issuer's DN (may be \fBNULL\fP) +.IP "const gnutls_datum_t * spki" 12 +is the subject key ID +.IP "gnutls_x509_crt_t * issuer" 12 +Will hold the issuer if any. Should be deallocated after use. +.IP "unsigned int flags" 12 +Use zero +.SH "DESCRIPTION" +This function will find the issuer with the given name and subject key ID, and +return a copy of the issuer, which must be freed using \fBgnutls_x509_crt_deinit()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.2 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_get_ptr.3 b/doc/manpages/gnutls_x509_trust_list_get_ptr.3 new file mode 100644 index 0000000..2f9de97 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_get_ptr.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_get_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_get_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void * gnutls_x509_trust_list_get_ptr(gnutls_x509_trust_list_t " tlist ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t tlist" 12 +is a \fBgnutls_x509_trust_list_t\fP type. +.SH "DESCRIPTION" +Get user pointer for tlist. Useful in callback function +gnutls_x509_trust_list_set_getissuer_function. +This is the pointer set with \fBgnutls_x509_trust_list_set_ptr()\fP. +.SH "RETURNS" +the user given pointer from the tlist structure, or +\fBNULL\fP if it was never set. +.SH "SINCE" +3.7.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_init.3 b/doc/manpages/gnutls_x509_trust_list_init.3 new file mode 100644 index 0000000..30fbdb0 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_init" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_init \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_init(gnutls_x509_trust_list_t * " list ", unsigned int " size ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t * list" 12 +A pointer to the type to be initialized +.IP "unsigned int size" 12 +The size of the internal hash table. Use (0) for default size. +.SH "DESCRIPTION" +This function will initialize an X.509 trust list structure. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_iter_deinit.3 b/doc/manpages/gnutls_x509_trust_list_iter_deinit.3 new file mode 100644 index 0000000..1812df5 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_iter_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_iter_deinit" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_iter_deinit \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_trust_list_iter_deinit(gnutls_x509_trust_list_iter_t " iter ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_iter_t iter" 12 +The iterator structure to be deinitialized +.SH "DESCRIPTION" +This function will deinitialize an iterator structure. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_iter_get_ca.3 b/doc/manpages/gnutls_x509_trust_list_iter_get_ca.3 new file mode 100644 index 0000000..2c4704a --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_iter_get_ca.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_iter_get_ca" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_iter_get_ca \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_iter_get_ca(gnutls_x509_trust_list_t " list ", gnutls_x509_trust_list_iter_t * " iter ", gnutls_x509_crt_t * " crt ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "gnutls_x509_trust_list_iter_t * iter" 12 +A pointer to an iterator (initially the iterator should be \fBNULL\fP) +.IP "gnutls_x509_crt_t * crt" 12 +where the certificate will be copied +.SH "DESCRIPTION" +This function obtains a certificate in the trust list and advances the +iterator to the next certificate. The certificate returned in \fIcrt\fP must be +deallocated with \fBgnutls_x509_crt_deinit()\fP. + +When past the last element is accessed \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP +is returned and the iterator is reset. + +The iterator is deinitialized and reset to \fBNULL\fP automatically by this +function after iterating through all elements until +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. If the iteration is +aborted early, it must be manually deinitialized using +\fBgnutls_x509_trust_list_iter_deinit()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.4.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_remove_cas.3 b/doc/manpages/gnutls_x509_trust_list_remove_cas.3 new file mode 100644 index 0000000..07434b9 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_remove_cas.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_remove_cas" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_remove_cas \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_remove_cas(gnutls_x509_trust_list_t " list ", const gnutls_x509_crt_t * " clist ", unsigned " clist_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const gnutls_x509_crt_t * clist" 12 +A list of CAs +.IP "unsigned clist_size" 12 +The length of the CA list +.SH "DESCRIPTION" +This function will remove the given certificate authorities +from the trusted list. + +Note that this function can accept certificates and authorities +not yet known. In that case they will be kept in a separate +black list that will be used during certificate verification. +Unlike \fBgnutls_x509_trust_list_add_cas()\fP there is no deinitialization +restriction for certificate list provided in this function. +.SH "RETURNS" +The number of removed elements is returned. +.SH "SINCE" +3.1.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_remove_trust_file.3 b/doc/manpages/gnutls_x509_trust_list_remove_trust_file.3 new file mode 100644 index 0000000..5890c47 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_remove_trust_file.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_remove_trust_file" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_remove_trust_file \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_remove_trust_file(gnutls_x509_trust_list_t " list ", const char * " ca_file ", gnutls_x509_crt_fmt_t " type ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const char * ca_file" 12 +A file containing a list of CAs +.IP "gnutls_x509_crt_fmt_t type" 12 +The format of the certificates +.SH "DESCRIPTION" +This function will remove the given certificate authorities +from the trusted list, and add them into a black list when needed. +PKCS 11 URLs are also accepted, instead +of files, by this function. + +See also \fBgnutls_x509_trust_list_remove_cas()\fP. +.SH "RETURNS" +The number of added elements is returned. +.SH "SINCE" +3.1.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_remove_trust_mem.3 b/doc/manpages/gnutls_x509_trust_list_remove_trust_mem.3 new file mode 100644 index 0000000..3645e71 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_remove_trust_mem.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_remove_trust_mem" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_remove_trust_mem \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_remove_trust_mem(gnutls_x509_trust_list_t " list ", const gnutls_datum_t * " cas ", gnutls_x509_crt_fmt_t " type ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "const gnutls_datum_t * cas" 12 +A buffer containing a list of CAs (optional) +.IP "gnutls_x509_crt_fmt_t type" 12 +The format of the certificates +.SH "DESCRIPTION" +This function will remove the provided certificate authorities +from the trusted list, and add them into a black list when needed. + +See also \fBgnutls_x509_trust_list_remove_cas()\fP. +.SH "RETURNS" +The number of removed elements is returned. +.SH "SINCE" +3.1.10 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_set_getissuer_function.3 b/doc/manpages/gnutls_x509_trust_list_set_getissuer_function.3 new file mode 100644 index 0000000..97a61e4 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_set_getissuer_function.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_set_getissuer_function" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_set_getissuer_function \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_trust_list_set_getissuer_function(gnutls_x509_trust_list_t " tlist ", gnutls_x509_trust_list_getissuer_function * " func ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t tlist" 12 +is a \fBgnutls_x509_trust_list_t\fP type. +.IP "gnutls_x509_trust_list_getissuer_function * func" 12 +is the callback function +.SH "DESCRIPTION" +This function sets a callback to be called when the peer's certificate +chain is incomplete due a missing intermediate certificate. The callback +may provide the missing certificate for use during verification. + +The callback's function prototype is defined in gnutls/x509.h as: + +int (*callback)(gnutls_x509_trust_list_t list, +const gnutls_x509_crt_t cert, +gnutls_x509_crt_t **issuers, +unsigned int *issuers_size); + +If the callback function is provided then gnutls will call it during the +certificate verification procedure. The callback may wish to use +\fBgnutls_x509_crt_get_authority_info_access()\fP to get a URI from which +to attempt to download the missing issuer certificate, if available. + +On a successful call, the callback shall allocate the 'issuers' array with +\fBgnutls_x509_crt_list_import2()\fP. The ownership of both the array and the +elements is transferred to the caller and thus the application does not need +to maintain the memory after the call. + +The callback function should return 0 if the missing issuer certificate +for 'crt' was properly populated and added to the 'issuers', or non\-zero +to continue the certificate list verification but with issuer as \fBNULL\fP. +.SH "SINCE" +3.7.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_set_ptr.3 b/doc/manpages/gnutls_x509_trust_list_set_ptr.3 new file mode 100644 index 0000000..86db850 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_set_ptr.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_set_ptr" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_set_ptr \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "void gnutls_x509_trust_list_set_ptr(gnutls_x509_trust_list_t " tlist ", void * " ptr ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t tlist" 12 +is a \fBgnutls_x509_trust_list_t\fP type. +.IP "void * ptr" 12 +is the user pointer +.SH "DESCRIPTION" +This function will set (associate) the user given pointer \fIptr\fP to +the tlist structure. This pointer can be accessed with +\fBgnutls_x509_trust_list_get_ptr()\fP. Useful in the callback function +gnutls_x509_trust_list_set_getissuer_function. +.SH "SINCE" +3.7.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_verify_crt.3 b/doc/manpages/gnutls_x509_trust_list_verify_crt.3 new file mode 100644 index 0000000..74f7a2c --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_verify_crt.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_verify_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_verify_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_verify_crt(gnutls_x509_trust_list_t " list ", gnutls_x509_crt_t * " cert_list ", unsigned int " cert_list_size ", unsigned int " flags ", unsigned int * " voutput ", gnutls_verify_output_function " func ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "gnutls_x509_crt_t * cert_list" 12 +is the certificate list to be verified +.IP "unsigned int cert_list_size" 12 +is the certificate list size +.IP "unsigned int flags" 12 +Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations. +.IP "unsigned int * voutput" 12 +will hold the certificate verification output. +.IP "gnutls_verify_output_function func" 12 +If non\-null will be called on each chain element verification with the output. +.SH "DESCRIPTION" +This function will try to verify the given certificate and return +its status. The \fIvoutput\fP parameter will hold an OR'ed sequence of +\fBgnutls_certificate_status_t\fP flags. + +The details of the verification are the same as in \fBgnutls_x509_trust_list_verify_crt2()\fP. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_verify_crt2.3 b/doc/manpages/gnutls_x509_trust_list_verify_crt2.3 new file mode 100644 index 0000000..6592716 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_verify_crt2.3 @@ -0,0 +1,80 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_verify_crt2" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_verify_crt2 \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_verify_crt2(gnutls_x509_trust_list_t " list ", gnutls_x509_crt_t * " cert_list ", unsigned int " cert_list_size ", gnutls_typed_vdata_st * " data ", unsigned int " elements ", unsigned int " flags ", unsigned int * " voutput ", gnutls_verify_output_function " func ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "gnutls_x509_crt_t * cert_list" 12 +is the certificate list to be verified +.IP "unsigned int cert_list_size" 12 +is the certificate list size +.IP "gnutls_typed_vdata_st * data" 12 +an array of typed data +.IP "unsigned int elements" 12 +the number of data elements +.IP "unsigned int flags" 12 +Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations. +.IP "unsigned int * voutput" 12 +will hold the certificate verification output. +.IP "gnutls_verify_output_function func" 12 +If non\-null will be called on each chain element verification with the output. +.SH "DESCRIPTION" +This function will attempt to verify the given certificate chain and return +its status. The \fIvoutput\fP parameter will hold an OR'ed sequence of +\fBgnutls_certificate_status_t\fP flags. + +When a certificate chain of \fIcert_list_size\fP with more than one certificates is +provided, the verification status will apply to the first certificate in the chain +that failed verification. The verification process starts from the end of the chain +(from CA to end certificate). The first certificate in the chain must be the end\-certificate +while the rest of the members may be sorted or not. + +Additionally a certificate verification profile can be specified +from the ones in \fBgnutls_certificate_verification_profiles_t\fP by +ORing the result of \fBGNUTLS_PROFILE_TO_VFLAGS()\fP to the verification +flags. + +Additional verification parameters are possible via the \fIdata\fP types; the +acceptable types are \fBGNUTLS_DT_DNS_HOSTNAME\fP, \fBGNUTLS_DT_IP_ADDRESS\fP and \fBGNUTLS_DT_KEY_PURPOSE_OID\fP. +The former accepts as data a null\-terminated hostname, and the latter a null\-terminated +object identifier (e.g., \fBGNUTLS_KP_TLS_WWW_SERVER\fP). +If a DNS hostname is provided then this function will compare +the hostname in the end certificate against the given. If names do not match the +\fBGNUTLS_CERT_UNEXPECTED_OWNER\fP status flag will be set. In addition it +will consider certificates provided with \fBgnutls_x509_trust_list_add_named_crt()\fP. + +If a key purpose OID is provided and the end\-certificate contains the extended key +usage PKIX extension, it will be required to match the provided OID +or be marked for any purpose, otherwise verification will fail with +\fBGNUTLS_CERT_PURPOSE_MISMATCH\fP status. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. Note that verification failure will not result to an +error code, only \fIvoutput\fP will be updated. +.SH "SINCE" +3.3.8 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/gnutls_x509_trust_list_verify_named_crt.3 b/doc/manpages/gnutls_x509_trust_list_verify_named_crt.3 new file mode 100644 index 0000000..50b5c25 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_verify_named_crt.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_verify_named_crt" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_verify_named_crt \- API function +.SH SYNOPSIS +.B #include <gnutls/x509.h> +.sp +.BI "int gnutls_x509_trust_list_verify_named_crt(gnutls_x509_trust_list_t " list ", gnutls_x509_crt_t " cert ", const void * " name ", size_t " name_size ", unsigned int " flags ", unsigned int * " voutput ", gnutls_verify_output_function " func ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The list +.IP "gnutls_x509_crt_t cert" 12 +is the certificate to be verified +.IP "const void * name" 12 +is the certificate's name +.IP "size_t name_size" 12 +is the certificate's name size +.IP "unsigned int flags" 12 +Flags that may be used to change the verification algorithm. Use OR of the gnutls_certificate_verify_flags enumerations. +.IP "unsigned int * voutput" 12 +will hold the certificate verification output. +.IP "gnutls_verify_output_function func" 12 +If non\-null will be called on each chain element verification with the output. +.SH "DESCRIPTION" +This function will try to find a certificate that is associated with the provided +name \-\-see \fBgnutls_x509_trust_list_add_named_crt()\fP. If a match is found the +certificate is considered valid. In addition to that this function will also +check CRLs. The \fIvoutput\fP parameter will hold an OR'ed sequence of +\fBgnutls_certificate_status_t\fP flags. + +Additionally a certificate verification profile can be specified +from the ones in \fBgnutls_certificate_verification_profiles_t\fP by +ORing the result of \fBGNUTLS_PROFILE_TO_VFLAGS()\fP to the verification +flags. +.SH "RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to <bugs@gnutls.org>. +.br +Home page: https://www.gnutls.org + +.SH COPYRIGHT +Copyright \(co 2001- Free Software Foundation, Inc., and others. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. +If the /usr/share/doc/gnutls/ +directory does not contain the HTML form visit +.B +.IP https://www.gnutls.org/manual/ +.PP diff --git a/doc/manpages/ocsptool.1 b/doc/manpages/ocsptool.1 new file mode 100644 index 0000000..12bd512 --- /dev/null +++ b/doc/manpages/ocsptool.1 @@ -0,0 +1,364 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH ocsptool 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]ocsptool\fP +\- GnuTLS OCSP tool +.SH SYNOPSIS +\f\*[B-Font]ocsptool\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +.sp \n(Ppu +.ne 2 + +All arguments must be options. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +.br +\fBOn verification\fP +.br +Responses are typically signed/issued by designated certificates or +certificate authorities and thus this tool requires on verification +the certificate of the issuer or the full certificate chain in order to +determine the appropriate signing authority. The specified certificate +of the issuer is assumed trusted. +.sp +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-V\f[], \f\*[B-Font]\-\-verbose\f[] +More verbose output. +.sp +.TP +.NOP \f\*[B-Font]\-\-infile\f[]=\f\*[I-Font]file\f[] +Input file. +.sp +.TP +.NOP \f\*[B-Font]\-\-outfile\f[]=\f\*[I-Font]str\f[] +Output file. +.sp +.TP +.NOP \f\*[B-Font]\-\-ask\f[]=\f\*[I-Font]server name|url\f[] +Ask an OCSP/HTTP server on a certificate validity. +.sp +Connects to the specified HTTP OCSP server and queries on the validity of the loaded certificate. +Its argument can be a URL or a plain server name. It can be combined with \-\-load\-chain, where it checks +all certificates in the provided chain, or with \-\-load\-cert and +\-\-load\-issuer options. The latter checks the provided certificate +against its specified issuer certificate. +.TP +.NOP \f\*[B-Font]\-e\f[], \f\*[B-Font]\-\-verify\-response\f[] +Verify response. +.sp +Verifies the provided OCSP response against the system trust +anchors (unless \-\-load\-trust is provided). It requires the \-\-load\-signer +or \-\-load\-chain options to obtain the signer of the OCSP response. +.TP +.NOP \f\*[B-Font]\-i\f[], \f\*[B-Font]\-\-request\-info\f[] +Print information on a OCSP request. +.sp +Display detailed information on the provided OCSP request. +.TP +.NOP \f\*[B-Font]\-j\f[], \f\*[B-Font]\-\-response\-info\f[] +Print information on a OCSP response. +.sp +Display detailed information on the provided OCSP response. +.TP +.NOP \f\*[B-Font]\-q\f[], \f\*[B-Font]\-\-generate\-request\f[] +Generates an OCSP request. +.sp +.TP +.NOP \f\*[B-Font]\-\-nonce\f[], \f\*[B-Font]\-\-no\-nonce\f[] +Use (or not) a nonce to OCSP request. +The \fIno\-nonce\fP form will disable the option. +.sp +.TP +.NOP \f\*[B-Font]\-\-load\-chain\f[]=\f\*[I-Font]file\f[] +Reads a set of certificates forming a chain from file. +.sp +.TP +.NOP \f\*[B-Font]\-\-load\-issuer\f[]=\f\*[I-Font]file\f[] +Reads issuer's certificate from file. +.sp +.TP +.NOP \f\*[B-Font]\-\-load\-cert\f[]=\f\*[I-Font]file\f[] +Reads the certificate to check from file. +.sp +.TP +.NOP \f\*[B-Font]\-\-load\-trust\f[]=\f\*[I-Font]file\f[] +Read OCSP trust anchors from file. +This option must not appear in combination with any of the following options: +load-signer. +.sp +When verifying an OCSP response read the trust anchors from the +provided file. When this is not provided, the system's trust anchors will be +used. +.TP +.NOP \f\*[B-Font]\-\-load\-signer\f[]=\f\*[I-Font]file\f[] +Reads the OCSP response signer from file. +This option must not appear in combination with any of the following options: +load-trust. +.sp +.TP +.NOP \f\*[B-Font]\-\-inder\f[], \f\*[B-Font]\-\-no\-inder\f[] +Use DER format for input certificates and private keys. +The \fIno\-inder\fP form will disable the option. +.sp +.TP +.NOP \f\*[B-Font]\-\-outder\f[] +Use DER format for output of responses (this is the default). +.sp +The output will be in DER encoded format. Unlike other GnuTLS tools, this is the default for this tool +.TP +.NOP \f\*[B-Font]\-\-outpem\f[] +Use PEM format for output of responses. +.sp +The output will be in PEM format. +.TP +.NOP \f\*[B-Font]\-Q\f[] \f\*[I-Font]file\f[], \f\*[B-Font]\-\-load\-request\f[]=\f\*[I-Font]file\f[] +Reads the DER encoded OCSP request from file. +.sp +.TP +.NOP \f\*[B-Font]\-S\f[] \f\*[I-Font]file\f[], \f\*[B-Font]\-\-load\-response\f[]=\f\*[I-Font]file\f[] +Reads the DER encoded OCSP response from file. +.sp +.TP +.NOP \f\*[B-Font]\-\-ignore\-errors\f[] +Ignore any verification errors. +.sp +.TP +.NOP \f\*[B-Font]\-\-verify\-allow\-broken\f[] +Allow broken algorithms, such as MD5 for verification. +.sp +This can be combined with \-\-verify\-response. +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.sp +.SH EXAMPLES +.br +\fBPrint information about an OCSP request\fP +.br +.sp +To parse an OCSP request and print information about the content, the +\fB\-i\fP or \fB\-\-request\-info\fP parameter may be used as follows. +The \fB\-Q\fP parameter specify the name of the file containing the +OCSP request, and it should contain the OCSP request in binary DER +format. +.sp +.br +.in +4 +.nf +$ ocsptool \-i \-Q ocsp\-request.der +.in -4 +.fi +.sp +The input file may also be sent to standard input like this: +.sp +.br +.in +4 +.nf +$ cat ocsp\-request.der | ocsptool \-\-request\-info +.in -4 +.fi +.sp +.br +\fBPrint information about an OCSP response\fP +.br +.sp +Similar to parsing OCSP requests, OCSP responses can be parsed using +the \fB\-j\fP or \fB\-\-response\-info\fP as follows. +.sp +.br +.in +4 +.nf +$ ocsptool \-j \-Q ocsp\-response.der +$ cat ocsp\-response.der | ocsptool \-\-response\-info +.in -4 +.fi +.sp +.br +\fBGenerate an OCSP request\fP +.br +.sp +The \fB\-q\fP or \fB\-\-generate\-request\fP parameters are used to +generate an OCSP request. By default the OCSP request is written to +standard output in binary DER format, but can be stored in a file +using \fB\-\-outfile\fP. To generate an OCSP request the issuer of the +certificate to check needs to be specified with \fB\-\-load\-issuer\fP +and the certificate to check with \fB\-\-load\-cert\fP. By default PEM +format is used for these files, although \fB\-\-inder\fP can be used to +specify that the input files are in DER format. +.sp +.br +.in +4 +.nf +$ ocsptool \-q \-\-load\-issuer issuer.pem \-\-load\-cert client.pem \ + \-\-outfile ocsp\-request.der +.in -4 +.fi +.sp +When generating OCSP requests, the tool will add an OCSP extension +containing a nonce. This behaviour can be disabled by specifying +\fB\-\-no\-nonce\fP. +.sp +.br +\fBVerify signature in OCSP response\fP +.br +.sp +To verify the signature in an OCSP response the \fB\-e\fP or +\fB\-\-verify\-response\fP parameter is used. The tool will read an +OCSP response in DER format from standard input, or from the file +specified by \fB\-\-load\-response\fP. The OCSP response is verified +against a set of trust anchors, which are specified using +\fB\-\-load\-trust\fP. The trust anchors are concatenated certificates +in PEM format. The certificate that signed the OCSP response needs to +be in the set of trust anchors, or the issuer of the signer +certificate needs to be in the set of trust anchors and the OCSP +Extended Key Usage bit has to be asserted in the signer certificate. +.sp +.br +.in +4 +.nf +$ ocsptool \-e \-\-load\-trust issuer.pem \ + \-\-load\-response ocsp\-response.der +.in -4 +.fi +.sp +The tool will print status of verification. +.sp +.br +\fBVerify signature in OCSP response against given certificate\fP +.br +.sp +It is possible to override the normal trust logic if you know that a +certain certificate is supposed to have signed the OCSP response, and +you want to use it to check the signature. This is achieved using +\fB\-\-load\-signer\fP instead of \fB\-\-load\-trust\fP. This will load +one certificate and it will be used to verify the signature in the +OCSP response. It will not check the Extended Key Usage bit. +.sp +.br +.in +4 +.nf +$ ocsptool \-e \-\-load\-signer ocsp\-signer.pem \ + \-\-load\-response ocsp\-response.der +.in -4 +.fi +.sp +This approach is normally only relevant in two situations. The first +is when the OCSP response does not contain a copy of the signer +certificate, so the \fB\-\-load\-trust\fP code would fail. The second +is if you want to avoid the indirect mode where the OCSP response +signer certificate is signed by a trust anchor. +.sp +.br +\fBReal\-world example\fP +.br +.sp +Here is an example of how to generate an OCSP request for a +certificate and to verify the response. For illustration we'll use +the \fBblog.josefsson.org\fP host, which (as of writing) uses a +certificate from CACert. First we'll use \fBgnutls\-cli\fP to get a +copy of the server certificate chain. The server is not required to +send this information, but this particular one is configured to do so. +.sp +.br +.in +4 +.nf +$ echo | gnutls\-cli \-p 443 blog.josefsson.org \-\-save\-cert chain.pem +.in -4 +.fi +.sp +The saved certificates normally contain a pointer to where the OCSP +responder is located, in the Authority Information Access Information +extension. For example, from \fBcerttool \-i < chain.pem\fP there is +this information: +.sp +.br +.in +4 +.nf + Authority Information Access Information (not critical): + Access Method: 1.3.6.1.5.5.7.48.1 (id\-ad\-ocsp) + Access Location URI: https://ocsp.CAcert.org/ +.in -4 +.fi +.sp +This means that ocsptool can discover the servers to contact over HTTP. +We can now request information on the chain certificates. +.sp +.br +.in +4 +.nf +$ ocsptool \-\-ask \-\-load\-chain chain.pem +.in -4 +.fi +.sp +The request is sent via HTTP to the OCSP server address found in +the certificates. It is possible to override the address of the +OCSP server as well as ask information on a particular certificate +using \-\-load\-cert and \-\-load\-issuer. +.sp +.br +.in +4 +.nf +$ ocsptool \-\-ask https://ocsp.CAcert.org/ \-\-load\-chain chain.pem +.in -4 +.fi +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +certtool (1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org diff --git a/doc/manpages/p11tool.1 b/doc/manpages/p11tool.1 new file mode 100644 index 0000000..8406adb --- /dev/null +++ b/doc/manpages/p11tool.1 @@ -0,0 +1,508 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH p11tool 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]p11tool\fP +\- GnuTLS PKCS #11 tool +.SH SYNOPSIS +\f\*[B-Font]p11tool\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +[url] +.sp \n(Ppu +.ne 2 + +Operands and options may be intermixed. They will be reordered. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +Program that allows operations on PKCS #11 smart cards +and security modules. +.sp +To use PKCS #11 tokens with GnuTLS the p11-kit configuration files need to be setup. +That is create a .module file in /etc/pkcs11/modules with the contents 'module: /path/to/pkcs11.so'. +Alternatively the configuration file /etc/gnutls/pkcs11.conf has to exist and contain a number +of lines of the form 'load=/usr/lib/opensc-pkcs11.so'. +.sp +You can provide the PIN to be used for the PKCS #11 operations with the environment variables +GNUTLS_PIN and GNUTLS_SO_PIN. +.sp +.SH "OPTIONS" +.SS "Tokens" +.TP +.NOP \f\*[B-Font]\-\-list\-tokens\f[] +List all available tokens. +.sp +.TP +.NOP \f\*[B-Font]\-\-list\-token\-urls\f[] +List the URLs available tokens. +.sp +This is a more compact version of \-\-list\-tokens. +.TP +.NOP \f\*[B-Font]\-\-list\-mechanisms\f[] +List all available mechanisms in a token. +.sp +.TP +.NOP \f\*[B-Font]\-\-initialize\f[] +Initializes a PKCS #11 token. +.sp +.TP +.NOP \f\*[B-Font]\-\-initialize\-pin\f[] +Initializes/Resets a PKCS #11 token user PIN. +.sp +.TP +.NOP \f\*[B-Font]\-\-initialize\-so\-pin\f[] +Initializes/Resets a PKCS #11 token security officer PIN. +.sp +This initializes the security officer's PIN. When used non\-interactively use the GNUTLS_NEW_SO_PIN +environment variables to initialize SO's PIN. +.TP +.NOP \f\*[B-Font]\-\-set\-pin\f[]=\f\*[I-Font]str\f[] +Specify the PIN to use on token operations. +.sp +Alternatively the GNUTLS_PIN environment variable may be used. +.TP +.NOP \f\*[B-Font]\-\-set\-so\-pin\f[]=\f\*[I-Font]str\f[] +Specify the Security Officer's PIN to use on token initialization. +.sp +Alternatively the GNUTLS_SO_PIN environment variable may be used. +.SS "Object listing" +.TP +.NOP \f\*[B-Font]\-\-list\-all\f[] +List all available objects in a token. +.sp +All objects available in the token will be listed. That includes +objects which are potentially unaccessible using this tool. +.TP +.NOP \f\*[B-Font]\-\-list\-all\-certs\f[] +List all available certificates in a token. +.sp +That option will also provide more information on the +certificates, for example, expand the attached extensions in a trust +token (like p11\-kit\-trust). +.TP +.NOP \f\*[B-Font]\-\-list\-certs\f[] +List all certificates that have an associated private key. +.sp +That option will only display certificates which have a private +key associated with them (share the same ID). +.TP +.NOP \f\*[B-Font]\-\-list\-all\-privkeys\f[] +List all available private keys in a token. +.sp +Lists all the private keys in a token that match the specified URL. +.TP +.NOP \f\*[B-Font]\-\-list\-privkeys\f[] +This is an alias for the \fI--list-all-privkeys\fR option. +.TP +.NOP \f\*[B-Font]\-\-list\-keys\f[] +This is an alias for the \fI--list-all-privkeys\fR option. +.TP +.NOP \f\*[B-Font]\-\-list\-all\-trusted\f[] +List all available certificates marked as trusted. +.sp +.TP +.NOP \f\*[B-Font]\-\-export\f[] +Export the object specified by the URL. +This option must not appear in combination with any of the following options: +export-stapled, export-chain, export-pubkey. +.sp +.TP +.NOP \f\*[B-Font]\-\-export\-stapled\f[] +Export the certificate object specified by the URL. +This option must not appear in combination with any of the following options: +export, export-chain, export-pubkey. +.sp +Exports the certificate specified by the URL while including any attached extensions to it. +Since attached extensions are a p11\-kit extension, this option is only +available on p11\-kit registered trust modules. +.TP +.NOP \f\*[B-Font]\-\-export\-chain\f[] +Export the certificate specified by the URL and its chain of trust. +This option must not appear in combination with any of the following options: +export-stapled, export, export-pubkey. +.sp +Exports the certificate specified by the URL and generates its chain of trust based on the stored certificates in the module. +.TP +.NOP \f\*[B-Font]\-\-export\-pubkey\f[] +Export the public key for a private key. +This option must not appear in combination with any of the following options: +export-stapled, export, export-chain. +.sp +Exports the public key for the specified private key +.TP +.NOP \f\*[B-Font]\-\-info\f[] +List information on an available object in a token. +.sp +.TP +.NOP \f\*[B-Font]\-\-trusted\f[] +This is an alias for the \fI--mark-trusted\fR option. +.TP +.NOP \f\*[B-Font]\-\-distrusted\f[] +This is an alias for the \fI--mark-distrusted\fR option. +.SS "Key generation" +.TP +.NOP \f\*[B-Font]\-\-generate\-privkey\f[]=\f\*[I-Font]str\f[] +Generate private-public key pair of given type. +.sp +Generates a private\-public key pair in the specified token. +Acceptable types are RSA, ECDSA, Ed25519, and DSA. Should be combined with \-\-sec\-param or \-\-bits. +.TP +.NOP \f\*[B-Font]\-\-generate\-rsa\f[] +Generate an RSA private-public key pair. +.sp +Generates an RSA private\-public key pair on the specified token. +Should be combined with \-\-sec\-param or \-\-bits. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-generate\-dsa\f[] +Generate a DSA private-public key pair. +.sp +Generates a DSA private\-public key pair on the specified token. +Should be combined with \-\-sec\-param or \-\-bits. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-generate\-ecc\f[] +Generate an ECDSA private-public key pair. +.sp +Generates an ECDSA private\-public key pair on the specified token. +Should be combined with \-\-curve, \-\-sec\-param or \-\-bits. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-bits\f[]=\f\*[I-Font]num\f[] +Specify the number of bits for the key generate. +This option takes an integer number as its argument. +.sp +For applications which have no key\-size restrictions the +\-\-sec\-param option is recommended, as the sec\-param levels will adapt +to the acceptable security levels with the new versions of gnutls. +.TP +.NOP \f\*[B-Font]\-\-curve\f[]=\f\*[I-Font]str\f[] +Specify the curve used for EC key generation. +.sp +Supported values are secp192r1, secp224r1, secp256r1, secp384r1 and secp521r1. +.TP +.NOP \f\*[B-Font]\-\-sec\-param\f[]=\f\*[I-Font]security parameter\f[] +Specify the security level. +.sp +This is alternative to the bits option. Available options are [low, legacy, medium, high, ultra]. +.SS "Writing objects" +.TP +.NOP \f\*[B-Font]\-\-set\-id\f[]=\f\*[I-Font]str\f[] +Set the CKA_ID (in hex) for the specified by the URL object. +This option must not appear in combination with any of the following options: +write. +.sp +Modifies or sets the CKA_ID in the specified by the URL object. The ID should be specified in hexadecimal format without a '0x' prefix. +.TP +.NOP \f\*[B-Font]\-\-set\-label\f[]=\f\*[I-Font]str\f[] +Set the CKA_LABEL for the specified by the URL object. +This option must not appear in combination with any of the following options: +write, set-id. +.sp +Modifies or sets the CKA_LABEL in the specified by the URL object +.TP +.NOP \f\*[B-Font]\-\-write\f[] +Writes the loaded objects to a PKCS #11 token. +.sp +It can be used to write private, public keys, certificates or secret keys to a token. Must be combined with one of \-\-load\-privkey, \-\-load\-pubkey, \-\-load\-certificate option. +.sp +When writing a certificate object, its CKA_ID is set to the same CKA_ID of the corresponding public key, if it exists on the token; otherwise it will be derived from the X.509 Subject Key Identifier of the certificate. If this behavior is undesired, write the public key to the token beforehand. +.TP +.NOP \f\*[B-Font]\-\-delete\f[] +Deletes the objects matching the given PKCS #11 URL. +.sp +.TP +.NOP \f\*[B-Font]\-\-label\f[]=\f\*[I-Font]str\f[] +Sets a label for the write operation. +.sp +.TP +.NOP \f\*[B-Font]\-\-id\f[]=\f\*[I-Font]str\f[] +Sets an ID for the write operation. +.sp +Sets the CKA_ID to be set by the write operation. The ID should be specified in hexadecimal format without a '0x' prefix. +.TP +.NOP \f\*[B-Font]\-\-mark\-wrap\f[], \f\*[B-Font]\-\-no\-mark\-wrap\f[] +Marks the generated key to be a wrapping key. +The \fIno\-mark\-wrap\fP form will disable the option. +.sp +Marks the generated key with the CKA_WRAP flag. +.TP +.NOP \f\*[B-Font]\-\-mark\-trusted\f[], \f\*[B-Font]\-\-no\-mark\-trusted\f[] +Marks the object to be written as trusted. +This option must not appear in combination with any of the following options: +mark-distrusted. +The \fIno\-mark\-trusted\fP form will disable the option. +.sp +Marks the object to be generated/written with the CKA_TRUST flag. +.TP +.NOP \f\*[B-Font]\-\-mark\-distrusted\f[] +When retrieving objects, it requires the objects to be distrusted (blacklisted). +This option must not appear in combination with any of the following options: +mark-trusted. +.sp +Ensures that the objects retrieved have the CKA_X_TRUST flag. +This is p11\-kit trust module extension, thus this flag is only valid with +p11\-kit registered trust modules. +.TP +.NOP \f\*[B-Font]\-\-mark\-decrypt\f[], \f\*[B-Font]\-\-no\-mark\-decrypt\f[] +Marks the object to be written for decryption. +The \fIno\-mark\-decrypt\fP form will disable the option. +.sp +Marks the object to be generated/written with the CKA_DECRYPT flag set to true. +.TP +.NOP \f\*[B-Font]\-\-mark\-sign\f[], \f\*[B-Font]\-\-no\-mark\-sign\f[] +Marks the object to be written for signature generation. +The \fIno\-mark\-sign\fP form will disable the option. +.sp +Marks the object to be generated/written with the CKA_SIGN flag set to true. +.TP +.NOP \f\*[B-Font]\-\-mark\-ca\f[], \f\*[B-Font]\-\-no\-mark\-ca\f[] +Marks the object to be written as a CA. +The \fIno\-mark\-ca\fP form will disable the option. +.sp +Marks the object to be generated/written with the CKA_CERTIFICATE_CATEGORY as CA. +.TP +.NOP \f\*[B-Font]\-\-mark\-private\f[], \f\*[B-Font]\-\-no\-mark\-private\f[] +Marks the object to be written as private. +The \fIno\-mark\-private\fP form will disable the option. +.sp +Marks the object to be generated/written with the CKA_PRIVATE flag. The written object will require a PIN to be used. +.TP +.NOP \f\*[B-Font]\-\-ca\f[] +This is an alias for the \fI--mark-ca\fR option. +.TP +.NOP \f\*[B-Font]\-\-private\f[] +This is an alias for the \fI--mark-private\fR option. +.TP +.NOP \f\*[B-Font]\-\-mark\-always\-authenticate\f[], \f\*[B-Font]\-\-no\-mark\-always\-authenticate\f[] +Marks the object to be written as always authenticate. +The \fIno\-mark\-always\-authenticate\fP form will disable the option. +.sp +Marks the object to be generated/written with the CKA_ALWAYS_AUTHENTICATE flag. The written object will Mark the object as requiring authentication (pin entry) before every operation. +.TP +.NOP \f\*[B-Font]\-\-secret\-key\f[]=\f\*[I-Font]str\f[] +Provide a hex encoded secret key. +.sp +This secret key will be written to the module if \-\-write is specified. +.TP +.NOP \f\*[B-Font]\-\-load\-privkey\f[]=\f\*[I-Font]file\f[] +Private key file to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-load\-pubkey\f[]=\f\*[I-Font]file\f[] +Public key file to use. +.sp +.TP +.NOP \f\*[B-Font]\-\-load\-certificate\f[]=\f\*[I-Font]file\f[] +Certificate file to use. +.sp +.SS "Other options" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-\-outfile\f[]=\f\*[I-Font]str\f[] +Output file. +.sp +.TP +.NOP \f\*[B-Font]\-\-login\f[], \f\*[B-Font]\-\-no\-login\f[] +Force (user) login to token. +The \fIno\-login\fP form will disable the option. +.sp +.TP +.NOP \f\*[B-Font]\-\-so\-login\f[], \f\*[B-Font]\-\-no\-so\-login\f[] +Force security officer login to token. +The \fIno\-so\-login\fP form will disable the option. +.sp +Forces login to the token as security officer (admin). +.TP +.NOP \f\*[B-Font]\-\-admin\-login\f[] +This is an alias for the \fI--so-login\fR option. +.TP +.NOP \f\*[B-Font]\-\-test\-sign\f[] +Tests the signature operation of the provided object. +.sp +It can be used to test the correct operation of the signature operation. +If both a private and a public key are available this operation will sign and verify +the signed data. +.TP +.NOP \f\*[B-Font]\-\-sign\-params\f[]=\f\*[I-Font]str\f[] +Sign with a specific signature algorithm. +.sp +This option can be combined with \-\-test\-sign, to sign with +a specific signature algorithm variant. The only option supported is 'RSA\-PSS', and should be +specified in order to use RSA\-PSS signature on RSA keys. +.TP +.NOP \f\*[B-Font]\-\-hash\f[]=\f\*[I-Font]str\f[] +Hash algorithm to use for signing. +.sp +This option can be combined with test\-sign. Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512, SHA3\-224, SHA3\-256, SHA3\-384, SHA3\-512. +.TP +.NOP \f\*[B-Font]\-\-generate\-random\f[]=\f\*[I-Font]num\f[] +Generate random data. +This option takes an integer number as its argument. +.sp +Asks the token to generate a number of bytes of random bytes. +.TP +.NOP \f\*[B-Font]\-8\f[], \f\*[B-Font]\-\-pkcs8\f[] +Use PKCS #8 format for private keys. +.sp +.TP +.NOP \f\*[B-Font]\-\-inder\f[], \f\*[B-Font]\-\-no\-inder\f[] +Use DER/RAW format for input. +The \fIno\-inder\fP form will disable the option. +.sp +Use DER/RAW format for input certificates and private keys. +.TP +.NOP \f\*[B-Font]\-\-inraw\f[] +This is an alias for the \fI--inder\fR option. +.TP +.NOP \f\*[B-Font]\-\-outder\f[], \f\*[B-Font]\-\-no\-outder\f[] +Use DER format for output certificates, private keys, and DH parameters. +The \fIno\-outder\fP form will disable the option. +.sp +The output will be in DER or RAW format. +.TP +.NOP \f\*[B-Font]\-\-outraw\f[] +This is an alias for the \fI--outder\fR option. +.TP +.NOP \f\*[B-Font]\-\-provider\f[]=\f\*[I-Font]file\f[] +Specify the PKCS #11 provider library. +.sp +This will override the default options in /etc/gnutls/pkcs11.conf +.TP +.NOP \f\*[B-Font]\-\-provider\-opts\f[]=\f\*[I-Font]str\f[] +Specify parameters for the PKCS #11 provider library. +.sp +This is a PKCS#11 internal option used by few modules. + Mainly for testing PKCS#11 modules. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-\-detailed\-url\f[], \f\*[B-Font]\-\-no\-detailed\-url\f[] +Print detailed URLs. +The \fIno\-detailed\-url\fP form will disable the option. +.sp +.TP +.NOP \f\*[B-Font]\-\-only\-urls\f[] +Print a compact listing using only the URLs. +.sp +.TP +.NOP \f\*[B-Font]\-\-batch\f[] +Disable all interaction with the tool. +.sp +In batch mode there will be no prompts, all parameters need to be specified on command line. +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.sp +.SH EXAMPLES +To view all tokens in your system use: +.br +.in +4 +.nf +$ p11tool \-\-list\-tokens +.in -4 +.fi +.sp +To view all objects in a token use: +.br +.in +4 +.nf +$ p11tool \-\-login \-\-list\-all "pkcs11:TOKEN\-URL" +.in -4 +.fi +.sp +To store a private key and a certificate in a token run: +.br +.in +4 +.nf +$ p11tool \-\-login \-\-write "pkcs11:URL" \-\-load\-privkey key.pem \ + \-\-label "Mykey" +$ p11tool \-\-login \-\-write "pkcs11:URL" \-\-load\-certificate cert.pem \ + \-\-label "Mykey" +.in -4 +.fi +Note that some tokens require the same label to be used for the certificate +and its corresponding private key. +.sp +To generate an RSA private key inside the token use: +.br +.in +4 +.nf +$ p11tool \-\-login \-\-generate\-privkey rsa \-\-bits 1024 \-\-label "MyNewKey" \ + \-\-outfile MyNewKey.pub "pkcs11:TOKEN\-URL" +.in -4 +.fi +The bits parameter in the above example is explicitly set because some +tokens only support limited choices in the bit length. The output file is the +corresponding public key. This key can be used to general a certificate +request with certtool. +.br +.in +4 +.nf +certtool \-\-generate\-request \-\-load\-privkey "pkcs11:KEY\-URL" \ + \-\-load\-pubkey MyNewKey.pub \-\-outfile request.pem +.in -4 +.fi +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +certtool (1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org diff --git a/doc/manpages/psktool.1 b/doc/manpages/psktool.1 new file mode 100644 index 0000000..4b1a731 --- /dev/null +++ b/doc/manpages/psktool.1 @@ -0,0 +1,126 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH psktool 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]psktool\fP +\- GnuTLS PSK tool +.SH SYNOPSIS +\f\*[B-Font]psktool\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +.sp \n(Ppu +.ne 2 + +All arguments must be options. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +Program that generates random keys for use with TLS-PSK. The +keys are stored in hexadecimal format in a key file. +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-keysize\f[]=\f\*[I-Font]num\f[] +Specify the key size in bytes (default is 32-bytes or 256-bits). +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 512 +.fi +.in -4 +.sp +.TP +.NOP \f\*[B-Font]\-u\f[] \f\*[I-Font]str\f[], \f\*[B-Font]\-\-username\f[]=\f\*[I-Font]str\f[] +Specify the username to use. +.sp +.TP +.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]str\f[], \f\*[B-Font]\-\-pskfile\f[]=\f\*[I-Font]str\f[] +Specify a pre-shared key file. +.sp +This option will specify the pre\-shared key file to store the generated keys. +.TP +.NOP \f\*[B-Font]\-\-passwd\f[] +This is an alias for the \fI--pskfile\fR option. +.sp +.B +NOTE: THIS OPTION IS DEPRECATED +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.sp +.SH EXAMPLES +To add a user 'psk_identity' in \fIkeys.psk\fP for use with GnuTLS run: +.br +.in +4 +.nf +$ ./psktool \-u psk_identity \-p keys.psk +Generating a random key for user 'psk_identity' +Key stored to keys.psk +$ cat keys.psk +psk_identity:88f3824b3e5659f52d00e959bacab954b6540344 +$ +.in -4 +.fi +.sp +This command will create \fIkeys.psk\fP if it does not exist +and will add user 'psk_identity'. +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +gnutls\-cli\-debug (1), gnutls\-serv (1), srptool (1), certtool (1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org diff --git a/doc/manpages/srptool.1 b/doc/manpages/srptool.1 new file mode 100644 index 0000000..e76102e --- /dev/null +++ b/doc/manpages/srptool.1 @@ -0,0 +1,143 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH srptool 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]srptool\fP +\- GnuTLS SRP tool +.SH SYNOPSIS +\f\*[B-Font]srptool\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +.sp \n(Ppu +.ne 2 + +All arguments must be options. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +Simple program that emulates the programs in the Stanford SRP (Secure +Remote Password) libraries using GnuTLS. It is intended for use in places +where you don't expect SRP authentication to be the used for system users. +.sp +In brief, to use SRP you need to create two files. These are the password +file that holds the users and the verifiers associated with them and the +configuration file to hold the group parameters (called tpasswd.conf). +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-i\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-index\f[]=\f\*[I-Font]num\f[] +This option takes an integer number as its argument. +The default +\f\*[I-Font]number\f[] +for this option is: +.ti +4 + 3 +.sp +.TP +.NOP \f\*[B-Font]\-u\f[] \f\*[I-Font]str\f[], \f\*[B-Font]\-\-username\f[]=\f\*[I-Font]str\f[] +.TP +.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]str\f[], \f\*[B-Font]\-\-passwd\f[]=\f\*[I-Font]str\f[] +.TP +.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-salt\f[]=\f\*[I-Font]num\f[] +This option takes an integer number as its argument. +.TP +.NOP \f\*[B-Font]\-\-verify\f[] +Verifies the password provided against the password file. +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]str\f[], \f\*[B-Font]\-\-passwd\-conf\f[]=\f\*[I-Font]str\f[] +Specify a filename or a PKCS #11 URL to read the CAs from. +.TP +.NOP \f\*[B-Font]\-\-create\-conf\f[]=\f\*[I-Font]str\f[] +Generate a password configuration file. +.sp +This generates a password configuration file (tpasswd.conf) +containing the required for TLS parameters. +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.sp +.SH EXAMPLES +To create \fItpasswd.conf\fP which holds the g and n values for SRP protocol +(generator and a large prime), run: +.br +.in +4 +.nf +$ srptool \-\-create\-conf /etc/tpasswd.conf +.in -4 +.fi +.sp +This command will create \fI/etc/tpasswd\fP and will add user 'test' (you +will also be prompted for a password). Verifiers are stored by default +in the way libsrp expects. +.br +.in +4 +.nf +$ srptool \-\-passwd /etc/tpasswd \-\-passwd\-conf /etc/tpasswd.conf \-u test +.in -4 +.fi +.sp +.sp +This command will check against a password. If the password matches +the one in \fI/etc/tpasswd\fP you will get an ok. +.br +.in +4 +.nf +$ srptool \-\-passwd /etc/tpasswd \-\-passwd\\-conf /etc/tpasswd.conf \-\-verify \-u test +.in -4 +.fi +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +gnutls\-cli\-debug (1), gnutls\-serv (1), srptool (1), psktool (1), certtool (1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org diff --git a/doc/manpages/stamp_mans b/doc/manpages/stamp_mans new file mode 100644 index 0000000..ed08aac --- /dev/null +++ b/doc/manpages/stamp_mans @@ -0,0 +1 @@ +stamp_mans diff --git a/doc/manpages/tpmtool.1 b/doc/manpages/tpmtool.1 new file mode 100644 index 0000000..07b43e9 --- /dev/null +++ b/doc/manpages/tpmtool.1 @@ -0,0 +1,223 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH tpmtool 1 "09 Feb 2023" "3.7.9" "User Commands" +.SH NAME +\f\*[B-Font]tpmtool\fP +\- GnuTLS TPM tool +.SH SYNOPSIS +\f\*[B-Font]tpmtool\fP +.\" Mixture of short (flag) options and long options +[\f\*[B-Font]\-flags\f[]] +[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]] +[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]] +.sp \n(Ppu +.ne 2 + +All arguments must be options. +.sp \n(Ppu +.ne 2 +.SH "DESCRIPTION" +Program that allows handling cryptographic data from the TPM chip. +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[] +Enable debugging. +This option takes an integer number as its argument. +The value of +\f\*[I-Font]num\f[] +is constrained to being: +.in +4 +.nf +.na +in the range 0 through 9999 +.fi +.in -4 +.sp +Specifies the debug level. +.TP +.NOP \f\*[B-Font]\-\-infile\f[]=\f\*[I-Font]file\f[] +Input file. +.sp +.TP +.NOP \f\*[B-Font]\-\-outfile\f[]=\f\*[I-Font]str\f[] +Output file. +.sp +.TP +.NOP \f\*[B-Font]\-\-generate\-rsa\f[] +Generate an RSA private-public key pair. +.sp +Generates an RSA private\-public key pair in the TPM chip. +The key may be stored in file system and protected by a PIN, or stored (registered) +in the TPM chip flash. +.TP +.NOP \f\*[B-Font]\-\-register\f[] +Any generated key will be registered in the TPM. +This option must appear in combination with the following options: +generate-rsa. +.sp +.TP +.NOP \f\*[B-Font]\-\-signing\f[] +Any generated key will be a signing key. +This option must not appear in combination with any of the following options: +legacy. +This option must appear in combination with the following options: +generate-rsa. +.sp +.TP +.NOP \f\*[B-Font]\-\-legacy\f[] +Any generated key will be a legacy key. +This option must not appear in combination with any of the following options: +signing. +This option must appear in combination with the following options: +generate-rsa. +.sp +.TP +.NOP \f\*[B-Font]\-\-user\f[] +Any registered key will be a user key. +This option must not appear in combination with any of the following options: +system. +This option must appear in combination with the following options: +register. +.sp +The generated key will be stored in a user specific persistent storage. +.TP +.NOP \f\*[B-Font]\-\-system\f[] +Any registered key will be a system key. +This option must not appear in combination with any of the following options: +user. +This option must appear in combination with the following options: +register. +.sp +The generated key will be stored in system persistent storage. +.TP +.NOP \f\*[B-Font]\-\-pubkey\f[]=\f\*[I-Font]url\f[] +Prints the public key of the provided key. +.sp +.TP +.NOP \f\*[B-Font]\-\-list\f[] +Lists all stored keys in the TPM. +.sp +.TP +.NOP \f\*[B-Font]\-\-delete\f[]=\f\*[I-Font]url\f[] +Delete the key identified by the given URL (UUID). +.sp +.TP +.NOP \f\*[B-Font]\-\-test\-sign\f[]=\f\*[I-Font]url\f[] +Tests the signature operation of the provided object. +.sp +It can be used to test the correct operation of the signature operation. +This operation will sign and verify the signed data. +.TP +.NOP \f\*[B-Font]\-\-sec\-param\f[]=\f\*[I-Font]security parameter\f[] +Specify the security level [low, legacy, medium, high, ultra]. +.sp +This is alternative to the bits option. Note however that the +values allowed by the TPM chip are quantized and given values may be rounded up. +.TP +.NOP \f\*[B-Font]\-\-bits\f[]=\f\*[I-Font]num\f[] +Specify the number of bits for key generate. +This option takes an integer number as its argument. +.sp +.TP +.NOP \f\*[B-Font]\-\-inder\f[], \f\*[B-Font]\-\-no\-inder\f[] +Use the DER format for keys. +The \fIno\-inder\fP form will disable the option. +.sp +The input files will be assumed to be in the portable +DER format of TPM. The default format is a custom format used by various +TPM tools +.TP +.NOP \f\*[B-Font]\-\-outder\f[], \f\*[B-Font]\-\-no\-outder\f[] +Use DER format for output keys. +The \fIno\-outder\fP form will disable the option. +.sp +The output will be in the TPM portable DER format. +.TP +.NOP \f\*[B-Font]\-\-srk\-well\-known\f[] +SRK has well known password (20 bytes of zeros). +.sp +.TP +.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[] +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.TP +.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[] +Pass the extended usage information through a pager. + +.sp +.SH EXAMPLES +To generate a key that is to be stored in file system use: +.br +.in +4 +.nf +$ tpmtool \-\-generate\-rsa \-\-bits 2048 \-\-outfile tpmkey.pem +.in -4 +.fi +.sp +To generate a key that is to be stored in TPM's flash use: +.br +.in +4 +.nf +$ tpmtool \-\-generate\-rsa \-\-bits 2048 \-\-register \-\-user +.in -4 +.fi +.sp +To get the public key of a TPM key use: +.br +.in +4 +.nf +$ tpmtool \-\-pubkey tpmkey:uuid=58ad734b\-bde6\-45c7\-89d8\-756a55ad1891;storage=user \ + \-\-outfile pubkey.pem +.in -4 +.fi +.sp +or if the key is stored in the file system: +.br +.in +4 +.nf +$ tpmtool \-\-pubkey tpmkey:file=tmpkey.pem \-\-outfile pubkey.pem +.in -4 +.fi +.sp +To list all keys stored in TPM use: +.br +.in +4 +.nf +$ tpmtool \-\-list +.in -4 +.fi +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.PP +.SH "SEE ALSO" +p11tool (1), certtool (1) +.SH "AUTHORS" + +.SH "COPYRIGHT" +Copyright (C) 2020-2021 Free Software Foundation, and others all rights reserved. +This program is released under the terms of +the GNU General Public License, version 3 or later +. +.SH "BUGS" +Please send bug reports to: bugs@gnutls.org |