From: Nikos Mavrogiannopoulos Date: Sun, 20 Nov 2011 09:42:30 +0000 (+0100) Subject: Added a more robust manpage generation method. X-Git-Tag: gnutls_3_0_9~50 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=74072e5f188ed2cb38a45ecbbfdbde7a953b8621;p=thirdparty%2Fgnutls.git Added a more robust manpage generation method. --- diff --git a/NEWS b/NEWS index 8736240a15..d0bbd9ee20 100644 --- a/NEWS +++ b/NEWS @@ -2,6 +2,15 @@ GnuTLS NEWS -- History of user-visible changes. -*- outline -*- Copyright (C) 2000-2011 Free Software Foundation, Inc. See the end for copying conditions. +* Version 3.0.9 (unreleased) + +** doc: man pages for API functions generation was fixed and are +now added again in the distribution. + +** API and ABI modifications: +No changes since last version. + + * Version 3.0.8 (released 2011-11-12) ** certtool: Certtool -e returns error code on verification diff --git a/cfg.mk b/cfg.mk index 06bba7ed29..0f532e822f 100644 --- a/cfg.mk +++ b/cfg.mk @@ -107,6 +107,7 @@ prepare: ! git tag -l $(tag) | grep $(PACKAGE) > /dev/null rm -f ChangeLog $(MAKE) ChangeLog distcheck + $(MAKE) -C doc/manpages/ manpages-update git commit -m Generated. ChangeLog git tag -u b565716f! -m $(VERSION) $(tag) diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am index 081cb98c9b..ebc5292255 100644 --- a/doc/manpages/Makefile.am +++ b/doc/manpages/Makefile.am @@ -25,3 +25,803 @@ dist_man_MANS = gnutls-cli.1 gnutls-cli-debug.1 gnutls-serv.1 \ if ENABLE_SRP dist_man_MANS += srptool.1 endif + +APIMANS = +APIMANS += gnutls_pubkey_init.3 +APIMANS += gnutls_pubkey_deinit.3 +APIMANS += gnutls_pubkey_get_pk_algorithm.3 +APIMANS += gnutls_pubkey_import_x509.3 +APIMANS += gnutls_pubkey_import_pkcs11.3 +APIMANS += gnutls_pubkey_import_openpgp.3 +APIMANS += gnutls_pubkey_import_privkey.3 +APIMANS += gnutls_pubkey_get_preferred_hash_algorithm.3 +APIMANS += gnutls_pubkey_get_pk_rsa_raw.3 +APIMANS += gnutls_pubkey_get_pk_dsa_raw.3 +APIMANS += gnutls_pubkey_get_pk_ecc_raw.3 +APIMANS += gnutls_pubkey_get_pk_ecc_x962.3 +APIMANS += gnutls_pubkey_export.3 +APIMANS += gnutls_pubkey_get_key_id.3 +APIMANS += gnutls_pubkey_get_openpgp_key_id.3 +APIMANS += gnutls_pubkey_get_key_usage.3 +APIMANS += gnutls_pubkey_set_key_usage.3 +APIMANS += gnutls_pubkey_import.3 +APIMANS += gnutls_pubkey_import_pkcs11_url.3 +APIMANS += gnutls_pubkey_import_dsa_raw.3 +APIMANS += gnutls_pubkey_import_rsa_raw.3 +APIMANS += gnutls_pubkey_import_ecc_x962.3 +APIMANS += gnutls_pubkey_import_ecc_raw.3 +APIMANS += gnutls_x509_crt_set_pubkey.3 +APIMANS += gnutls_x509_crq_set_pubkey.3 +APIMANS += gnutls_pubkey_verify_hash.3 +APIMANS += gnutls_pubkey_get_verify_algorithm.3 +APIMANS += gnutls_pubkey_verify_data.3 +APIMANS += gnutls_pubkey_verify_data2.3 +APIMANS += gnutls_privkey_init.3 +APIMANS += gnutls_privkey_deinit.3 +APIMANS += gnutls_privkey_get_pk_algorithm.3 +APIMANS += gnutls_privkey_get_type.3 +APIMANS += gnutls_privkey_import_pkcs11.3 +APIMANS += gnutls_privkey_import_x509.3 +APIMANS += gnutls_privkey_import_openpgp.3 +APIMANS += gnutls_privkey_import_ext.3 +APIMANS += gnutls_privkey_sign_data.3 +APIMANS += gnutls_privkey_sign_hash.3 +APIMANS += gnutls_privkey_decrypt_data.3 +APIMANS += gnutls_x509_crt_privkey_sign.3 +APIMANS += gnutls_x509_crl_privkey_sign.3 +APIMANS += gnutls_x509_crq_privkey_sign.3 +APIMANS += gnutls_pcert_import_x509.3 +APIMANS += gnutls_pcert_list_import_x509_raw.3 +APIMANS += gnutls_pcert_import_x509_raw.3 +APIMANS += gnutls_pcert_import_openpgp_raw.3 +APIMANS += gnutls_pcert_import_openpgp.3 +APIMANS += gnutls_pcert_deinit.3 +APIMANS += gnutls_certificate_set_key.3 +APIMANS += gnutls_sign_callback_set.3 +APIMANS += gnutls_sign_callback_get.3 +APIMANS += gnutls_x509_privkey_sign_hash.3 +APIMANS += gnutls_openpgp_privkey_sign_hash.3 +APIMANS += gnutls_x509_privkey_sign_data.3 +APIMANS += gnutls_x509_crt_verify_data.3 +APIMANS += gnutls_x509_crt_verify_hash.3 +APIMANS += gnutls_x509_crt_get_verify_algorithm.3 +APIMANS += gnutls_x509_crt_get_preferred_hash_algorithm.3 +APIMANS += gnutls_x509_crq_sign.3 +APIMANS += gnutls_x509_crl_sign.3 +APIMANS += gnutls_cipher_set_priority.3 +APIMANS += gnutls_mac_set_priority.3 +APIMANS += gnutls_compression_set_priority.3 +APIMANS += gnutls_kx_set_priority.3 +APIMANS += gnutls_protocol_set_priority.3 +APIMANS += gnutls_certificate_type_set_priority.3 +APIMANS += gnutls_rsa_params_init.3 +APIMANS += gnutls_rsa_params_deinit.3 +APIMANS += gnutls_rsa_params_cpy.3 +APIMANS += gnutls_rsa_params_import_raw.3 +APIMANS += gnutls_rsa_params_generate2.3 +APIMANS += gnutls_rsa_params_export_raw.3 +APIMANS += gnutls_rsa_params_export_pkcs1.3 +APIMANS += gnutls_rsa_params_import_pkcs1.3 +APIMANS += gnutls_rsa_export_get_pubkey.3 +APIMANS += gnutls_rsa_export_get_modulus_bits.3 +APIMANS += gnutls_set_default_export_priority.3 +APIMANS += gnutls_certificate_set_rsa_export_params.3 +APIMANS += gnutls_cipher_init.3 +APIMANS += gnutls_cipher_encrypt.3 +APIMANS += gnutls_cipher_decrypt.3 +APIMANS += gnutls_cipher_decrypt2.3 +APIMANS += gnutls_cipher_encrypt2.3 +APIMANS += gnutls_cipher_set_iv.3 +APIMANS += gnutls_cipher_tag.3 +APIMANS += gnutls_cipher_add_auth.3 +APIMANS += gnutls_cipher_deinit.3 +APIMANS += gnutls_cipher_get_block_size.3 +APIMANS += gnutls_hmac_init.3 +APIMANS += gnutls_hmac.3 +APIMANS += gnutls_hmac_output.3 +APIMANS += gnutls_hmac_deinit.3 +APIMANS += gnutls_hmac_get_len.3 +APIMANS += gnutls_hmac_fast.3 +APIMANS += gnutls_hash_init.3 +APIMANS += gnutls_hash.3 +APIMANS += gnutls_hash_output.3 +APIMANS += gnutls_hash_deinit.3 +APIMANS += gnutls_hash_get_len.3 +APIMANS += gnutls_hash_fast.3 +APIMANS += gnutls_rnd.3 +APIMANS += gnutls_dtls_set_timeouts.3 +APIMANS += gnutls_dtls_get_mtu.3 +APIMANS += gnutls_dtls_get_data_mtu.3 +APIMANS += gnutls_dtls_set_mtu.3 +APIMANS += gnutls_dtls_cookie_send.3 +APIMANS += gnutls_dtls_prestate_set.3 +APIMANS += gnutls_dtls_cookie_send.3 +APIMANS += gnutls_dtls_cookie_verify.3 +APIMANS += gnutls_dtls_prestate_set.3 +APIMANS += gnutls_record_get_discarded.3 +APIMANS += gnutls_pk_algorithm_get_name.3 +APIMANS += gnutls_init.3 +APIMANS += gnutls_deinit.3 +APIMANS += gnutls_bye.3 +APIMANS += gnutls_handshake.3 +APIMANS += gnutls_rehandshake.3 +APIMANS += gnutls_alert_get.3 +APIMANS += gnutls_alert_send.3 +APIMANS += gnutls_alert_send_appropriate.3 +APIMANS += gnutls_alert_get_name.3 +APIMANS += gnutls_alert_get_strname.3 +APIMANS += gnutls_pk_bits_to_sec_param.3 +APIMANS += gnutls_sec_param_get_name.3 +APIMANS += gnutls_sec_param_to_pk_bits.3 +APIMANS += gnutls_ecc_curve_get_name.3 +APIMANS += gnutls_ecc_curve_get_size.3 +APIMANS += gnutls_ecc_curve_get.3 +APIMANS += gnutls_cipher_get.3 +APIMANS += gnutls_kx_get.3 +APIMANS += gnutls_mac_get.3 +APIMANS += gnutls_compression_get.3 +APIMANS += gnutls_certificate_type_get.3 +APIMANS += gnutls_sign_algorithm_get_requested.3 +APIMANS += gnutls_cipher_get_key_size.3 +APIMANS += gnutls_mac_get_key_size.3 +APIMANS += gnutls_cipher_get_name.3 +APIMANS += gnutls_mac_get_name.3 +APIMANS += gnutls_compression_get_name.3 +APIMANS += gnutls_kx_get_name.3 +APIMANS += gnutls_certificate_type_get_name.3 +APIMANS += gnutls_pk_get_name.3 +APIMANS += gnutls_sign_get_name.3 +APIMANS += gnutls_mac_get_id.3 +APIMANS += gnutls_compression_get_id.3 +APIMANS += gnutls_cipher_get_id.3 +APIMANS += gnutls_kx_get_id.3 +APIMANS += gnutls_protocol_get_id.3 +APIMANS += gnutls_certificate_type_get_id.3 +APIMANS += gnutls_pk_get_id.3 +APIMANS += gnutls_sign_get_id.3 +APIMANS += gnutls_cipher_list.3 +APIMANS += gnutls_mac_list.3 +APIMANS += gnutls_compression_list.3 +APIMANS += gnutls_protocol_list.3 +APIMANS += gnutls_certificate_type_list.3 +APIMANS += gnutls_kx_list.3 +APIMANS += gnutls_pk_list.3 +APIMANS += gnutls_sign_list.3 +APIMANS += gnutls_cipher_suite_info.3 +APIMANS += gnutls_error_is_fatal.3 +APIMANS += gnutls_error_to_alert.3 +APIMANS += gnutls_perror.3 +APIMANS += gnutls_strerror.3 +APIMANS += gnutls_strerror_name.3 +APIMANS += gnutls_handshake_set_private_extensions.3 +APIMANS += gnutls_handshake_get_last_out.3 +APIMANS += gnutls_handshake_get_last_in.3 +APIMANS += gnutls_record_send.3 +APIMANS += gnutls_record_recv.3 +APIMANS += gnutls_record_recv_seq.3 +APIMANS += gnutls_session_enable_compatibility_mode.3 +APIMANS += gnutls_record_disable_padding.3 +APIMANS += gnutls_record_get_direction.3 +APIMANS += gnutls_record_get_max_size.3 +APIMANS += gnutls_record_set_max_size.3 +APIMANS += gnutls_record_check_pending.3 +APIMANS += gnutls_prf.3 +APIMANS += gnutls_prf_raw.3 +APIMANS += gnutls_server_name_set.3 +APIMANS += gnutls_server_name_get.3 +APIMANS += gnutls_safe_renegotiation_status.3 +APIMANS += gnutls_supplemental_get_name.3 +APIMANS += gnutls_session_ticket_key_generate.3 +APIMANS += gnutls_session_ticket_enable_client.3 +APIMANS += gnutls_session_ticket_enable_server.3 +APIMANS += gnutls_key_generate.3 +APIMANS += gnutls_priority_init.3 +APIMANS += gnutls_priority_deinit.3 +APIMANS += gnutls_priority_set.3 +APIMANS += gnutls_priority_set_direct.3 +APIMANS += gnutls_set_default_priority.3 +APIMANS += gnutls_cipher_suite_get_name.3 +APIMANS += gnutls_protocol_get_version.3 +APIMANS += gnutls_protocol_get_name.3 +APIMANS += gnutls_session_set_data.3 +APIMANS += gnutls_session_get_data.3 +APIMANS += gnutls_session_get_data2.3 +APIMANS += gnutls_session_get_id.3 +APIMANS += gnutls_session_channel_binding.3 +APIMANS += gnutls_session_is_resumed.3 +APIMANS += gnutls_db_set_cache_expiration.3 +APIMANS += gnutls_db_remove_session.3 +APIMANS += gnutls_db_set_retrieve_function.3 +APIMANS += gnutls_db_set_remove_function.3 +APIMANS += gnutls_db_set_store_function.3 +APIMANS += gnutls_db_set_ptr.3 +APIMANS += gnutls_db_get_ptr.3 +APIMANS += gnutls_db_check_entry.3 +APIMANS += gnutls_handshake_set_post_client_hello_function.3 +APIMANS += gnutls_handshake_set_max_packet_length.3 +APIMANS += gnutls_check_version.3 +APIMANS += gnutls_credentials_clear.3 +APIMANS += gnutls_credentials_set.3 +APIMANS += gnutls_anon_free_server_credentials.3 +APIMANS += gnutls_anon_allocate_server_credentials.3 +APIMANS += gnutls_anon_set_server_dh_params.3 +APIMANS += gnutls_anon_set_server_params_function.3 +APIMANS += gnutls_anon_free_client_credentials.3 +APIMANS += gnutls_anon_allocate_client_credentials.3 +APIMANS += gnutls_certificate_free_credentials.3 +APIMANS += gnutls_certificate_allocate_credentials.3 +APIMANS += gnutls_certificate_get_issuer.3 +APIMANS += gnutls_certificate_free_keys.3 +APIMANS += gnutls_certificate_free_cas.3 +APIMANS += gnutls_certificate_free_ca_names.3 +APIMANS += gnutls_certificate_free_crls.3 +APIMANS += gnutls_certificate_set_dh_params.3 +APIMANS += gnutls_certificate_set_verify_flags.3 +APIMANS += gnutls_certificate_set_verify_limits.3 +APIMANS += gnutls_certificate_set_x509_trust_file.3 +APIMANS += gnutls_certificate_set_x509_trust_mem.3 +APIMANS += gnutls_certificate_set_x509_crl_file.3 +APIMANS += gnutls_certificate_set_x509_crl_mem.3 +APIMANS += gnutls_certificate_set_x509_key_file.3 +APIMANS += gnutls_certificate_set_x509_key_mem.3 +APIMANS += gnutls_certificate_send_x509_rdn_sequence.3 +APIMANS += gnutls_certificate_set_x509_key.3 +APIMANS += gnutls_certificate_set_x509_trust.3 +APIMANS += gnutls_certificate_set_x509_crl.3 +APIMANS += gnutls_certificate_get_openpgp_keyring.3 +APIMANS += gnutls_global_init.3 +APIMANS += gnutls_global_deinit.3 +APIMANS += gnutls_global_set_time_function.3 +APIMANS += gnutls_global_set_mutex.3 +APIMANS += gnutls_global_set_mem_functions.3 +APIMANS += gnutls_global_set_time_function.3 +APIMANS += gnutls_global_set_log_function.3 +APIMANS += gnutls_global_set_audit_log_function.3 +APIMANS += gnutls_global_set_log_level.3 +APIMANS += gnutls_dh_params_init.3 +APIMANS += gnutls_dh_params_deinit.3 +APIMANS += gnutls_dh_params_import_raw.3 +APIMANS += gnutls_dh_params_import_pkcs3.3 +APIMANS += gnutls_dh_params_generate2.3 +APIMANS += gnutls_dh_params_export_pkcs3.3 +APIMANS += gnutls_dh_params_export_raw.3 +APIMANS += gnutls_dh_params_cpy.3 +APIMANS += gnutls_transport_set_ptr.3 +APIMANS += gnutls_transport_set_ptr2.3 +APIMANS += gnutls_transport_get_ptr.3 +APIMANS += gnutls_transport_get_ptr2.3 +APIMANS += gnutls_transport_set_vec_push_function.3 +APIMANS += gnutls_transport_set_push_function.3 +APIMANS += gnutls_transport_set_pull_function.3 +APIMANS += gnutls_transport_set_pull_timeout_function.3 +APIMANS += gnutls_transport_set_errno_function.3 +APIMANS += gnutls_transport_set_errno.3 +APIMANS += gnutls_session_set_ptr.3 +APIMANS += gnutls_session_get_ptr.3 +APIMANS += gnutls_openpgp_send_cert.3 +APIMANS += gnutls_fingerprint.3 +APIMANS += gnutls_srp_free_client_credentials.3 +APIMANS += gnutls_srp_allocate_client_credentials.3 +APIMANS += gnutls_srp_set_client_credentials.3 +APIMANS += gnutls_srp_free_server_credentials.3 +APIMANS += gnutls_srp_allocate_server_credentials.3 +APIMANS += gnutls_srp_set_server_credentials_file.3 +APIMANS += gnutls_srp_server_get_username.3 +APIMANS += gnutls_srp_set_prime_bits.3 +APIMANS += gnutls_srp_verifier.3 +APIMANS += gnutls_srp_base64_encode.3 +APIMANS += gnutls_srp_base64_encode_alloc.3 +APIMANS += gnutls_srp_base64_decode.3 +APIMANS += gnutls_srp_base64_decode_alloc.3 +APIMANS += gnutls_psk_free_client_credentials.3 +APIMANS += gnutls_psk_allocate_client_credentials.3 +APIMANS += gnutls_psk_set_client_credentials.3 +APIMANS += gnutls_psk_free_server_credentials.3 +APIMANS += gnutls_psk_allocate_server_credentials.3 +APIMANS += gnutls_psk_set_server_credentials_file.3 +APIMANS += gnutls_psk_set_server_credentials_hint.3 +APIMANS += gnutls_psk_server_get_username.3 +APIMANS += gnutls_psk_client_get_hint.3 +APIMANS += gnutls_hex_encode.3 +APIMANS += gnutls_hex_decode.3 +APIMANS += gnutls_psk_set_server_dh_params.3 +APIMANS += gnutls_psk_set_server_params_function.3 +APIMANS += gnutls_x509_crt_get_subject_alt_othername_oid.3 +APIMANS += gnutls_x509_crt_get_subject_alt_othername_oid.3 +APIMANS += gnutls_auth_get_type.3 +APIMANS += gnutls_auth_server_get_type.3 +APIMANS += gnutls_auth_client_get_type.3 +APIMANS += gnutls_dh_set_prime_bits.3 +APIMANS += gnutls_dh_get_secret_bits.3 +APIMANS += gnutls_dh_get_peers_public_bits.3 +APIMANS += gnutls_dh_get_prime_bits.3 +APIMANS += gnutls_dh_get_group.3 +APIMANS += gnutls_dh_get_pubkey.3 +APIMANS += gnutls_certificate_set_verify_function.3 +APIMANS += gnutls_certificate_server_set_request.3 +APIMANS += gnutls_certificate_get_peers.3 +APIMANS += gnutls_certificate_get_ours.3 +APIMANS += gnutls_certificate_activation_time_peers.3 +APIMANS += gnutls_certificate_expiration_time_peers.3 +APIMANS += gnutls_certificate_client_get_request_status.3 +APIMANS += gnutls_certificate_verify_peers2.3 +APIMANS += gnutls_pem_base64_encode.3 +APIMANS += gnutls_pem_base64_decode.3 +APIMANS += gnutls_pem_base64_encode_alloc.3 +APIMANS += gnutls_pem_base64_decode_alloc.3 +APIMANS += gnutls_certificate_set_params_function.3 +APIMANS += gnutls_anon_set_params_function.3 +APIMANS += gnutls_psk_set_params_function.3 +APIMANS += gnutls_hex2bin.3 +APIMANS += gnutls_openpgp_crt_init.3 +APIMANS += gnutls_openpgp_crt_deinit.3 +APIMANS += gnutls_openpgp_crt_import.3 +APIMANS += gnutls_openpgp_crt_export.3 +APIMANS += gnutls_openpgp_crt_print.3 +APIMANS += gnutls_openpgp_crt_get_key_usage.3 +APIMANS += gnutls_openpgp_crt_get_fingerprint.3 +APIMANS += gnutls_openpgp_crt_get_subkey_fingerprint.3 +APIMANS += gnutls_openpgp_crt_get_name.3 +APIMANS += gnutls_openpgp_crt_get_pk_algorithm.3 +APIMANS += gnutls_openpgp_crt_get_version.3 +APIMANS += gnutls_openpgp_crt_get_creation_time.3 +APIMANS += gnutls_openpgp_crt_get_expiration_time.3 +APIMANS += gnutls_openpgp_crt_get_key_id.3 +APIMANS += gnutls_openpgp_crt_check_hostname.3 +APIMANS += gnutls_openpgp_crt_get_revoked_status.3 +APIMANS += gnutls_openpgp_crt_get_subkey_count.3 +APIMANS += gnutls_openpgp_crt_get_subkey_idx.3 +APIMANS += gnutls_openpgp_crt_get_subkey_revoked_status.3 +APIMANS += gnutls_openpgp_crt_get_subkey_pk_algorithm.3 +APIMANS += gnutls_openpgp_crt_get_subkey_creation_time.3 +APIMANS += gnutls_openpgp_crt_get_subkey_expiration_time.3 +APIMANS += gnutls_openpgp_crt_get_subkey_id.3 +APIMANS += gnutls_openpgp_crt_get_subkey_usage.3 +APIMANS += gnutls_openpgp_crt_get_subkey_pk_dsa_raw.3 +APIMANS += gnutls_openpgp_crt_get_subkey_pk_rsa_raw.3 +APIMANS += gnutls_openpgp_crt_get_pk_dsa_raw.3 +APIMANS += gnutls_openpgp_crt_get_pk_rsa_raw.3 +APIMANS += gnutls_openpgp_crt_get_preferred_key_id.3 +APIMANS += gnutls_openpgp_crt_set_preferred_key_id.3 +APIMANS += gnutls_openpgp_privkey_init.3 +APIMANS += gnutls_openpgp_privkey_deinit.3 +APIMANS += gnutls_openpgp_privkey_get_pk_algorithm.3 +APIMANS += gnutls_openpgp_privkey_sec_param.3 +APIMANS += gnutls_openpgp_privkey_import.3 +APIMANS += gnutls_openpgp_privkey_get_fingerprint.3 +APIMANS += gnutls_openpgp_privkey_get_subkey_fingerprint.3 +APIMANS += gnutls_openpgp_privkey_get_key_id.3 +APIMANS += gnutls_openpgp_privkey_get_subkey_count.3 +APIMANS += gnutls_openpgp_privkey_get_subkey_idx.3 +APIMANS += gnutls_openpgp_privkey_get_subkey_revoked_status.3 +APIMANS += gnutls_openpgp_privkey_get_revoked_status.3 +APIMANS += gnutls_openpgp_privkey_get_subkey_pk_algorithm.3 +APIMANS += gnutls_openpgp_privkey_get_subkey_id.3 +APIMANS += gnutls_openpgp_privkey_get_subkey_creation_time.3 +APIMANS += gnutls_openpgp_privkey_export_subkey_dsa_raw.3 +APIMANS += gnutls_openpgp_privkey_export_subkey_rsa_raw.3 +APIMANS += gnutls_openpgp_privkey_export_dsa_raw.3 +APIMANS += gnutls_openpgp_privkey_export_rsa_raw.3 +APIMANS += gnutls_openpgp_privkey_export.3 +APIMANS += gnutls_openpgp_privkey_set_preferred_key_id.3 +APIMANS += gnutls_openpgp_privkey_get_preferred_key_id.3 +APIMANS += gnutls_openpgp_crt_get_auth_subkey.3 +APIMANS += gnutls_openpgp_keyring_init.3 +APIMANS += gnutls_openpgp_keyring_deinit.3 +APIMANS += gnutls_openpgp_keyring_import.3 +APIMANS += gnutls_openpgp_keyring_check_id.3 +APIMANS += gnutls_openpgp_crt_verify_ring.3 +APIMANS += gnutls_openpgp_crt_verify_self.3 +APIMANS += gnutls_openpgp_keyring_get_crt.3 +APIMANS += gnutls_openpgp_keyring_get_crt_count.3 +APIMANS += gnutls_openpgp_set_recv_key_function.3 +APIMANS += gnutls_openpgp_set_recv_key_function.3 +APIMANS += gnutls_certificate_set_openpgp_key.3 +APIMANS += gnutls_certificate_set_openpgp_key_file.3 +APIMANS += gnutls_certificate_set_openpgp_key_mem.3 +APIMANS += gnutls_certificate_set_openpgp_key_file2.3 +APIMANS += gnutls_certificate_set_openpgp_key_mem2.3 +APIMANS += gnutls_pkcs11_set_pin_function.3 +APIMANS += gnutls_pkcs11_init.3 +APIMANS += gnutls_pkcs11_deinit.3 +APIMANS += gnutls_pkcs11_set_token_function.3 +APIMANS += gnutls_pkcs11_set_pin_function.3 +APIMANS += gnutls_pkcs11_add_provider.3 +APIMANS += gnutls_pkcs11_obj_init.3 +APIMANS += gnutls_pkcs11_obj_import_url.3 +APIMANS += gnutls_pkcs11_obj_export_url.3 +APIMANS += gnutls_pkcs11_obj_deinit.3 +APIMANS += gnutls_pkcs11_obj_export.3 +APIMANS += gnutls_pkcs11_copy_x509_crt.3 +APIMANS += gnutls_pkcs11_copy_x509_privkey.3 +APIMANS += gnutls_pkcs11_delete_url.3 +APIMANS += gnutls_pkcs11_copy_secret_key.3 +APIMANS += gnutls_pkcs11_obj_get_info.3 +APIMANS += gnutls_pkcs11_token_init.3 +APIMANS += gnutls_pkcs11_token_get_mechanism.3 +APIMANS += gnutls_pkcs11_token_set_pin.3 +APIMANS += gnutls_pkcs11_token_get_url.3 +APIMANS += gnutls_pkcs11_token_get_info.3 +APIMANS += gnutls_pkcs11_token_get_flags.3 +APIMANS += gnutls_pkcs11_obj_list_import_url.3 +APIMANS += gnutls_x509_crt_import_pkcs11.3 +APIMANS += gnutls_x509_crt_import_pkcs11_url.3 +APIMANS += gnutls_pkcs11_obj_get_type.3 +APIMANS += gnutls_pkcs11_type_get_name.3 +APIMANS += gnutls_x509_crt_list_import_pkcs11.3 +APIMANS += gnutls_pkcs11_privkey_init.3 +APIMANS += gnutls_pkcs11_privkey_deinit.3 +APIMANS += gnutls_pkcs11_privkey_get_pk_algorithm.3 +APIMANS += gnutls_pkcs11_privkey_get_info.3 +APIMANS += gnutls_pkcs11_privkey_import_url.3 +APIMANS += gnutls_pkcs11_privkey_export_url.3 +APIMANS += gnutls_pkcs11_privkey_generate.3 +APIMANS += gnutls_pkcs12_init.3 +APIMANS += gnutls_pkcs12_deinit.3 +APIMANS += gnutls_pkcs12_import.3 +APIMANS += gnutls_pkcs12_export.3 +APIMANS += gnutls_pkcs12_get_bag.3 +APIMANS += gnutls_pkcs12_set_bag.3 +APIMANS += gnutls_pkcs12_generate_mac.3 +APIMANS += gnutls_pkcs12_verify_mac.3 +APIMANS += gnutls_pkcs12_bag_decrypt.3 +APIMANS += gnutls_pkcs12_bag_encrypt.3 +APIMANS += gnutls_pkcs12_bag_get_type.3 +APIMANS += gnutls_pkcs12_bag_get_data.3 +APIMANS += gnutls_pkcs12_bag_set_data.3 +APIMANS += gnutls_pkcs12_bag_set_crl.3 +APIMANS += gnutls_pkcs12_bag_set_crt.3 +APIMANS += gnutls_pkcs12_bag_init.3 +APIMANS += gnutls_pkcs12_bag_deinit.3 +APIMANS += gnutls_pkcs12_bag_get_count.3 +APIMANS += gnutls_pkcs12_bag_get_key_id.3 +APIMANS += gnutls_pkcs12_bag_set_key_id.3 +APIMANS += gnutls_pkcs12_bag_get_friendly_name.3 +APIMANS += gnutls_pkcs12_bag_set_friendly_name.3 +APIMANS += gnutls_x509_crt_init.3 +APIMANS += gnutls_x509_crt_deinit.3 +APIMANS += gnutls_x509_crt_import.3 +APIMANS += gnutls_x509_crt_list_import2.3 +APIMANS += gnutls_x509_crt_list_import.3 +APIMANS += gnutls_x509_crt_export.3 +APIMANS += gnutls_x509_crt_get_issuer_dn.3 +APIMANS += gnutls_x509_crt_get_issuer_dn_oid.3 +APIMANS += gnutls_x509_crt_get_issuer_dn_by_oid.3 +APIMANS += gnutls_x509_crt_get_dn.3 +APIMANS += gnutls_x509_crt_get_dn_oid.3 +APIMANS += gnutls_x509_crt_get_dn_by_oid.3 +APIMANS += gnutls_x509_crt_check_hostname.3 +APIMANS += gnutls_x509_crt_get_signature_algorithm.3 +APIMANS += gnutls_x509_crt_get_signature.3 +APIMANS += gnutls_x509_crt_get_version.3 +APIMANS += gnutls_x509_crt_get_key_id.3 +APIMANS += gnutls_x509_crt_set_authority_key_id.3 +APIMANS += gnutls_x509_crt_get_authority_key_id.3 +APIMANS += gnutls_x509_crt_get_subject_key_id.3 +APIMANS += gnutls_x509_crt_get_subject_unique_id.3 +APIMANS += gnutls_x509_crt_get_issuer_unique_id.3 +APIMANS += gnutls_x509_crt_get_authority_info_access.3 +APIMANS += gnutls_x509_crt_get_authority_info_access.3 +APIMANS += gnutls_x509_crt_get_crl_dist_points.3 +APIMANS += gnutls_x509_crt_set_crl_dist_points2.3 +APIMANS += gnutls_x509_crt_set_crl_dist_points.3 +APIMANS += gnutls_x509_crt_cpy_crl_dist_points.3 +APIMANS += gnutls_x509_crl_sign2.3 +APIMANS += gnutls_x509_crt_get_activation_time.3 +APIMANS += gnutls_x509_crt_get_expiration_time.3 +APIMANS += gnutls_x509_crt_get_serial.3 +APIMANS += gnutls_x509_crt_get_pk_algorithm.3 +APIMANS += gnutls_x509_crt_get_pk_rsa_raw.3 +APIMANS += gnutls_x509_crt_get_pk_dsa_raw.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_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_ca_status.3 +APIMANS += gnutls_x509_crt_get_basic_constraints.3 +APIMANS += gnutls_x509_crt_get_key_usage.3 +APIMANS += gnutls_x509_crt_set_key_usage.3 +APIMANS += gnutls_x509_crt_get_proxy.3 +APIMANS += gnutls_x509_dn_oid_known.3 +APIMANS += gnutls_x509_crt_get_extension_oid.3 +APIMANS += gnutls_x509_crt_get_extension_by_oid.3 +APIMANS += gnutls_x509_crt_get_extension_info.3 +APIMANS += gnutls_x509_crt_get_extension_data.3 +APIMANS += gnutls_x509_crt_set_extension_by_oid.3 +APIMANS += gnutls_x509_crt_set_dn_by_oid.3 +APIMANS += gnutls_x509_crt_set_issuer_dn_by_oid.3 +APIMANS += gnutls_x509_crt_set_version.3 +APIMANS += gnutls_x509_crt_set_key.3 +APIMANS += gnutls_x509_crt_set_ca_status.3 +APIMANS += gnutls_x509_crt_set_basic_constraints.3 +APIMANS += gnutls_x509_crt_set_subject_alternative_name.3 +APIMANS += gnutls_x509_crt_set_subject_alt_name.3 +APIMANS += gnutls_x509_crt_sign.3 +APIMANS += gnutls_x509_crt_sign2.3 +APIMANS += gnutls_x509_crt_set_activation_time.3 +APIMANS += gnutls_x509_crt_set_expiration_time.3 +APIMANS += gnutls_x509_crt_set_serial.3 +APIMANS += gnutls_x509_crt_set_subject_key_id.3 +APIMANS += gnutls_x509_crt_set_proxy_dn.3 +APIMANS += gnutls_x509_crt_set_proxy.3 +APIMANS += gnutls_x509_crt_print.3 +APIMANS += gnutls_x509_crl_print.3 +APIMANS += gnutls_x509_crt_get_raw_issuer_dn.3 +APIMANS += gnutls_x509_crt_get_raw_dn.3 +APIMANS += gnutls_x509_rdn_get.3 +APIMANS += gnutls_x509_rdn_get_oid.3 +APIMANS += gnutls_x509_rdn_get_by_oid.3 +APIMANS += gnutls_x509_crt_get_subject.3 +APIMANS += gnutls_x509_crt_get_issuer.3 +APIMANS += gnutls_x509_dn_get_rdn_ava.3 +APIMANS += gnutls_x509_dn_init.3 +APIMANS += gnutls_x509_dn_import.3 +APIMANS += gnutls_x509_dn_export.3 +APIMANS += gnutls_x509_dn_deinit.3 +APIMANS += gnutls_x509_crl_init.3 +APIMANS += gnutls_x509_crl_deinit.3 +APIMANS += gnutls_x509_crl_import.3 +APIMANS += gnutls_x509_crl_export.3 +APIMANS += gnutls_x509_crl_get_raw_issuer_dn.3 +APIMANS += gnutls_x509_crl_get_issuer_dn.3 +APIMANS += gnutls_x509_crl_get_issuer_dn_by_oid.3 +APIMANS += gnutls_x509_crl_get_dn_oid.3 +APIMANS += gnutls_x509_crl_get_signature_algorithm.3 +APIMANS += gnutls_x509_crl_get_signature.3 +APIMANS += gnutls_x509_crl_get_version.3 +APIMANS += gnutls_x509_crl_get_this_update.3 +APIMANS += gnutls_x509_crl_get_next_update.3 +APIMANS += gnutls_x509_crl_get_crt_count.3 +APIMANS += gnutls_x509_crl_get_crt_serial.3 +APIMANS += gnutls_x509_crl_check_issuer.3 +APIMANS += gnutls_x509_crl_list_import2.3 +APIMANS += gnutls_x509_crl_list_import.3 +APIMANS += gnutls_x509_crl_set_version.3 +APIMANS += gnutls_x509_crl_set_this_update.3 +APIMANS += gnutls_x509_crl_set_next_update.3 +APIMANS += gnutls_x509_crl_set_crt_serial.3 +APIMANS += gnutls_x509_crl_set_crt.3 +APIMANS += gnutls_x509_crl_get_authority_key_id.3 +APIMANS += gnutls_x509_crl_get_number.3 +APIMANS += gnutls_x509_crl_get_extension_oid.3 +APIMANS += gnutls_x509_crl_get_extension_info.3 +APIMANS += gnutls_x509_crl_get_extension_data.3 +APIMANS += gnutls_x509_crl_set_authority_key_id.3 +APIMANS += gnutls_x509_crl_set_number.3 +APIMANS += gnutls_pkcs7_init.3 +APIMANS += gnutls_pkcs7_deinit.3 +APIMANS += gnutls_pkcs7_import.3 +APIMANS += gnutls_pkcs7_export.3 +APIMANS += gnutls_pkcs7_get_crt_count.3 +APIMANS += gnutls_pkcs7_get_crt_raw.3 +APIMANS += gnutls_pkcs7_set_crt_raw.3 +APIMANS += gnutls_pkcs7_set_crt.3 +APIMANS += gnutls_pkcs7_delete_crt.3 +APIMANS += gnutls_pkcs7_get_crl_raw.3 +APIMANS += gnutls_pkcs7_get_crl_count.3 +APIMANS += gnutls_pkcs7_set_crl_raw.3 +APIMANS += gnutls_pkcs7_set_crl.3 +APIMANS += gnutls_pkcs7_delete_crl.3 +APIMANS += gnutls_x509_crt_check_issuer.3 +APIMANS += gnutls_x509_crt_list_verify.3 +APIMANS += gnutls_x509_crt_verify.3 +APIMANS += gnutls_x509_crl_verify.3 +APIMANS += gnutls_x509_crt_check_revocation.3 +APIMANS += gnutls_x509_crt_get_fingerprint.3 +APIMANS += gnutls_x509_crt_get_key_purpose_oid.3 +APIMANS += gnutls_x509_crt_set_key_purpose_oid.3 +APIMANS += gnutls_x509_privkey_init.3 +APIMANS += gnutls_x509_privkey_deinit.3 +APIMANS += gnutls_x509_privkey_sec_param.3 +APIMANS += gnutls_x509_privkey_cpy.3 +APIMANS += gnutls_x509_privkey_import.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_import_ecc_raw.3 +APIMANS += gnutls_x509_privkey_fix.3 +APIMANS += gnutls_x509_privkey_export_dsa_raw.3 +APIMANS += gnutls_x509_privkey_import_dsa_raw.3 +APIMANS += gnutls_x509_privkey_get_pk_algorithm.3 +APIMANS += gnutls_x509_privkey_get_key_id.3 +APIMANS += gnutls_x509_privkey_generate.3 +APIMANS += gnutls_x509_privkey_verify_params.3 +APIMANS += gnutls_x509_privkey_export.3 +APIMANS += gnutls_x509_privkey_export_pkcs8.3 +APIMANS += gnutls_x509_privkey_export_rsa_raw2.3 +APIMANS += gnutls_x509_privkey_export_rsa_raw.3 +APIMANS += gnutls_x509_privkey_export_ecc_raw.3 +APIMANS += gnutls_x509_crq_sign2.3 +APIMANS += gnutls_x509_crq_print.3 +APIMANS += gnutls_x509_crq_verify.3 +APIMANS += gnutls_x509_crq_init.3 +APIMANS += gnutls_x509_crq_deinit.3 +APIMANS += gnutls_x509_crq_import.3 +APIMANS += gnutls_x509_crq_get_dn.3 +APIMANS += gnutls_x509_crq_get_dn_oid.3 +APIMANS += gnutls_x509_crq_get_dn_by_oid.3 +APIMANS += gnutls_x509_crq_set_dn_by_oid.3 +APIMANS += gnutls_x509_crq_set_version.3 +APIMANS += gnutls_x509_crq_get_version.3 +APIMANS += gnutls_x509_crq_set_key.3 +APIMANS += gnutls_x509_crq_set_challenge_password.3 +APIMANS += gnutls_x509_crq_get_challenge_password.3 +APIMANS += gnutls_x509_crq_set_attribute_by_oid.3 +APIMANS += gnutls_x509_crq_get_attribute_by_oid.3 +APIMANS += gnutls_x509_crq_export.3 +APIMANS += gnutls_x509_crt_set_crq.3 +APIMANS += gnutls_x509_crt_set_crq_extensions.3 +APIMANS += gnutls_x509_crq_set_key_rsa_raw.3 +APIMANS += gnutls_x509_crq_set_subject_alt_name.3 +APIMANS += gnutls_x509_crq_set_key_usage.3 +APIMANS += gnutls_x509_crq_set_basic_constraints.3 +APIMANS += gnutls_x509_crq_set_key_purpose_oid.3 +APIMANS += gnutls_x509_crq_get_key_purpose_oid.3 +APIMANS += gnutls_x509_crq_get_extension_data.3 +APIMANS += gnutls_x509_crq_get_extension_info.3 +APIMANS += gnutls_x509_crq_get_attribute_data.3 +APIMANS += gnutls_x509_crq_get_attribute_info.3 +APIMANS += gnutls_x509_crq_get_pk_algorithm.3 +APIMANS += gnutls_x509_crq_get_key_id.3 +APIMANS += gnutls_x509_crq_get_key_rsa_raw.3 +APIMANS += gnutls_x509_crq_get_key_usage.3 +APIMANS += gnutls_x509_crq_get_basic_constraints.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_extension_by_oid.3 +APIMANS += gnutls_x509_trust_list_init.3 +APIMANS += gnutls_x509_trust_list_deinit.3 +APIMANS += gnutls_x509_trust_list_get_issuer.3 +APIMANS += gnutls_x509_trust_list_add_cas.3 +APIMANS += gnutls_x509_trust_list_add_named_crt.3 +APIMANS += gnutls_x509_trust_list_add_crls.3 +APIMANS += gnutls_x509_trust_list_verify_named_crt.3 +APIMANS += gnutls_x509_trust_list_verify_crt.3 + +dist_man_MANS += $(APIMANS) + +manpages-update: + make update-makefile + make Makefile + make doit + +update-makefile: + FUNCS=`cat $(top_srcdir)/lib/includes/gnutls/*.h | $(top_srcdir)/doc/scripts/getfuncs.pl`; \ + MANS=""; \ + for i in $$FUNCS; do \ + MANS="$$MANS\nAPIMANS += $$i.3"; \ + done; \ + grep -v -e '^APIMANS += ' Makefile.am | \ + perl -p -e "s/^APIMANS =/APIMANS =$$MANS/" > foo; \ + mv foo Makefile.am + +doit: + @echo -n "Creating man pages for gnutls.h..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/gnutls.h`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-name "$(PACKAGE_NAME)" \ + -include "gnutls/gnutls.h" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2011 Free Software Foundation" \ + -function $$i \ + $(top_srcdir)/lib/*.c $(top_srcdir)/lib/*/*.c > $$i.3 2>/dev/null && \ + echo -n "."; \ + done + @echo "" + @echo -n "Creating man pages for compat.h..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/compat.h`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-name "$(PACKAGE_NAME)" \ + -include "gnutls/compat.h" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2011 Free Software Foundation" \ + -function $$i \ + $(top_srcdir)/lib/*.c $(top_srcdir)/lib/*/*.c > $$i.3 2>/dev/null && \ + echo -n "."; \ + done + @echo "" + @echo -n "Creating man pages for x509.h..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/x509.h`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-name "$(PACKAGE_NAME)" \ + -include "gnutls/x509.h" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2011 Free Software Foundation" \ + -function $$i \ + $(top_srcdir)/lib/*.c $(top_srcdir)/lib/*/*.c > $$i.3 2>/dev/null && \ + echo -n "."; \ + done + @echo "" + @echo -n "Creating man pages for abstract.h..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/abstract.h`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-name "$(PACKAGE_NAME)" \ + -include "gnutls/abstract.h" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2011 Free Software Foundation" \ + -function $$i \ + $(top_srcdir)/lib/*.c $(top_srcdir)/lib/*/*.c > $$i.3 2>/dev/null && \ + echo -n "."; \ + done + @echo "" + @echo -n "Creating man pages for pkcs12.h..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/pkcs12.h`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-name "$(PACKAGE_NAME)" \ + -include "gnutls/pkcs12.h" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2011 Free Software Foundation" \ + -function $$i \ + $(top_srcdir)/lib/*.c $(top_srcdir)/lib/*/*.c > $$i.3 2>/dev/null && \ + echo -n "."; \ + done + @echo "" + @echo -n "Creating man pages for pkcs11.h..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/pkcs11.h`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-name "$(PACKAGE_NAME)" \ + -include "gnutls/pkcs11.h" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2011 Free Software Foundation" \ + -function $$i \ + $(top_srcdir)/lib/*.c $(top_srcdir)/lib/*/*.c > $$i.3 2>/dev/null && \ + echo -n "."; \ + done + @echo "" + @echo -n "Creating man pages for dtls.h..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/dtls.h`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-name "$(PACKAGE_NAME)" \ + -include "gnutls/dtls.h" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2011 Free Software Foundation" \ + -function $$i \ + $(top_srcdir)/lib/*.c $(top_srcdir)/lib/*/*.c > $$i.3 2>/dev/null && \ + echo -n "."; \ + done + @echo "" + @echo -n "Creating man pages for openpgp.h..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/openpgp.h`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-name "$(PACKAGE_NAME)" \ + -include "gnutls/openpgp.h" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2011 Free Software Foundation" \ + -function $$i \ + $(top_srcdir)/lib/*.c $(top_srcdir)/lib/*/*.c > $$i.3 2>/dev/null && \ + echo -n "."; \ + done + @echo "" + @echo -n "Creating man pages for crypto.h..." && \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/crypto.h`; do \ + $(top_srcdir)/doc/scripts/gdoc -man \ + -module $(PACKAGE) -sourceversion $(VERSION) \ + -bugsto $(PACKAGE_BUGREPORT) \ + -pkg-name "$(PACKAGE_NAME)" \ + -include "gnutls/crypto.h" \ + -seeinfo $(PACKAGE) -verbatimcopying \ + -copyright "2011 Free Software Foundation" \ + -function $$i \ + $(top_srcdir)/lib/*.c $(top_srcdir)/lib/*/*.c > $$i.3 2>/dev/null && \ + echo -n "."; \ + done + +.PHONY: update-makefile doit diff --git a/doc/manpages/gnutls_alert_get.3 b/doc/manpages/gnutls_alert_get.3 new file mode 100644 index 0000000000..1cd651b888 --- /dev/null +++ b/doc/manpages/gnutls_alert_get.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_get" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_alert_get \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_alert_get_name.3 b/doc/manpages/gnutls_alert_get_name.3 new file mode 100644 index 0000000000..8826561d78 --- /dev/null +++ b/doc/manpages/gnutls_alert_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_alert_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_alert_get_strname.3 b/doc/manpages/gnutls_alert_get_strname.3 new file mode 100644 index 0000000000..51974995db --- /dev/null +++ b/doc/manpages/gnutls_alert_get_strname.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_get_strname" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_alert_get_strname \- API function +.SH SYNOPSIS +.B #include +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_alert_send.3 b/doc/manpages/gnutls_alert_send.3 new file mode 100644 index 0000000000..02fc8934e4 --- /dev/null +++ b/doc/manpages/gnutls_alert_send.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_send" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_alert_send \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_alert_send_appropriate.3 b/doc/manpages/gnutls_alert_send_appropriate.3 new file mode 100644 index 0000000000..973a66052d --- /dev/null +++ b/doc/manpages/gnutls_alert_send_appropriate.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_alert_send_appropriate" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_alert_send_appropriate \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "int err" 12 +is an integer +.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. + +If the return value is \fBGNUTLS_E_INVALID_REQUEST\fP, then no alert has +been sent to the peer. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a5c200c508 --- /dev/null +++ b/doc/manpages/gnutls_anon_allocate_client_credentials.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_allocate_client_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_anon_allocate_client_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus +this helper function is provided in order to allocate it. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..bcd80899f9 --- /dev/null +++ b/doc/manpages/gnutls_anon_allocate_server_credentials.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_allocate_server_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_anon_allocate_server_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to allocate it. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..26ec5685e3 --- /dev/null +++ b/doc/manpages/gnutls_anon_free_client_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_free_client_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_anon_free_client_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to free (deallocate) it. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8ba9a3bc33 --- /dev/null +++ b/doc/manpages/gnutls_anon_free_server_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_free_server_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_anon_free_server_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to free (deallocate) it. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5c45f0dedb --- /dev/null +++ b/doc/manpages/gnutls_anon_set_params_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_set_params_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_anon_set_params_function \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5020ac8dcd --- /dev/null +++ b/doc/manpages/gnutls_anon_set_server_dh_params.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_set_server_dh_params" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_anon_set_server_dh_params \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 +Anonymous Diffie\-Hellman cipher suites. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0327e926d0 --- /dev/null +++ b/doc/manpages/gnutls_anon_set_server_params_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_anon_set_server_params_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_anon_set_server_params_function \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..68c217e3a6 --- /dev/null +++ b/doc/manpages/gnutls_auth_client_get_type.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_auth_client_get_type" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_auth_client_get_type \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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. +.SH " RETURNS" +The type of credentials for the client authentication +schema, a \fBgnutls_credentials_type_t\fP type. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_auth_get_type.3 b/doc/manpages/gnutls_auth_get_type.3 new file mode 100644 index 0000000000..17ae5f515d --- /dev/null +++ b/doc/manpages/gnutls_auth_get_type.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_auth_get_type" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_auth_get_type \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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. +.SH " RETURNS" +The type of credentials for the current authentication +schema, a \fBgnutls_credentials_type_t\fP type. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0685081605 --- /dev/null +++ b/doc/manpages/gnutls_auth_server_get_type.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_auth_server_get_type" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_auth_server_get_type \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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. +.SH " RETURNS" +The type of credentials for the server authentication +schema, a \fBgnutls_credentials_type_t\fP type. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_bye.3 b/doc/manpages/gnutls_bye.3 new file mode 100644 index 0000000000..623b1b3e42 --- /dev/null +++ b/doc/manpages/gnutls_bye.3 @@ -0,0 +1,62 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_bye" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_bye \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..67ab770c79 --- /dev/null +++ b/doc/manpages/gnutls_certificate_activation_time_peers.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_activation_time_peers" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_activation_time_peers \- API function +.SH SYNOPSIS +.B #include +.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. +This is the creation time for openpgp keys. +.SH " RETURNS" +(time_t)\-1 on error. +.SH " DEPRECATED" +\fBgnutls_certificate_verify_peers2()\fP now verifies activation times. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_allocate_credentials.3 b/doc/manpages/gnutls_certificate_allocate_credentials.3 new file mode 100644 index 0000000000..36bba5dbf3 --- /dev/null +++ b/doc/manpages/gnutls_certificate_allocate_credentials.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_allocate_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_allocate_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to allocate it. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..d9a9496baa --- /dev/null +++ b/doc/manpages/gnutls_certificate_client_get_request_status.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_client_get_request_status" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_client_get_request_status \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int 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 is requested or not. +.SH " RETURNS" +0 if the peer (server) did not request client +authentication or 1 otherwise, or a negative error code in case of +error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..9076f1194c --- /dev/null +++ b/doc/manpages/gnutls_certificate_expiration_time_peers.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_expiration_time_peers" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_expiration_time_peers \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..54277839b5 --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_ca_names.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_ca_names" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_ca_names \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 advertize the CAs they support to +clients. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_free_cas.3 b/doc/manpages/gnutls_certificate_free_cas.3 new file mode 100644 index 0000000000..715fc0907f --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_cas.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_cas" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_cas \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This function will delete all the CAs associated with the given +credentials. Servers that do not use +\fBgnutls_certificate_verify_peers2()\fP may call this to save some +memory. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_free_credentials.3 b/doc/manpages/gnutls_certificate_free_credentials.3 new file mode 100644 index 0000000000..9f2723b944 --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_credentials.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to free (deallocate) it. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_free_crls.3 b/doc/manpages/gnutls_certificate_free_crls.3 new file mode 100644 index 0000000000..7d92f81e55 --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_crls.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_crls" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_crls \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This function will delete all the CRLs associated +with the given credentials. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_free_keys.3 b/doc/manpages/gnutls_certificate_free_keys.3 new file mode 100644 index 0000000000..839005fd3d --- /dev/null +++ b/doc/manpages/gnutls_certificate_free_keys.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_free_keys" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_free_keys \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_get_issuer.3 b/doc/manpages/gnutls_certificate_get_issuer.3 new file mode 100644 index 0000000000..6841431bdc --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_issuer.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_issuer" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_issuer \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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. +.SH " DESCRIPTION" +This function will return the issuer of a given certificate. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_get_openpgp_keyring.3 b/doc/manpages/gnutls_certificate_get_openpgp_keyring.3 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/manpages/gnutls_certificate_get_ours.3 b/doc/manpages/gnutls_certificate_get_ours.3 new file mode 100644 index 0000000000..ab89a38442 --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_ours.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_ours" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_ours \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +a pointer to a \fBgnutls_datum_t\fP containing our +certificates, or \fBNULL\fP in case of an error or if no certificate +was used. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_get_peers.3 b/doc/manpages/gnutls_certificate_get_peers.3 new file mode 100644 index 0000000000..2dbdad0989 --- /dev/null +++ b/doc/manpages/gnutls_certificate_get_peers.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_get_peers" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_get_peers \- API function +.SH SYNOPSIS +.B #include +.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 +.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 first +certificate in the list is the peer's certificate, following the +issuer's certificate, then the issuer's issuer etc. + +In case of OpenPGP keys a single key will be returned in raw +format. +.SH " RETURNS" +a pointer to a \fBgnutls_datum_t\fP containing our +certificates, or \fBNULL\fP in case of an error or if no certificate +was used. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..29c957016d --- /dev/null +++ b/doc/manpages/gnutls_certificate_send_x509_rdn_sequence.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_send_x509_rdn_sequence" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_send_x509_rdn_sequence \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_certificate_send_x509_rdn_sequence(gnutls_session_t " session ", int " status ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a pointer to a \fBgnutls_session_t\fP structure. +.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 advertize it's trusted CAs to the peer. If status +is zero then the default behaviour will take effect, which is to +advertize 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ad4d2988b9 --- /dev/null +++ b/doc/manpages/gnutls_certificate_server_set_request.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_server_set_request" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_server_set_request \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "gnutls_certificate_request_t req" 12 +is one of GNUTLS_CERT_REQUEST, GNUTLS_CERT_REQUIRE +.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 an 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. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e50907cf81 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_dh_params.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_dh_params" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_dh_params \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 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 if you +deallocate the parameters before the certificate is deallocated, +you must change the parameters stored in the certificate first. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_set_key.3 b/doc/manpages/gnutls_certificate_set_key.3 new file mode 100644 index 0000000000..fdf6a793b9 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_key.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_key" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_key \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "const char** names" 12 +is an array of DNS name of the certificate (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 (path) for the specified private key +.IP "int pcert_list_size" 12 +holds the size of the certificate list +.IP "gnutls_privkey_t key" 12 +is a gnutls_x509_privkey_t key +.SH " DESCRIPTION" +This function sets a certificate/private key pair in the +gnutls_certificate_credentials_t structure. 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 its own end +entity certificate (e.g., also an intermediate CA cert) then put +the certificate chain in \fIpcert_list\fP. The \fIpcert_list\fP and \fIkey\fP will +become part of the credentials structure and must not +be deallocated. They will be automatically deallocated when \fIres\fP is deinitialized. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_set_openpgp_key.3 b/doc/manpages/gnutls_certificate_set_openpgp_key.3 new file mode 100644 index 0000000000..4dc6fee254 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_openpgp_key.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_openpgp_key" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_openpgp_key \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_certificate_set_openpgp_key(gnutls_certificate_credentials_t " res ", gnutls_openpgp_crt_t " crt ", gnutls_openpgp_privkey_t " pkey ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a \fBgnutls_certificate_credentials_t\fP structure. +.IP "gnutls_openpgp_crt_t crt" 12 +contains an openpgp public key +.IP "gnutls_openpgp_privkey_t pkey" 12 +is an openpgp private key +.SH " DESCRIPTION" +This function sets a certificate/private key pair in the +gnutls_certificate_credentials_t structure. This function may be +called more than once (in case multiple keys/certificates exist +for the server). + +Note that this function requires that the preferred key ids have +been set and be used. See \fBgnutls_openpgp_crt_set_preferred_key_id()\fP. +Otherwise the master key will be used. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_set_openpgp_key_file.3 b/doc/manpages/gnutls_certificate_set_openpgp_key_file.3 new file mode 100644 index 0000000000..78dc4dc87b --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_openpgp_key_file.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_openpgp_key_file" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_openpgp_key_file \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_certificate_set_openpgp_key_file(gnutls_certificate_credentials_t " res ", const char * " certfile ", const char * " keyfile ", gnutls_openpgp_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +the destination context to save the data. +.IP "const char * certfile" 12 +the file that contains the public key. +.IP "const char * keyfile" 12 +the file that contains the secret key. +.IP "gnutls_openpgp_crt_fmt_t format" 12 +the format of the keys +.SH " DESCRIPTION" +This funtion is used to load OpenPGP keys into the GnuTLS +credentials structure. The file should contain at least one valid non encrypted subkey. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_set_openpgp_key_file2.3 b/doc/manpages/gnutls_certificate_set_openpgp_key_file2.3 new file mode 100644 index 0000000000..8b909dd617 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_openpgp_key_file2.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_openpgp_key_file2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_openpgp_key_file2 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_certificate_set_openpgp_key_file2(gnutls_certificate_credentials_t " res ", const char * " certfile ", const char * " keyfile ", const char * " subkey_id ", gnutls_openpgp_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +the destination context to save the data. +.IP "const char * certfile" 12 +the file that contains the public key. +.IP "const char * keyfile" 12 +the file that contains the secret key. +.IP "const char * subkey_id" 12 +a hex encoded subkey id +.IP "gnutls_openpgp_crt_fmt_t format" 12 +the format of the keys +.SH " DESCRIPTION" +This funtion is used to load OpenPGP keys into the GnuTLS credential +structure. The file should contain at least one valid non encrypted subkey. + +The special keyword "auto" is also accepted as \fIsubkey_id\fP. In that +case the \fBgnutls_openpgp_crt_get_auth_subkey()\fP will be used to +retrieve the subkey. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_set_openpgp_key_mem.3 b/doc/manpages/gnutls_certificate_set_openpgp_key_mem.3 new file mode 100644 index 0000000000..110e98f346 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_openpgp_key_mem.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_openpgp_key_mem" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_openpgp_key_mem \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_certificate_set_openpgp_key_mem(gnutls_certificate_credentials_t " res ", const gnutls_datum_t * " cert ", const gnutls_datum_t * " key ", gnutls_openpgp_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +the destination context to save the data. +.IP "const gnutls_datum_t * cert" 12 +the datum that contains the public key. +.IP "const gnutls_datum_t * key" 12 +the datum that contains the secret key. +.IP "gnutls_openpgp_crt_fmt_t format" 12 +the format of the keys +.SH " DESCRIPTION" +This funtion is used to load OpenPGP keys into the GnuTLS credential +structure. The datum should contain at least one valid non encrypted subkey. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_set_openpgp_key_mem2.3 b/doc/manpages/gnutls_certificate_set_openpgp_key_mem2.3 new file mode 100644 index 0000000000..581bc41b5a --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_openpgp_key_mem2.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_openpgp_key_mem2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_openpgp_key_mem2 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_certificate_set_openpgp_key_mem2(gnutls_certificate_credentials_t " res ", const gnutls_datum_t * " cert ", const gnutls_datum_t * " key ", const char * " subkey_id ", gnutls_openpgp_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +the destination context to save the data. +.IP "const gnutls_datum_t * cert" 12 +the datum that contains the public key. +.IP "const gnutls_datum_t * key" 12 +the datum that contains the secret key. +.IP "const char * subkey_id" 12 +a hex encoded subkey id +.IP "gnutls_openpgp_crt_fmt_t format" 12 +the format of the keys +.SH " DESCRIPTION" +This funtion is used to load OpenPGP keys into the GnuTLS +credentials structure. The datum should contain at least one valid non encrypted subkey. + +The special keyword "auto" is also accepted as \fIsubkey_id\fP. In that +case the \fBgnutls_openpgp_crt_get_auth_subkey()\fP will be used to +retrieve the subkey. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..4047895cff --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_params_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_params_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_params_function \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_set_rsa_export_params.3 b/doc/manpages/gnutls_certificate_set_rsa_export_params.3 new file mode 100644 index 0000000000..9b1ce54a89 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_rsa_export_params.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_rsa_export_params" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_rsa_export_params \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_certificate_set_rsa_export_params(gnutls_certificate_credentials_t " res ", gnutls_rsa_params_t " rsa_params ");" +.SH ARGUMENTS +.IP "gnutls_certificate_credentials_t res" 12 +is a gnutls_certificate_credentials_t structure +.IP "gnutls_rsa_params_t rsa_params" 12 +is a structure that holds temporary RSA parameters. +.SH " DESCRIPTION" +This function will set the temporary RSA parameters for a +certificate server to use. These parameters will be used in +RSA\-EXPORT cipher suites. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..567447e67f --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_verify_flags.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_verify_flags" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_verify_flags \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "unsigned int flags" 12 +are the flags +.SH " DESCRIPTION" +This function will set the flags to be used at verification of the +certificates. Flags must be OR of the +\fBgnutls_certificate_verify_flags\fP enumerations. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..bcd57fc67c --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_verify_function.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_verify_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_verify_function \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..20450207fa --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_verify_limits.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_verify_limits" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_verify_limits \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..9eeb9fa043 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_crl.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_crl" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_crl \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..fa7f94ae57 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_crl_file.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_crl_file" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_crl_file \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..10a2fd2513 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_crl_mem.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_crl_mem" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_crl_mem \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..523223c262 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_key.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_key" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_key \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 gnutls_x509_privkey_t key +.SH " DESCRIPTION" +This function sets a certificate/private key pair in the +gnutls_certificate_credentials_t structure. 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 its own end +entity certificate (e.g., also an intermediate CA cert) then put +the certificate chain in \fIcert_list\fP. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e865e1af9f --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_key_file.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_key_file" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_key_file \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 structure. 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. + +This function can also accept PKCS \fB11\fP URLs at \fIkeyfile\fP and \fIcertfile\fP. In that case it +will import the private key and certificate indicated by the URLs. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..fbbc33418e --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_key_mem.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_key_mem" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_key_mem \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 structure. 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. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..92c8f305de --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_trust.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_trust" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_trust \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..bc432e94df --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_trust_file.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_trust_file" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_trust_file \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 PKCS \fB11\fP URLs. In that case it +will import all certificates that are marked as trusted. +.SH " RETURNS" +number of certificates processed, or a negative error code on +error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e116cadaf1 --- /dev/null +++ b/doc/manpages/gnutls_certificate_set_x509_trust_mem.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_set_x509_trust_mem" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_set_x509_trust_mem \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_type_get.3 b/doc/manpages/gnutls_certificate_type_get.3 new file mode 100644 index 0000000000..e9e4f296dc --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_get.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_get" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_get \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +The certificate type is by default X.509, unless it is negotiated +as a TLS extension. +.SH " RETURNS" +the currently used \fBgnutls_certificate_type_t\fP certificate +type. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..507c2e3ead --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_get_id.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_get_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_get_id \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e80152ae85 --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_type_list.3 b/doc/manpages/gnutls_certificate_type_list.3 new file mode 100644 index 0000000000..3e3b2f5e87 --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_list" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_list \- API function +.SH SYNOPSIS +.B #include +.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. Note that to be able to use +OpenPGP certificates, you must link to libgnutls\-extra and call +\fBgnutls_global_init_extra()\fP. +.SH " RETURNS" +a (0)\-terminated list of \fBgnutls_certificate_type_t\fP +integers indicating the available certificate types. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_type_set_priority.3 b/doc/manpages/gnutls_certificate_type_set_priority.3 new file mode 100644 index 0000000000..8001fa6392 --- /dev/null +++ b/doc/manpages/gnutls_certificate_type_set_priority.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_type_set_priority" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_type_set_priority \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_certificate_type_set_priority(gnutls_session_t " session ", const int * " list ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.IP "const int * list" 12 +is a 0 terminated list of gnutls_certificate_type_t elements. +.SH " DESCRIPTION" +Sets the priority on the certificate types supported by gnutls. +Priority is higher for elements specified before others. +After specifying the types you want, you must append a 0. +Note that the certificate type priority is set on the client. +The server does not use the cert type priority except for disabling +types that were not specified. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_certificate_verify_peers2.3 b/doc/manpages/gnutls_certificate_verify_peers2.3 new file mode 100644 index 0000000000..a6ae81b334 --- /dev/null +++ b/doc/manpages/gnutls_certificate_verify_peers2.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_certificate_verify_peers2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_certificate_verify_peers2 \- API function +.SH SYNOPSIS +.B #include +.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 try to verify the peer's certificate and return +its status (trusted, invalid etc.). The value of \fIstatus\fP should +be one or more of the gnutls_certificate_status_t enumerated +elements bitwise or'd. 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 you must also check the peer's name in order to check if +the verified certificate belongs to the actual peer. + +This function uses \fBgnutls_x509_crt_list_verify()\fP with the CAs in +the credentials as trusted CAs. +.SH " RETURNS" +a negative error code on error and \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_check_version.3 b/doc/manpages/gnutls_check_version.3 new file mode 100644 index 0000000000..7d243af581 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_check_version \- API function +.SH SYNOPSIS +.B #include +.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 GnuTLS Library version. + +See \fBGNUTLS_VERSION\fP for a suitable \fIreq_version\fP string. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_add_auth.3 b/doc/manpages/gnutls_cipher_add_auth.3 new file mode 100644 index 0000000000..e719f31468 --- /dev/null +++ b/doc/manpages/gnutls_cipher_add_auth.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_add_auth" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_add_auth \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_cipher_add_auth(gnutls_cipher_hd_t " handle ", const void * " text ", size_t " text_size ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP structure. +.IP "const void * text" 12 +the data to be authenticated +.IP "size_t text_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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_decrypt.3 b/doc/manpages/gnutls_cipher_decrypt.3 new file mode 100644 index 0000000000..b3c75aff5c --- /dev/null +++ b/doc/manpages/gnutls_cipher_decrypt.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_decrypt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_decrypt \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_cipher_decrypt(gnutls_cipher_hd_t " handle ", void * " ciphertext ", size_t " ciphertextlen ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP structure. +.IP "void * ciphertext" 12 +the data to encrypt +.IP "size_t ciphertextlen" 12 +The length of data to encrypt +.SH " DESCRIPTION" +This function will decrypt 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_decrypt2.3 b/doc/manpages/gnutls_cipher_decrypt2.3 new file mode 100644 index 0000000000..4741d0c70c --- /dev/null +++ b/doc/manpages/gnutls_cipher_decrypt2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_decrypt2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_decrypt2 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_cipher_decrypt2(gnutls_cipher_hd_t " handle ", const void * " ciphertext ", size_t " ciphertextlen ", void * " text ", size_t " textlen ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP structure. +.IP "const void * ciphertext" 12 +the data to encrypt +.IP "size_t ciphertextlen" 12 +The length of data to encrypt +.IP "void * text" 12 +the decrypted data +.IP "size_t textlen" 12 +The available length for decrypted data +.SH " DESCRIPTION" +This function will decrypt the given data using the algorithm +specified by the context. +.SH " RETURNS" +Zero or a negative error code on error. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_deinit.3 b/doc/manpages/gnutls_cipher_deinit.3 new file mode 100644 index 0000000000..3f88a68107 --- /dev/null +++ b/doc/manpages/gnutls_cipher_deinit.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_deinit \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_encrypt.3 b/doc/manpages/gnutls_cipher_encrypt.3 new file mode 100644 index 0000000000..c691d9503c --- /dev/null +++ b/doc/manpages/gnutls_cipher_encrypt.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_encrypt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_encrypt \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_cipher_encrypt(gnutls_cipher_hd_t " handle ", void * " text ", size_t " textlen ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP structure. +.IP "void * text" 12 +the data to encrypt +.IP "size_t textlen" 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_encrypt2.3 b/doc/manpages/gnutls_cipher_encrypt2.3 new file mode 100644 index 0000000000..a8ccbe52b7 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_encrypt2 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_cipher_encrypt2(gnutls_cipher_hd_t " handle ", const void * " text ", size_t " textlen ", void * " ciphertext ", size_t " ciphertextlen ");" +.SH ARGUMENTS +.IP "gnutls_cipher_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP structure. +.IP "const void * text" 12 +the data to encrypt +.IP "size_t textlen" 12 +The length of data to encrypt +.IP "void * ciphertext" 12 +the encrypted data +.IP "size_t ciphertextlen" 12 +The available length for encrypted data +.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.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_get.3 b/doc/manpages/gnutls_cipher_get.3 new file mode 100644 index 0000000000..bc491b7337 --- /dev/null +++ b/doc/manpages/gnutls_cipher_get.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +Get currently used cipher. +.SH " RETURNS" +the currently used cipher, a \fBgnutls_cipher_algorithm_t\fP +type. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0070a32e24 --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_block_size.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_block_size" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_block_size \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_cipher_get_block_size(gnutls_cipher_algorithm_t " algorithm ");" +.SH ARGUMENTS +.IP "gnutls_cipher_algorithm_t algorithm" 12 +is an encryption algorithm +.SH " DESCRIPTION" +Get block size for encryption algorithm. +.SH " RETURNS" +block size for encryption algorithm. +.SH " SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_get_id.3 b/doc/manpages/gnutls_cipher_get_id.3 new file mode 100644 index 0000000000..1b576fba5e --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_id.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "gnutls_cipher_algorithm_t gnutls_cipher_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a MAC 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1c3e30a9fa --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_key_size.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_key_size" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_key_size \- API function +.SH SYNOPSIS +.B #include +.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" +Get key size for cipher. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_get_name.3 b/doc/manpages/gnutls_cipher_get_name.3 new file mode 100644 index 0000000000..9cef496293 --- /dev/null +++ b/doc/manpages/gnutls_cipher_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_init.3 b/doc/manpages/gnutls_cipher_init.3 new file mode 100644 index 0000000000..6e63d04fda --- /dev/null +++ b/doc/manpages/gnutls_cipher_init.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_init \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 +.IP "const gnutls_datum_t * iv" 12 +The IV to use (if not applicable set NULL) +.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" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_list.3 b/doc/manpages/gnutls_cipher_list.3 new file mode 100644 index 0000000000..4513834b57 --- /dev/null +++ b/doc/manpages/gnutls_cipher_list.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_list" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_list \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_set_iv.3 b/doc/manpages/gnutls_cipher_set_iv.3 new file mode 100644 index 0000000000..2f26217e42 --- /dev/null +++ b/doc/manpages/gnutls_cipher_set_iv.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_set_iv" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_set_iv \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_set_priority.3 b/doc/manpages/gnutls_cipher_set_priority.3 new file mode 100644 index 0000000000..bf62bb858f --- /dev/null +++ b/doc/manpages/gnutls_cipher_set_priority.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_set_priority" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_set_priority \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_cipher_set_priority(gnutls_session_t " session ", const int * " list ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.IP "const int * list" 12 +is a 0 terminated list of gnutls_cipher_algorithm_t elements. +.SH " DESCRIPTION" +Sets the priority on the ciphers supported by gnutls. Priority is +higher for elements specified before others. After specifying the +ciphers you want, you must append a 0. Note that the priority is +set on the client. The server does not use the algorithm's +priority except for disabling algorithms that were not specified. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ec7d2b3d6c --- /dev/null +++ b/doc/manpages/gnutls_cipher_suite_get_name.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_suite_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_suite_get_name \- API function +.SH SYNOPSIS +.B #include +.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" +Note that the full cipher suite name must be prepended by TLS or +SSL depending of the protocol in use. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_suite_info.3 b/doc/manpages/gnutls_cipher_suite_info.3 new file mode 100644 index 0000000000..2aecc2a2b4 --- /dev/null +++ b/doc/manpages/gnutls_cipher_suite_info.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_suite_info" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_suite_info \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "const char * gnutls_cipher_suite_info(size_t " idx ", 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 "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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_cipher_tag.3 b/doc/manpages/gnutls_cipher_tag.3 new file mode 100644 index 0000000000..adf8ec4bdc --- /dev/null +++ b/doc/manpages/gnutls_cipher_tag.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_cipher_tag" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_cipher_tag \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_compression_get.3 b/doc/manpages/gnutls_compression_get.3 new file mode 100644 index 0000000000..ebfab40e71 --- /dev/null +++ b/doc/manpages/gnutls_compression_get.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compression_get" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_compression_get \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +Get currently used compression algorithm. +.SH " RETURNS" +the currently used compression method, a +\fBgnutls_compression_method_t\fP value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_compression_get_id.3 b/doc/manpages/gnutls_compression_get_id.3 new file mode 100644 index 0000000000..e790855450 --- /dev/null +++ b/doc/manpages/gnutls_compression_get_id.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compression_get_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_compression_get_id \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_compression_get_name.3 b/doc/manpages/gnutls_compression_get_name.3 new file mode 100644 index 0000000000..2f54a48c01 --- /dev/null +++ b/doc/manpages/gnutls_compression_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compression_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_compression_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_compression_list.3 b/doc/manpages/gnutls_compression_list.3 new file mode 100644 index 0000000000..a2f16626a3 --- /dev/null +++ b/doc/manpages/gnutls_compression_list.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compression_list" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_compression_list \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_compression_set_priority.3 b/doc/manpages/gnutls_compression_set_priority.3 new file mode 100644 index 0000000000..cd2d443767 --- /dev/null +++ b/doc/manpages/gnutls_compression_set_priority.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_compression_set_priority" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_compression_set_priority \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_compression_set_priority(gnutls_session_t " session ", const int * " list ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.IP "const int * list" 12 +is a 0 terminated list of gnutls_compression_method_t elements. +.SH " DESCRIPTION" +Sets the priority on the compression algorithms supported by +gnutls. Priority is higher for elements specified before others. +After specifying the algorithms you want, you must append a 0. +Note that the priority is set on the client. The server does not +use the algorithm's priority except for disabling algorithms that +were not specified. + +TLS 1.0 does not define any compression algorithms except +NULL. Other compression algorithms are to be considered as gnutls +extensions. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_credentials_clear.3 b/doc/manpages/gnutls_credentials_clear.3 new file mode 100644 index 0000000000..59f76eb12b --- /dev/null +++ b/doc/manpages/gnutls_credentials_clear.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_credentials_clear" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_credentials_clear \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_credentials_clear(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.SH " DESCRIPTION" +Clears all the credentials previously set in this session. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_credentials_set.3 b/doc/manpages/gnutls_credentials_set.3 new file mode 100644 index 0000000000..c73e21837c --- /dev/null +++ b/doc/manpages/gnutls_credentials_set.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_credentials_set" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_credentials_set \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "gnutls_credentials_type_t type" 12 +is the type of the credentials +.IP "void * cred" 12 +is a pointer to a structure. +.SH " DESCRIPTION" +Sets the needed credentials for the specified type. Eg 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_db_check_entry.3 b/doc/manpages/gnutls_db_check_entry.3 new file mode 100644 index 0000000000..8ad55c9d9f --- /dev/null +++ b/doc/manpages/gnutls_db_check_entry.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_check_entry" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_db_check_entry \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "gnutls_datum_t session_entry" 12 +is the session data (not key) +.SH " DESCRIPTION" +Check if database entry has expired. This function is to be used +when you want to clear unnesessary session which occupy space in +your backend. +.SH " RETURNS" +Returns \fBGNUTLS_E_EXPIRED\fP, if the database entry has +expired or 0 otherwise. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_db_get_ptr.3 b/doc/manpages/gnutls_db_get_ptr.3 new file mode 100644 index 0000000000..79247a2dfe --- /dev/null +++ b/doc/manpages/gnutls_db_get_ptr.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_get_ptr" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_db_get_ptr \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_db_remove_session.3 b/doc/manpages/gnutls_db_remove_session.3 new file mode 100644 index 0000000000..992f2cad00 --- /dev/null +++ b/doc/manpages/gnutls_db_remove_session.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_remove_session" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_db_remove_session \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..d13fcf9ef8 --- /dev/null +++ b/doc/manpages/gnutls_db_set_cache_expiration.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_cache_expiration" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_cache_expiration \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "int seconds" 12 +is the number of seconds. +.SH " DESCRIPTION" +Set the expiration time for resumed sessions. The default is 3600 +(one hour) at the time writing this. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_db_set_ptr.3 b/doc/manpages/gnutls_db_set_ptr.3 new file mode 100644 index 0000000000..5d4834bc37 --- /dev/null +++ b/doc/manpages/gnutls_db_set_ptr.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_ptr" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_ptr \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ac6fee5c85 --- /dev/null +++ b/doc/manpages/gnutls_db_set_remove_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_remove_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_remove_function \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..339009a80f --- /dev/null +++ b/doc/manpages/gnutls_db_set_retrieve_function.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_retrieve_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_retrieve_function \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0f25210d75 --- /dev/null +++ b/doc/manpages/gnutls_db_set_store_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_db_set_store_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_db_set_store_function \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "gnutls_db_store_func store_func" 12 +is the function +.SH " DESCRIPTION" +Sets the function that will be used to store data from the resumed +sessions database. This function must remove 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_deinit.3 b/doc/manpages/gnutls_deinit.3 new file mode 100644 index 0000000000..8a868481a7 --- /dev/null +++ b/doc/manpages/gnutls_deinit.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_deinit(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dh_get_group.3 b/doc/manpages/gnutls_dh_get_group.3 new file mode 100644 index 0000000000..659c124f02 --- /dev/null +++ b/doc/manpages/gnutls_dh_get_group.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_group" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_group \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..9f435fa53a --- /dev/null +++ b/doc/manpages/gnutls_dh_get_peers_public_bits.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_peers_public_bits" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_peers_public_bits \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..63471a491b --- /dev/null +++ b/doc/manpages/gnutls_dh_get_prime_bits.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_prime_bits" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_prime_bits \- API function +.SH SYNOPSIS +.B #include +.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, does 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dh_get_pubkey.3 b/doc/manpages/gnutls_dh_get_pubkey.3 new file mode 100644 index 0000000000..743afc4e8b --- /dev/null +++ b/doc/manpages/gnutls_dh_get_pubkey.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_pubkey" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_pubkey \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b3dffa5a3b --- /dev/null +++ b/doc/manpages/gnutls_dh_get_secret_bits.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_get_secret_bits" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_get_secret_bits \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dh_params_cpy.3 b/doc/manpages/gnutls_dh_params_cpy.3 new file mode 100644 index 0000000000..df7d3fcfed --- /dev/null +++ b/doc/manpages/gnutls_dh_params_cpy.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_cpy" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_cpy \- API function +.SH SYNOPSIS +.B #include +.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 structure, which should be initialized. +.IP "gnutls_dh_params_t src" 12 +Is the source structure +.SH " DESCRIPTION" +This function will copy the DH parameters structure from source +to destination. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dh_params_deinit.3 b/doc/manpages/gnutls_dh_params_deinit.3 new file mode 100644 index 0000000000..287a5b1384 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_dh_params_deinit(gnutls_dh_params_t " dh_params ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t dh_params" 12 +Is a structure that holds the prime numbers +.SH " DESCRIPTION" +This function will deinitialize the DH parameters structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..d09ccd56a7 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_export_pkcs3.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_export_pkcs3" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_export_pkcs3 \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b02cb2ef08 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_export_raw.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_export_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_export_raw \- API function +.SH SYNOPSIS +.B #include +.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 is the prime'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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dh_params_generate2.3 b/doc/manpages/gnutls_dh_params_generate2.3 new file mode 100644 index 0000000000..391df406cb --- /dev/null +++ b/doc/manpages/gnutls_dh_params_generate2.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_generate2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_generate2 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_dh_params_generate2(gnutls_dh_params_t " params ", unsigned int " bits ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t params" 12 +Is the structure that the DH parameters will be stored +.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. The new parameters will be allocated using +\fBgnutls_malloc()\fP and will be stored in the appropriate datum. +This function is normally slow. + +Do not set the number of bits directly, use \fBgnutls_sec_param_to_pk_bits()\fP to +get bits for \fBGNUTLS_PK_DSA\fP. +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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..9e4a690ee5 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_import_pkcs3.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_import_pkcs3" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_import_pkcs3 \- API function +.SH SYNOPSIS +.B #include +.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 +A structure where the parameters will be copied to +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8d433deb05 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_import_raw.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_import_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_import_raw \- API function +.SH SYNOPSIS +.B #include +.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 +Is a structure that will hold the prime numbers +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dh_params_init.3 b/doc/manpages/gnutls_dh_params_init.3 new file mode 100644 index 0000000000..1356916d53 --- /dev/null +++ b/doc/manpages/gnutls_dh_params_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_params_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_params_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_dh_params_init(gnutls_dh_params_t * " dh_params ");" +.SH ARGUMENTS +.IP "gnutls_dh_params_t * dh_params" 12 +Is a structure that will hold the prime numbers +.SH " DESCRIPTION" +This function will initialize the DH parameters structure. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a724561c75 --- /dev/null +++ b/doc/manpages/gnutls_dh_set_prime_bits.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dh_set_prime_bits" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dh_set_prime_bits \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "unsigned int bits" 12 +is the number of bits +.SH " DESCRIPTION" +This function sets the number of bits, for use in an 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. + +This function has no effect in server side. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dtls_cookie_send.3 b/doc/manpages/gnutls_dtls_cookie_send.3 new file mode 100644 index 0000000000..3120686fcd --- /dev/null +++ b/doc/manpages/gnutls_dtls_cookie_send.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_cookie_send" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_cookie_send \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +the number of bytes sent, or a negative error code. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dtls_cookie_verify.3 b/doc/manpages/gnutls_dtls_cookie_verify.3 new file mode 100644 index 0000000000..83c5623e35 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_cookie_verify \- API function +.SH SYNOPSIS +.B #include +.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 an incoming 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; +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1bd4553d55 --- /dev/null +++ b/doc/manpages/gnutls_dtls_get_data_mtu.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_get_data_mtu" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_get_data_mtu \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This function will return the actual maximum transfer unit for +application data. I.e. DTLS headers are subtracted from the +actual MTU. +.SH " RETURNS" +the maximum allowed transfer unit. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dtls_get_mtu.3 b/doc/manpages/gnutls_dtls_get_mtu.3 new file mode 100644 index 0000000000..c866dfbb61 --- /dev/null +++ b/doc/manpages/gnutls_dtls_get_mtu.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_get_mtu" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_get_mtu \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dtls_prestate_set.3 b/doc/manpages/gnutls_dtls_prestate_set.3 new file mode 100644 index 0000000000..76f9296c5f --- /dev/null +++ b/doc/manpages/gnutls_dtls_prestate_set.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_prestate_set" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_prestate_set \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dtls_set_mtu.3 b/doc/manpages/gnutls_dtls_set_mtu.3 new file mode 100644 index 0000000000..74849e67d1 --- /dev/null +++ b/doc/manpages/gnutls_dtls_set_mtu.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_set_mtu" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_set_mtu \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "unsigned int mtu" 12 +The maximum transfer unit of the interface +.SH " DESCRIPTION" +This function will set the maximum transfer unit of the interface +that DTLS packets are expected to leave from. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_dtls_set_timeouts.3 b/doc/manpages/gnutls_dtls_set_timeouts.3 new file mode 100644 index 0000000000..da2c40b6b9 --- /dev/null +++ b/doc/manpages/gnutls_dtls_set_timeouts.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_dtls_set_timeouts" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_dtls_set_timeouts \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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. + +If the retransmission timeout is zero then the handshake will operate +in a non\-blocking way, i.e., return \fBGNUTLS_E_AGAIN\fP. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_ecc_curve_get.3 b/doc/manpages/gnutls_ecc_curve_get.3 new file mode 100644 index 0000000000..f2008b252e --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_get.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_get" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_get \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +Returns the currently used elliptic curve. 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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8b41b78abd --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_get_name.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_get_name \- API function +.SH SYNOPSIS +.B #include +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..f71e0c5498 --- /dev/null +++ b/doc/manpages/gnutls_ecc_curve_get_size.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_ecc_curve_get_size" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_ecc_curve_get_size \- API function +.SH SYNOPSIS +.B #include +.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 " DESCRIPTION" +Returns the size in bytes of the curve. +.SH " RETURNS" +a the size or (0). +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_error_is_fatal.3 b/doc/manpages/gnutls_error_is_fatal.3 new file mode 100644 index 0000000000..505d8f4639 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_error_is_fatal \- API function +.SH SYNOPSIS +.B #include +.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. +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 +the record layer or the handshake layer. +.SH " RETURNS" +1 if the error code is fatal, for positive \fIerror\fP values, +0 is returned. For unknown \fIerror\fP values, \-1 is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_error_to_alert.3 b/doc/manpages/gnutls_error_to_alert.3 new file mode 100644 index 0000000000..114c78b8f2 --- /dev/null +++ b/doc/manpages/gnutls_error_to_alert.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_error_to_alert" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_error_to_alert \- API function +.SH SYNOPSIS +.B #include +.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 is returned. +.SH " RETURNS" +the alert code to use for a particular error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_fingerprint.3 b/doc/manpages/gnutls_fingerprint.3 new file mode 100644 index 0000000000..a3adc62832 --- /dev/null +++ b/doc/manpages/gnutls_fingerprint.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_fingerprint" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_fingerprint \- API function +.SH SYNOPSIS +.B #include +.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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_global_deinit.3 b/doc/manpages/gnutls_global_deinit.3 new file mode 100644 index 0000000000..8004f37061 --- /dev/null +++ b/doc/manpages/gnutls_global_deinit.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_global_deinit \- API function +.SH SYNOPSIS +.B #include +.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. + +Note! This function is not thread safe. See the discussion for +\fBgnutls_global_init()\fP for more information. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_global_init.3 b/doc/manpages/gnutls_global_init.3 new file mode 100644 index 0000000000..a82bfcad1e --- /dev/null +++ b/doc/manpages/gnutls_global_init.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_global_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_global_init( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH " DESCRIPTION" + +This function initializes the global data to defaults. Every +gnutls application has a global data which holds common parameters +shared by gnutls session structures. You should call +\fBgnutls_global_deinit()\fP when gnutls usage is no longer needed + +Note that this function will also initialize the underlying crypto +backend, if it has not been initialized before. + +This function increment 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. + +Note! This function is not thread safe. If two threads call this +function simultaneously, they can cause a race between checking +the global counter and incrementing it, causing both threads to +execute the library initialization code. That would lead to a +memory leak. To handle this, your application could invoke this +function after aquiring a thread mutex. To ignore the potential +memory leak is also an option. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..897eff0e1e --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_audit_log_function \- API function +.SH SYNOPSIS +.B #include +.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 where you set the logging function gnutls is +going to use. This is different from \fBgnutls_global_set_log_function()\fP +because it will report the session of the event if any. Note that +that session might 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, int level, const char*); +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..91c0eab091 --- /dev/null +++ b/doc/manpages/gnutls_global_set_log_function.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_log_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_log_function \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..15f7e548e9 --- /dev/null +++ b/doc/manpages/gnutls_global_set_log_level.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_log_level" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_log_level \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_global_set_log_level(int " level ");" +.SH ARGUMENTS +.IP "int level" 12 +it's an integer from 0 to 9. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a50871004b --- /dev/null +++ b/doc/manpages/gnutls_global_set_mem_functions.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_mem_functions" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_mem_functions \- API function +.SH SYNOPSIS +.B #include +.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 " DESCRIPTION" +This is the function were 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_global_set_mutex.3 b/doc/manpages/gnutls_global_set_mutex.3 new file mode 100644 index 0000000000..aec6b11ce0 --- /dev/null +++ b/doc/manpages/gnutls_global_set_mutex.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_mutex" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_mutex \- API function +.SH SYNOPSIS +.B #include +.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. Instead only initialize gnutls and +the default OS mutex locks will be used. + +This function must be called before \fBgnutls_global_init()\fP. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..93c4f71ffd --- /dev/null +++ b/doc/manpages/gnutls_global_set_time_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_global_set_time_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_global_set_time_function \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_handshake.3 b/doc/manpages/gnutls_handshake.3 new file mode 100644 index 0000000000..9ec572921a --- /dev/null +++ b/doc/manpages/gnutls_handshake.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_handshake \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_handshake(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.SH " DESCRIPTION" +This function does the handshake of the TLS/SSL protocol, and +initializes the TLS connection. + +This function will fail if any problem is encountered, and will +return a negative error code. In case of a client, if the client +has asked to resume a session, but the server couldn't, then a +full handshake will be performed. + +The non\-fatal errors such as \fBGNUTLS_E_AGAIN\fP and +\fBGNUTLS_E_INTERRUPTED\fP interrupt the handshake procedure, which +should be later be resumed. Call this function again, until it +returns 0; cf. \fBgnutls_record_get_direction()\fP and +\fBgnutls_error_is_fatal()\fP. + +If this function is called by a server after a rehandshake request +then \fBGNUTLS_E_GOT_APPLICATION_DATA\fP or +\fBGNUTLS_E_WARNING_ALERT_RECEIVED\fP may be returned. Note that these +are non fatal errors, only in the specific case of a rehandshake. +Their meaning is that the client rejected the rehandshake request or +in the case of \fBGNUTLS_E_GOT_APPLICATION_DATA\fP it might also mean that +some data were pending. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e000461cb1 --- /dev/null +++ b/doc/manpages/gnutls_handshake_get_last_in.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_get_last_in" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_get_last_in \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..6cedfd78b2 --- /dev/null +++ b/doc/manpages/gnutls_handshake_get_last_out.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_get_last_out" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_get_last_out \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..bbef934db7 --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_max_packet_length.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_max_packet_length" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_max_packet_length \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 +48kb 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. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..dad709cade --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_post_client_hello_function.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_post_client_hello_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_post_client_hello_function \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_handshake_set_post_client_hello_function(gnutls_session_t " session ", gnutls_handshake_post_client_hello_func " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.IP "gnutls_handshake_post_client_hello_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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..70cbbf0408 --- /dev/null +++ b/doc/manpages/gnutls_handshake_set_private_extensions.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_handshake_set_private_extensions" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_handshake_set_private_extensions \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 advertized 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hash.3 b/doc/manpages/gnutls_hash.3 new file mode 100644 index 0000000000..c865b86b40 --- /dev/null +++ b/doc/manpages/gnutls_hash.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hash \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_hash(gnutls_hash_hd_t " handle ", const void * " text ", size_t " textlen ");" +.SH ARGUMENTS +.IP "gnutls_hash_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP structure. +.IP "const void * text" 12 +the data to hash +.IP "size_t textlen" 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hash_deinit.3 b/doc/manpages/gnutls_hash_deinit.3 new file mode 100644 index 0000000000..6cc320fbb4 --- /dev/null +++ b/doc/manpages/gnutls_hash_deinit.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hash_deinit \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hash_fast.3 b/doc/manpages/gnutls_hash_fast.3 new file mode 100644 index 0000000000..855b557285 --- /dev/null +++ b/doc/manpages/gnutls_hash_fast.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_fast" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hash_fast \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_hash_fast(gnutls_digest_algorithm_t " algorithm ", const void * " text ", size_t " textlen ", void * " digest ");" +.SH ARGUMENTS +.IP "gnutls_digest_algorithm_t algorithm" 12 +the hash algorithm to use +.IP "const void * text" 12 +the data to hash +.IP "size_t textlen" 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hash_get_len.3 b/doc/manpages/gnutls_hash_get_len.3 new file mode 100644 index 0000000000..dc03178da9 --- /dev/null +++ b/doc/manpages/gnutls_hash_get_len.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_get_len" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hash_get_len \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hash_init.3 b/doc/manpages/gnutls_hash_init.3 new file mode 100644 index 0000000000..10e9b172c3 --- /dev/null +++ b/doc/manpages/gnutls_hash_init.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hash_init \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hash_output.3 b/doc/manpages/gnutls_hash_output.3 new file mode 100644 index 0000000000..93e1aa692e --- /dev/null +++ b/doc/manpages/gnutls_hash_output.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hash_output" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hash_output \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "void * digest" 12 +is the output value of the hash +.SH " DESCRIPTION" +This function will output the current hash value. +.SH " SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hex2bin.3 b/doc/manpages/gnutls_hex2bin.3 new file mode 100644 index 0000000000..17229b706d --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hex2bin \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_hex2bin(const char * " hex_data ", size_t " hex_size ", char * " 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 "char * bin_data" 12 +output array with binary data +.IP "size_t * bin_size" 12 +when calling *@bin_size should hold size of \fIbin_data\fP, +on return will hold actual size of \fIbin_data\fP. +.SH " DESCRIPTION" +Convert a buffer with hex data to binary data. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hex_decode.3 b/doc/manpages/gnutls_hex_decode.3 new file mode 100644 index 0000000000..9f5bd45818 --- /dev/null +++ b/doc/manpages/gnutls_hex_decode.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hex_decode" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hex_decode \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_hex_decode(const gnutls_datum_t * " hex_data ", char * " result ", size_t * " result_size ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * hex_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 hex +encoding used by PSK password files. + +Note that hex_data should be null terminated. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hex_encode.3 b/doc/manpages/gnutls_hex_encode.3 new file mode 100644 index 0000000000..c1d3f49a41 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hex_encode \- API function +.SH SYNOPSIS +.B #include +.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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hmac.3 b/doc/manpages/gnutls_hmac.3 new file mode 100644 index 0000000000..4f4bc2ba94 --- /dev/null +++ b/doc/manpages/gnutls_hmac.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hmac \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_hmac(gnutls_hmac_hd_t " handle ", const void * " text ", size_t " textlen ");" +.SH ARGUMENTS +.IP "gnutls_hmac_hd_t handle" 12 +is a \fBgnutls_cipher_hd_t\fP structure. +.IP "const void * text" 12 +the data to hash +.IP "size_t textlen" 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hmac_deinit.3 b/doc/manpages/gnutls_hmac_deinit.3 new file mode 100644 index 0000000000..d52c45331b --- /dev/null +++ b/doc/manpages/gnutls_hmac_deinit.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_deinit \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hmac_fast.3 b/doc/manpages/gnutls_hmac_fast.3 new file mode 100644 index 0000000000..024d84b9bb --- /dev/null +++ b/doc/manpages/gnutls_hmac_fast.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_fast" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_fast \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_hmac_fast(gnutls_mac_algorithm_t " algorithm ", const void * " key ", size_t " keylen ", const void * " text ", size_t " textlen ", 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 * text" 12 +the data to hash +.IP "size_t textlen" 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hmac_get_len.3 b/doc/manpages/gnutls_hmac_get_len.3 new file mode 100644 index 0000000000..9a8156ae26 --- /dev/null +++ b/doc/manpages/gnutls_hmac_get_len.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_get_len" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_get_len \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hmac_init.3 b/doc/manpages/gnutls_hmac_init.3 new file mode 100644 index 0000000000..e18773fcf8 --- /dev/null +++ b/doc/manpages/gnutls_hmac_init.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_hmac_init(gnutls_hmac_hd_t * " dig ", gnutls_digest_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 structure. +.IP "gnutls_digest_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. +.SH " RETURNS" +Zero or a negative error code on error. +.SH " SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_hmac_output.3 b/doc/manpages/gnutls_hmac_output.3 new file mode 100644 index 0000000000..a6f10dcf55 --- /dev/null +++ b/doc/manpages/gnutls_hmac_output.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_hmac_output" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_hmac_output \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "void * digest" 12 +is the output value of the MAC +.SH " DESCRIPTION" +This function will output the current MAC value. +.SH " SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_init.3 b/doc/manpages/gnutls_init.3 new file mode 100644 index 0000000000..c1fc239e9b --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_init \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "unsigned int flags" 12 +indicate if this session is to be used for server or client. +.SH " DESCRIPTION" +This function initializes the current session to null. Every +session must be initialized before use, so internal structures can +be allocated. This function allocates structures which can only +be free'd by calling \fBgnutls_deinit()\fP. Returns \fBGNUTLS_E_SUCCESS\fP (0) on success. + \fIflags\fP can be one of \fBGNUTLS_CLIENT\fP and \fBGNUTLS_SERVER\fP. For a DTLS +entity, the flags \fBGNUTLS_DATAGRAM\fP and \fBGNUTLS_NONBLOCK\fP are +also available. The latter flag will enable a non\-blocking +operation of the DTLS timers. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_key_generate.3 b/doc/manpages/gnutls_key_generate.3 new file mode 100644 index 0000000000..fd5f6ef82c --- /dev/null +++ b/doc/manpages/gnutls_key_generate.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_key_generate" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_key_generate \- API function +.SH SYNOPSIS +.B #include +.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_bytes\fP size. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_kx_get.3 b/doc/manpages/gnutls_kx_get.3 new file mode 100644 index 0000000000..80a07c1d9e --- /dev/null +++ b/doc/manpages/gnutls_kx_get.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_kx_get" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_kx_get \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +Get currently used key exchange algorithm. +.SH " RETURNS" +the key exchange algorithm used in the last handshake, a +\fBgnutls_kx_algorithm_t\fP value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_kx_get_id.3 b/doc/manpages/gnutls_kx_get_id.3 new file mode 100644 index 0000000000..fc906217fd --- /dev/null +++ b/doc/manpages/gnutls_kx_get_id.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_kx_get_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_kx_get_id \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_kx_get_name.3 b/doc/manpages/gnutls_kx_get_name.3 new file mode 100644 index 0000000000..721ea862a3 --- /dev/null +++ b/doc/manpages/gnutls_kx_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_kx_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_kx_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_kx_list.3 b/doc/manpages/gnutls_kx_list.3 new file mode 100644 index 0000000000..a2242fb2a6 --- /dev/null +++ b/doc/manpages/gnutls_kx_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_kx_list" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_kx_list \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_kx_set_priority.3 b/doc/manpages/gnutls_kx_set_priority.3 new file mode 100644 index 0000000000..72b9fe2f70 --- /dev/null +++ b/doc/manpages/gnutls_kx_set_priority.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_kx_set_priority" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_kx_set_priority \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_kx_set_priority(gnutls_session_t " session ", const int * " list ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.IP "const int * list" 12 +is a 0 terminated list of gnutls_kx_algorithm_t elements. +.SH " DESCRIPTION" +Sets the priority on the key exchange algorithms supported by +gnutls. Priority is higher for elements specified before others. +After specifying the algorithms you want, you must append a 0. +Note that the priority is set on the client. The server does not +use the algorithm's priority except for disabling algorithms that +were not specified. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_mac_get.3 b/doc/manpages/gnutls_mac_get.3 new file mode 100644 index 0000000000..e8fe03bd2a --- /dev/null +++ b/doc/manpages/gnutls_mac_get.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_get" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_mac_get \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +Get currently used MAC algorithm. +.SH " RETURNS" +the currently used mac algorithm, a +\fBgnutls_mac_algorithm_t\fP value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_mac_get_id.3 b/doc/manpages/gnutls_mac_get_id.3 new file mode 100644 index 0000000000..c1beb95fca --- /dev/null +++ b/doc/manpages/gnutls_mac_get_id.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_get_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_mac_get_id \- API function +.SH SYNOPSIS +.B #include +.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 failures. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..f412175b1a --- /dev/null +++ b/doc/manpages/gnutls_mac_get_key_size.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_get_key_size" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_mac_get_key_size \- API function +.SH SYNOPSIS +.B #include +.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" +Get size of MAC key. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_mac_get_name.3 b/doc/manpages/gnutls_mac_get_name.3 new file mode 100644 index 0000000000..89a539269a --- /dev/null +++ b/doc/manpages/gnutls_mac_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_mac_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_mac_list.3 b/doc/manpages/gnutls_mac_list.3 new file mode 100644 index 0000000000..5ee733953c --- /dev/null +++ b/doc/manpages/gnutls_mac_list.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_list" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_mac_list \- API function +.SH SYNOPSIS +.B #include +.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. For +example, MD2 is not supported as a cipher suite, but is supported +for other purposes (e.g., X.509 signature verification or similar). + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_mac_set_priority.3 b/doc/manpages/gnutls_mac_set_priority.3 new file mode 100644 index 0000000000..b236668ab9 --- /dev/null +++ b/doc/manpages/gnutls_mac_set_priority.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_mac_set_priority" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_mac_set_priority \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_mac_set_priority(gnutls_session_t " session ", const int * " list ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.IP "const int * list" 12 +is a 0 terminated list of gnutls_mac_algorithm_t elements. +.SH " DESCRIPTION" +Sets the priority on the mac algorithms supported by gnutls. +Priority is higher for elements specified before others. After +specifying the algorithms you want, you must append a 0. Note +that the priority is set on the client. The server does not use +the algorithm's priority except for disabling algorithms that were +not specified. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_check_hostname.3 b/doc/manpages/gnutls_openpgp_crt_check_hostname.3 new file mode 100644 index 0000000000..265bfec25d --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_check_hostname.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_check_hostname" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_check_hostname \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_check_hostname(gnutls_openpgp_crt_t " key ", const char * " hostname ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +should contain a \fBgnutls_openpgp_crt_t\fP structure +.IP "const char * hostname" 12 +A null terminated string that contains a DNS name +.SH " DESCRIPTION" +This function will check if the given key's owner matches the +given hostname. This is a basic implementation of the matching +described in RFC2818 (HTTPS), which takes into account wildcards. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_deinit.3 b/doc/manpages/gnutls_openpgp_crt_deinit.3 new file mode 100644 index 0000000000..9742829b7e --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_openpgp_crt_deinit(gnutls_openpgp_crt_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a key structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_export.3 b/doc/manpages/gnutls_openpgp_crt_export.3 new file mode 100644 index 0000000000..a041a53a63 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_export.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_export \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_export(gnutls_openpgp_crt_t " key ", gnutls_openpgp_crt_fmt_t " format ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +Holds the key. +.IP "gnutls_openpgp_crt_fmt_t format" 12 +One of gnutls_openpgp_crt_fmt_t elements. +.IP "void * output_data" 12 +will contain the key base64 encoded or raw +.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 convert the given key to RAW or Base64 format. +If the buffer provided is not long enough to hold the output, then +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will be returned. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_auth_subkey.3 b/doc/manpages/gnutls_openpgp_crt_get_auth_subkey.3 new file mode 100644 index 0000000000..05845fe391 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_auth_subkey.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_auth_subkey" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_auth_subkey \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_auth_subkey(gnutls_openpgp_crt_t " crt ", gnutls_openpgp_keyid_t " keyid ", unsigned int " flag ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t crt" 12 +the structure that contains the OpenPGP public key. +.IP "gnutls_openpgp_keyid_t keyid" 12 +the struct to save the keyid. +.IP "unsigned int flag" 12 +Non (0) indicates that a valid subkey is always returned. +.SH " DESCRIPTION" +Returns the 64\-bit keyID of the first valid OpenPGP subkey marked +for authentication. If flag is non (0) and no authentication +subkey exists, then a valid subkey will be returned even if it is +not marked for authentication. +Returns the 64\-bit keyID of the first valid OpenPGP subkey marked +for authentication. If flag is non (0) and no authentication +subkey exists, then a valid subkey will be returned even if it is +not marked for authentication. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_creation_time.3 b/doc/manpages/gnutls_openpgp_crt_get_creation_time.3 new file mode 100644 index 0000000000..50c590ab2c --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_creation_time.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_creation_time" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_creation_time \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "time_t gnutls_openpgp_crt_get_creation_time(gnutls_openpgp_crt_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.SH " DESCRIPTION" +Get key creation time. +.SH " RETURNS" +the timestamp when the OpenPGP key was created. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_expiration_time.3 b/doc/manpages/gnutls_openpgp_crt_get_expiration_time.3 new file mode 100644 index 0000000000..a782264e35 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_expiration_time.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_expiration_time" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_expiration_time \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "time_t gnutls_openpgp_crt_get_expiration_time(gnutls_openpgp_crt_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.SH " DESCRIPTION" +Get key expiration time. A value of '0' means that the key doesn't +expire at all. +.SH " RETURNS" +the time when the OpenPGP key expires. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_fingerprint.3 b/doc/manpages/gnutls_openpgp_crt_get_fingerprint.3 new file mode 100644 index 0000000000..99f29beef8 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_fingerprint.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_fingerprint" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_fingerprint \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_fingerprint(gnutls_openpgp_crt_t " key ", void * " fpr ", size_t * " fprlen ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the raw data that contains the OpenPGP public key. +.IP "void * fpr" 12 +the buffer to save the fingerprint, must hold at least 20 bytes. +.IP "size_t * fprlen" 12 +the integer to save the length of the fingerprint. +.SH " DESCRIPTION" +Get key fingerprint. Depending on the algorithm, the fingerprint +can be 16 or 20 bytes. +.SH " RETURNS" +On success, 0 is returned. Otherwise, an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_key_id.3 b/doc/manpages/gnutls_openpgp_crt_get_key_id.3 new file mode 100644 index 0000000000..da4e18e944 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_key_id.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_key_id(gnutls_openpgp_crt_t " key ", gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.IP "gnutls_openpgp_keyid_t keyid" 12 +the buffer to save the keyid. +.SH " DESCRIPTION" +Get key id string. +.SH " RETURNS" +the 64\-bit keyID of the OpenPGP key. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_key_usage.3 b/doc/manpages/gnutls_openpgp_crt_get_key_usage.3 new file mode 100644 index 0000000000..91e0d44519 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_key_usage.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_key_usage" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_key_usage \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_key_usage(gnutls_openpgp_crt_t " key ", unsigned int * " key_usage ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +should contain a gnutls_openpgp_crt_t structure +.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 checking the +key algorithm. The key usage value will ORed values of the: +\fBGNUTLS_KEY_DIGITAL_SIGNATURE\fP, \fBGNUTLS_KEY_KEY_ENCIPHERMENT\fP. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_name.3 b/doc/manpages/gnutls_openpgp_crt_get_name.3 new file mode 100644 index 0000000000..ca7fe5b5dc --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_name.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_name \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_name(gnutls_openpgp_crt_t " key ", int " idx ", char * " buf ", size_t * " sizeof_buf ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.IP "int idx" 12 +the index of the ID to extract +.IP "char * buf" 12 +a pointer to a structure to hold the name, may be \fBNULL\fP +to only get the \fIsizeof_buf\fP. +.IP "size_t * sizeof_buf" 12 +holds the maximum size of \fIbuf\fP, on return hold the +actual/required size of \fIbuf\fP. +.SH " DESCRIPTION" +Extracts the userID from the parsed OpenPGP key. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, and if the index of the ID +does not exist \fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP, or an +error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_pk_algorithm.3 b/doc/manpages/gnutls_openpgp_crt_get_pk_algorithm.3 new file mode 100644 index 0000000000..65c2872cad --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_pk_algorithm.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_pk_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "gnutls_pk_algorithm_t gnutls_openpgp_crt_get_pk_algorithm(gnutls_openpgp_crt_t " key ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +is an OpenPGP key +.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 OpenPGP +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. +.SH " RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or GNUTLS_PK_UNKNOWN on error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_pk_dsa_raw.3 b/doc/manpages/gnutls_openpgp_crt_get_pk_dsa_raw.3 new file mode 100644 index 0000000000..32d1170a69 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_pk_dsa_raw.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_pk_dsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_pk_dsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_pk_dsa_raw(gnutls_openpgp_crt_t " crt ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_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 " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_pk_rsa_raw.3 b/doc/manpages/gnutls_openpgp_crt_get_pk_rsa_raw.3 new file mode 100644 index 0000000000..6126122b5f --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_pk_rsa_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_pk_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_pk_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_pk_rsa_raw(gnutls_openpgp_crt_t " crt ", gnutls_datum_t * " m ", gnutls_datum_t * " e ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_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 " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_preferred_key_id.3 b/doc/manpages/gnutls_openpgp_crt_get_preferred_key_id.3 new file mode 100644 index 0000000000..c57b9326ca --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_preferred_key_id.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_preferred_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_preferred_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_preferred_key_id(gnutls_openpgp_crt_t " key ", gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.IP "gnutls_openpgp_keyid_t keyid" 12 +the struct to save the keyid. +.SH " DESCRIPTION" +Get preferred key id. If it hasn't been set it returns +\fBGNUTLS_E_INVALID_REQUEST\fP. +.SH " RETURNS" +the 64\-bit preferred keyID of the OpenPGP key. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_revoked_status.3 b/doc/manpages/gnutls_openpgp_crt_get_revoked_status.3 new file mode 100644 index 0000000000..9b53963acf --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_revoked_status.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_revoked_status" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_revoked_status \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_revoked_status(gnutls_openpgp_crt_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.SH " DESCRIPTION" +Get revocation status of key. +.SH " RETURNS" +true (1) if the key has been revoked, or false (0) if it +has not. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_count.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_count.3 new file mode 100644 index 0000000000..44839a065e --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_count.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_count" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_count \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_subkey_count(gnutls_openpgp_crt_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +is an OpenPGP key +.SH " DESCRIPTION" +This function will return the number of subkeys present in the +given OpenPGP certificate. +.SH " RETURNS" +the number of subkeys, or a negative error code on error. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_creation_time.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_creation_time.3 new file mode 100644 index 0000000000..87d8ff7540 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_creation_time.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_creation_time" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_creation_time \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "time_t gnutls_openpgp_crt_get_subkey_creation_time(gnutls_openpgp_crt_t " key ", unsigned int " idx ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.IP "unsigned int idx" 12 +the subkey index +.SH " DESCRIPTION" +Get subkey creation time. +.SH " RETURNS" +the timestamp when the OpenPGP sub\-key was created. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_expiration_time.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_expiration_time.3 new file mode 100644 index 0000000000..b08ea4a292 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_expiration_time.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_expiration_time" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_expiration_time \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "time_t gnutls_openpgp_crt_get_subkey_expiration_time(gnutls_openpgp_crt_t " key ", unsigned int " idx ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.IP "unsigned int idx" 12 +the subkey index +.SH " DESCRIPTION" +Get subkey expiration time. A value of '0' means that the key +doesn't expire at all. +.SH " RETURNS" +the time when the OpenPGP key expires. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_fingerprint.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_fingerprint.3 new file mode 100644 index 0000000000..e7d243bbf8 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_fingerprint.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_fingerprint" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_fingerprint \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_subkey_fingerprint(gnutls_openpgp_crt_t " key ", unsigned int " idx ", void * " fpr ", size_t * " fprlen ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the raw data that contains the OpenPGP public key. +.IP "unsigned int idx" 12 +the subkey index +.IP "void * fpr" 12 +the buffer to save the fingerprint, must hold at least 20 bytes. +.IP "size_t * fprlen" 12 +the integer to save the length of the fingerprint. +.SH " DESCRIPTION" +Get key fingerprint of a subkey. Depending on the algorithm, the +fingerprint can be 16 or 20 bytes. +.SH " RETURNS" +On success, 0 is returned. Otherwise, an error code. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_id.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_id.3 new file mode 100644 index 0000000000..47420640b4 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_id.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_subkey_id(gnutls_openpgp_crt_t " key ", unsigned int " idx ", gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.IP "unsigned int idx" 12 +the subkey index +.IP "gnutls_openpgp_keyid_t keyid" 12 +the buffer to save the keyid. +.SH " DESCRIPTION" +Get the subkey's key\-id. +.SH " RETURNS" +the 64\-bit keyID of the OpenPGP key. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_idx.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_idx.3 new file mode 100644 index 0000000000..f1483f8d43 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_idx.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_idx" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_idx \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_subkey_idx(gnutls_openpgp_crt_t " key ", const gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.IP "const gnutls_openpgp_keyid_t keyid" 12 +the keyid. +.SH " DESCRIPTION" +Get subkey's index. +.SH " RETURNS" +the index of the subkey or a negative error value. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_pk_algorithm.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_pk_algorithm.3 new file mode 100644 index 0000000000..b4ef42d40a --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_pk_algorithm.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_pk_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "gnutls_pk_algorithm_t gnutls_openpgp_crt_get_subkey_pk_algorithm(gnutls_openpgp_crt_t " key ", unsigned int " idx ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +is an OpenPGP key +.IP "unsigned int idx" 12 +is the subkey index +.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 subkey of an OpenPGP +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. +.SH " RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or GNUTLS_PK_UNKNOWN on error. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_pk_dsa_raw.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_pk_dsa_raw.3 new file mode 100644 index 0000000000..f4551ab5c9 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_pk_dsa_raw.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_pk_dsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_pk_dsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_subkey_pk_dsa_raw(gnutls_openpgp_crt_t " crt ", unsigned int " idx ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t crt" 12 +Holds the certificate +.IP "unsigned int idx" 12 +Is the subkey index +.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 " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_pk_rsa_raw.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_pk_rsa_raw.3 new file mode 100644 index 0000000000..23a3d166f3 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_pk_rsa_raw.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_pk_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_pk_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_subkey_pk_rsa_raw(gnutls_openpgp_crt_t " crt ", unsigned int " idx ", gnutls_datum_t * " m ", gnutls_datum_t * " e ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t crt" 12 +Holds the certificate +.IP "unsigned int idx" 12 +Is the subkey index +.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 " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_revoked_status.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_revoked_status.3 new file mode 100644 index 0000000000..ecc2628ef0 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_revoked_status.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_revoked_status" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_revoked_status \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_subkey_revoked_status(gnutls_openpgp_crt_t " key ", unsigned int " idx ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.IP "unsigned int idx" 12 +is the subkey index +.SH " DESCRIPTION" +Get subkey revocation status. A negative error code indicates an error. +.SH " RETURNS" +true (1) if the key has been revoked, or false (0) if it +has not. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_subkey_usage.3 b/doc/manpages/gnutls_openpgp_crt_get_subkey_usage.3 new file mode 100644 index 0000000000..c4691ae66c --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_subkey_usage.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_subkey_usage" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_subkey_usage \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_subkey_usage(gnutls_openpgp_crt_t " key ", unsigned int " idx ", unsigned int * " key_usage ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +should contain a gnutls_openpgp_crt_t structure +.IP "unsigned int idx" 12 +the subkey index +.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 checking the +key algorithm. The key usage value will ORed values of +\fBGNUTLS_KEY_DIGITAL_SIGNATURE\fP or \fBGNUTLS_KEY_KEY_ENCIPHERMENT\fP. + +A negative error code may be returned in case of parsing error. +.SH " RETURNS" +key usage value. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_get_version.3 b/doc/manpages/gnutls_openpgp_crt_get_version.3 new file mode 100644 index 0000000000..0e997569b7 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_get_version.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_get_version" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_get_version \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_get_version(gnutls_openpgp_crt_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.SH " DESCRIPTION" +Extract the version of the OpenPGP key. +.SH " RETURNS" +the version number is returned, or a negative error code on errors. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_import.3 b/doc/manpages/gnutls_openpgp_crt_import.3 new file mode 100644 index 0000000000..2b500d4869 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_import.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_import \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_import(gnutls_openpgp_crt_t " key ", const gnutls_datum_t * " data ", gnutls_openpgp_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +The structure to store the parsed key. +.IP "const gnutls_datum_t * data" 12 +The RAW or BASE64 encoded key. +.IP "gnutls_openpgp_crt_fmt_t format" 12 +One of gnutls_openpgp_crt_fmt_t elements. +.SH " DESCRIPTION" +This function will convert the given RAW or Base64 encoded key to +the native \fBgnutls_openpgp_crt_t\fP format. The output will be stored +in 'key'. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_init.3 b/doc/manpages/gnutls_openpgp_crt_init.3 new file mode 100644 index 0000000000..1b72dafb00 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_init(gnutls_openpgp_crt_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t * key" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will initialize an OpenPGP key structure. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_print.3 b/doc/manpages/gnutls_openpgp_crt_print.3 new file mode 100644 index 0000000000..4929d3fc3d --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_print.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_print" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_print \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_print(gnutls_openpgp_crt_t " cert ", gnutls_certificate_print_formats_t " format ", gnutls_datum_t * " out ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t cert" 12 +The structure 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 (0) terminated string. +.SH " DESCRIPTION" +This function will pretty print an OpenPGP certificate, suitable +for display to a human. + +The format should be (0) for future compatibility. + +The output \fIout\fP needs to be deallocate using \fBgnutls_free()\fP. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_set_preferred_key_id.3 b/doc/manpages/gnutls_openpgp_crt_set_preferred_key_id.3 new file mode 100644 index 0000000000..2940577da5 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_set_preferred_key_id.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_set_preferred_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_set_preferred_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_set_preferred_key_id(gnutls_openpgp_crt_t " key ", const gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that contains the OpenPGP public key. +.IP "const gnutls_openpgp_keyid_t keyid" 12 +the selected keyid +.SH " DESCRIPTION" +This allows setting a preferred key id for the given certificate. +This key will be used by functions that involve key handling. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_verify_ring.3 b/doc/manpages/gnutls_openpgp_crt_verify_ring.3 new file mode 100644 index 0000000000..ecc077c3e3 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_verify_ring.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_verify_ring" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_verify_ring \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_verify_ring(gnutls_openpgp_crt_t " key ", gnutls_openpgp_keyring_t " keyring ", unsigned int " flags ", unsigned int * " verify ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that holds the key. +.IP "gnutls_openpgp_keyring_t keyring" 12 +holds the keyring to check against +.IP "unsigned int flags" 12 +unused (should be 0) +.IP "unsigned int * verify" 12 +will hold the certificate verification output. +.SH " DESCRIPTION" +Verify all signatures in the key, using the given set of keys +(keyring). + +The key verification output will be put in \fIverify\fP and will be one +or more of the \fBgnutls_certificate_status_t\fP enumerated elements +bitwise or'd. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_crt_verify_self.3 b/doc/manpages/gnutls_openpgp_crt_verify_self.3 new file mode 100644 index 0000000000..9a85a0a2c9 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_crt_verify_self.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_crt_verify_self" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_crt_verify_self \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_crt_verify_self(gnutls_openpgp_crt_t " key ", unsigned int " flags ", unsigned int * " verify ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_crt_t key" 12 +the structure that holds the key. +.IP "unsigned int flags" 12 +unused (should be 0) +.IP "unsigned int * verify" 12 +will hold the key verification output. +.SH " DESCRIPTION" +Verifies the self signature in the key. The key 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. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_keyring_check_id.3 b/doc/manpages/gnutls_openpgp_keyring_check_id.3 new file mode 100644 index 0000000000..a882e5697f --- /dev/null +++ b/doc/manpages/gnutls_openpgp_keyring_check_id.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_keyring_check_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_keyring_check_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_keyring_check_id(gnutls_openpgp_keyring_t " ring ", const gnutls_openpgp_keyid_t " keyid ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_keyring_t ring" 12 +holds the keyring to check against +.IP "const gnutls_openpgp_keyid_t keyid" 12 +will hold the keyid to check for. +.IP "unsigned int flags" 12 +unused (should be 0) +.SH " DESCRIPTION" +Check if a given key ID exists in the keyring. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success (if keyid exists) and a +negative error code on failure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_keyring_deinit.3 b/doc/manpages/gnutls_openpgp_keyring_deinit.3 new file mode 100644 index 0000000000..87bbe37f72 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_keyring_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_keyring_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_keyring_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_openpgp_keyring_deinit(gnutls_openpgp_keyring_t " keyring ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_keyring_t keyring" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a keyring structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_keyring_get_crt.3 b/doc/manpages/gnutls_openpgp_keyring_get_crt.3 new file mode 100644 index 0000000000..e3f8d201d1 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_keyring_get_crt.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_keyring_get_crt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_keyring_get_crt \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_keyring_get_crt(gnutls_openpgp_keyring_t " ring ", unsigned int " idx ", gnutls_openpgp_crt_t * " cert ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_keyring_t ring" 12 +Holds the keyring. +.IP "unsigned int idx" 12 +the index of the certificate to export +.IP "gnutls_openpgp_crt_t * cert" 12 +An uninitialized \fBgnutls_openpgp_crt_t\fP structure +.SH " DESCRIPTION" +This function will extract an OpenPGP certificate from the given +keyring. If the index given is out of range +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. The +returned structure needs to be deinited. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_keyring_get_crt_count.3 b/doc/manpages/gnutls_openpgp_keyring_get_crt_count.3 new file mode 100644 index 0000000000..ee09d3cd2e --- /dev/null +++ b/doc/manpages/gnutls_openpgp_keyring_get_crt_count.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_keyring_get_crt_count" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_keyring_get_crt_count \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_keyring_get_crt_count(gnutls_openpgp_keyring_t " ring ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_keyring_t ring" 12 +is an OpenPGP key ring +.SH " DESCRIPTION" +This function will return the number of OpenPGP certificates +present in the given keyring. +.SH " RETURNS" +the number of subkeys, or a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_keyring_import.3 b/doc/manpages/gnutls_openpgp_keyring_import.3 new file mode 100644 index 0000000000..bb3e1793c7 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_keyring_import.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_keyring_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_keyring_import \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_keyring_import(gnutls_openpgp_keyring_t " keyring ", const gnutls_datum_t * " data ", gnutls_openpgp_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_keyring_t keyring" 12 +The structure to store the parsed key. +.IP "const gnutls_datum_t * data" 12 +The RAW or BASE64 encoded keyring. +.IP "gnutls_openpgp_crt_fmt_t format" 12 +One of \fBgnutls_openpgp_keyring_fmt\fP elements. +.SH " DESCRIPTION" +This function will convert the given RAW or Base64 encoded keyring +to the native \fBgnutls_openpgp_keyring_t\fP format. The output will be +stored in 'keyring'. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_keyring_init.3 b/doc/manpages/gnutls_openpgp_keyring_init.3 new file mode 100644 index 0000000000..5dab5fb0ce --- /dev/null +++ b/doc/manpages/gnutls_openpgp_keyring_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_keyring_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_keyring_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_keyring_init(gnutls_openpgp_keyring_t * " keyring ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_keyring_t * keyring" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will initialize an keyring structure. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_deinit.3 b/doc/manpages/gnutls_openpgp_privkey_deinit.3 new file mode 100644 index 0000000000..e0c2da109c --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_openpgp_privkey_deinit(gnutls_openpgp_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a key structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_export.3 b/doc/manpages/gnutls_openpgp_privkey_export.3 new file mode 100644 index 0000000000..fce2179585 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_export.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_export \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_export(gnutls_openpgp_privkey_t " key ", gnutls_openpgp_crt_fmt_t " format ", const char * " password ", unsigned int " flags ", void * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +Holds the key. +.IP "gnutls_openpgp_crt_fmt_t format" 12 +One of gnutls_openpgp_crt_fmt_t elements. +.IP "const char * password" 12 +the password that will be used to encrypt the key. (unused for now) +.IP "unsigned int flags" 12 +(0) for future compatibility +.IP "void * output_data" 12 +will contain the key base64 encoded or raw +.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 convert the given key to RAW or Base64 format. +If the buffer provided is not long enough to hold the output, then +GNUTLS_E_SHORT_MEMORY_BUFFER will be returned. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_export_dsa_raw.3 b/doc/manpages/gnutls_openpgp_privkey_export_dsa_raw.3 new file mode 100644 index 0000000000..fafd3cd6b1 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_export_dsa_raw.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_export_dsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_export_dsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_export_dsa_raw(gnutls_openpgp_privkey_t " pkey ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ", gnutls_datum_t * " x ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t pkey" 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 +.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 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" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_export_rsa_raw.3 b/doc/manpages/gnutls_openpgp_privkey_export_rsa_raw.3 new file mode 100644 index 0000000000..d22c6f03f6 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_export_rsa_raw.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_export_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_export_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_export_rsa_raw(gnutls_openpgp_privkey_t " pkey ", 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_openpgp_privkey_t pkey" 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 +.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" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_export_subkey_dsa_raw.3 b/doc/manpages/gnutls_openpgp_privkey_export_subkey_dsa_raw.3 new file mode 100644 index 0000000000..3d6496a84a --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_export_subkey_dsa_raw.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_export_subkey_dsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_export_subkey_dsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_export_subkey_dsa_raw(gnutls_openpgp_privkey_t " pkey ", unsigned int " idx ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " g ", gnutls_datum_t * " y ", gnutls_datum_t * " x ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t pkey" 12 +Holds the certificate +.IP "unsigned int idx" 12 +Is the subkey index +.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 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" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_export_subkey_rsa_raw.3 b/doc/manpages/gnutls_openpgp_privkey_export_subkey_rsa_raw.3 new file mode 100644 index 0000000000..0db98c8b74 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_export_subkey_rsa_raw.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_export_subkey_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_export_subkey_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_export_subkey_rsa_raw(gnutls_openpgp_privkey_t " pkey ", unsigned int " idx ", 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_openpgp_privkey_t pkey" 12 +Holds the certificate +.IP "unsigned int idx" 12 +Is the subkey index +.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" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_fingerprint.3 b/doc/manpages/gnutls_openpgp_privkey_get_fingerprint.3 new file mode 100644 index 0000000000..f9dafa1dde --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_fingerprint.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_fingerprint" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_fingerprint \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_get_fingerprint(gnutls_openpgp_privkey_t " key ", void * " fpr ", size_t * " fprlen ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the raw data that contains the OpenPGP secret key. +.IP "void * fpr" 12 +the buffer to save the fingerprint, must hold at least 20 bytes. +.IP "size_t * fprlen" 12 +the integer to save the length of the fingerprint. +.SH " DESCRIPTION" +Get the fingerprint of the OpenPGP key. Depends on the +algorithm, the fingerprint can be 16 or 20 bytes. +.SH " RETURNS" +On success, 0 is returned, or an error code. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_key_id.3 b/doc/manpages/gnutls_openpgp_privkey_get_key_id.3 new file mode 100644 index 0000000000..a074c245b9 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_key_id.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_get_key_id(gnutls_openpgp_privkey_t " key ", gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the structure that contains the OpenPGP secret key. +.IP "gnutls_openpgp_keyid_t keyid" 12 +the buffer to save the keyid. +.SH " DESCRIPTION" +Get key\-id. +.SH " RETURNS" +the 64\-bit keyID of the OpenPGP key. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_pk_algorithm.3 b/doc/manpages/gnutls_openpgp_privkey_get_pk_algorithm.3 new file mode 100644 index 0000000000..e6c526331c --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_pk_algorithm.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_pk_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "gnutls_pk_algorithm_t gnutls_openpgp_privkey_get_pk_algorithm(gnutls_openpgp_privkey_t " key ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +is an OpenPGP key +.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 OpenPGP +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. +.SH " RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or a negative error code on error. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_preferred_key_id.3 b/doc/manpages/gnutls_openpgp_privkey_get_preferred_key_id.3 new file mode 100644 index 0000000000..ff0faf8d18 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_preferred_key_id.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_preferred_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_preferred_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_get_preferred_key_id(gnutls_openpgp_privkey_t " key ", gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the structure that contains the OpenPGP public key. +.IP "gnutls_openpgp_keyid_t keyid" 12 +the struct to save the keyid. +.SH " DESCRIPTION" +Get the preferred key\-id for the key. +.SH " RETURNS" +the 64\-bit preferred keyID of the OpenPGP key, or if it +hasn't been set it returns \fBGNUTLS_E_INVALID_REQUEST\fP. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_revoked_status.3 b/doc/manpages/gnutls_openpgp_privkey_get_revoked_status.3 new file mode 100644 index 0000000000..a8a057b432 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_revoked_status.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_revoked_status" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_revoked_status \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_get_revoked_status(gnutls_openpgp_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the structure that contains the OpenPGP private key. +.SH " DESCRIPTION" +Get revocation status of key. +.SH " RETURNS" +true (1) if the key has been revoked, or false (0) if it +has not, or a negative error code indicates an error. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_subkey_count.3 b/doc/manpages/gnutls_openpgp_privkey_get_subkey_count.3 new file mode 100644 index 0000000000..e6cf6fe370 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_subkey_count.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_subkey_count" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_subkey_count \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_get_subkey_count(gnutls_openpgp_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +is an OpenPGP key +.SH " DESCRIPTION" +This function will return the number of subkeys present in the +given OpenPGP certificate. +.SH " RETURNS" +the number of subkeys, or a negative error code on error. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_subkey_creation_time.3 b/doc/manpages/gnutls_openpgp_privkey_get_subkey_creation_time.3 new file mode 100644 index 0000000000..6fa772a3a7 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_subkey_creation_time.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_subkey_creation_time" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_subkey_creation_time \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "time_t gnutls_openpgp_privkey_get_subkey_creation_time(gnutls_openpgp_privkey_t " key ", unsigned int " idx ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the structure that contains the OpenPGP private key. +.IP "unsigned int idx" 12 +the subkey index +.SH " DESCRIPTION" +Get subkey creation time. +.SH " RETURNS" +the timestamp when the OpenPGP key was created. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_subkey_fingerprint.3 b/doc/manpages/gnutls_openpgp_privkey_get_subkey_fingerprint.3 new file mode 100644 index 0000000000..9430b0ff47 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_subkey_fingerprint.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_subkey_fingerprint" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_subkey_fingerprint \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_get_subkey_fingerprint(gnutls_openpgp_privkey_t " key ", unsigned int " idx ", void * " fpr ", size_t * " fprlen ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the raw data that contains the OpenPGP secret key. +.IP "unsigned int idx" 12 +the subkey index +.IP "void * fpr" 12 +the buffer to save the fingerprint, must hold at least 20 bytes. +.IP "size_t * fprlen" 12 +the integer to save the length of the fingerprint. +.SH " DESCRIPTION" +Get the fingerprint of an OpenPGP subkey. Depends on the +algorithm, the fingerprint can be 16 or 20 bytes. +.SH " RETURNS" +On success, 0 is returned, or an error code. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_subkey_id.3 b/doc/manpages/gnutls_openpgp_privkey_get_subkey_id.3 new file mode 100644 index 0000000000..d9c990cd01 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_subkey_id.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_subkey_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_subkey_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_get_subkey_id(gnutls_openpgp_privkey_t " key ", unsigned int " idx ", gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the structure that contains the OpenPGP secret key. +.IP "unsigned int idx" 12 +the subkey index +.IP "gnutls_openpgp_keyid_t keyid" 12 +the buffer to save the keyid. +.SH " DESCRIPTION" +Get the key\-id for the subkey. +.SH " RETURNS" +the 64\-bit keyID of the OpenPGP key. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_subkey_idx.3 b/doc/manpages/gnutls_openpgp_privkey_get_subkey_idx.3 new file mode 100644 index 0000000000..57c5489f20 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_subkey_idx.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_subkey_idx" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_subkey_idx \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_get_subkey_idx(gnutls_openpgp_privkey_t " key ", const gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the structure that contains the OpenPGP private key. +.IP "const gnutls_openpgp_keyid_t keyid" 12 +the keyid. +.SH " DESCRIPTION" +Get index of subkey. +.SH " RETURNS" +the index of the subkey or a negative error value. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_subkey_pk_algorithm.3 b/doc/manpages/gnutls_openpgp_privkey_get_subkey_pk_algorithm.3 new file mode 100644 index 0000000000..0aa1e8da5d --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_subkey_pk_algorithm.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_subkey_pk_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_subkey_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "gnutls_pk_algorithm_t gnutls_openpgp_privkey_get_subkey_pk_algorithm(gnutls_openpgp_privkey_t " key ", unsigned int " idx ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +is an OpenPGP key +.IP "unsigned int idx" 12 +is the subkey index +.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 subkey of an OpenPGP +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. +.SH " RETURNS" +a member of the \fBgnutls_pk_algorithm_t\fP enumeration on +success, or a negative error code on error. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_get_subkey_revoked_status.3 b/doc/manpages/gnutls_openpgp_privkey_get_subkey_revoked_status.3 new file mode 100644 index 0000000000..f2c478f41e --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_get_subkey_revoked_status.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_get_subkey_revoked_status" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_get_subkey_revoked_status \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_get_subkey_revoked_status(gnutls_openpgp_privkey_t " key ", unsigned int " idx ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the structure that contains the OpenPGP private key. +.IP "unsigned int idx" 12 +is the subkey index +.SH " DESCRIPTION" +Get revocation status of key. +.SH " RETURNS" +true (1) if the key has been revoked, or false (0) if it +has not, or a negative error code indicates an error. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_import.3 b/doc/manpages/gnutls_openpgp_privkey_import.3 new file mode 100644 index 0000000000..b4e4f2a9a9 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_import.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_import \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_import(gnutls_openpgp_privkey_t " key ", const gnutls_datum_t * " data ", gnutls_openpgp_crt_fmt_t " format ", const char * " password ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +The structure to store the parsed key. +.IP "const gnutls_datum_t * data" 12 +The RAW or BASE64 encoded key. +.IP "gnutls_openpgp_crt_fmt_t format" 12 +One of \fBgnutls_openpgp_crt_fmt_t\fP elements. +.IP "const char * password" 12 +not used for now +.IP "unsigned int flags" 12 +should be (0) +.SH " DESCRIPTION" +This function will convert the given RAW or Base64 encoded key to +the native gnutls_openpgp_privkey_t format. The output will be +stored in 'key'. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_init.3 b/doc/manpages/gnutls_openpgp_privkey_init.3 new file mode 100644 index 0000000000..14bbcaee8a --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_init(gnutls_openpgp_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t * key" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will initialize an OpenPGP key structure. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_sec_param.3 b/doc/manpages/gnutls_openpgp_privkey_sec_param.3 new file mode 100644 index 0000000000..ca21f3216d --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_sec_param.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_sec_param" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_sec_param \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "gnutls_sec_param_t gnutls_openpgp_privkey_sec_param(gnutls_openpgp_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +a key structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_privkey_set_preferred_key_id.3 b/doc/manpages/gnutls_openpgp_privkey_set_preferred_key_id.3 new file mode 100644 index 0000000000..6001a4b1e5 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_set_preferred_key_id.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_set_preferred_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_set_preferred_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_openpgp_privkey_set_preferred_key_id(gnutls_openpgp_privkey_t " key ", const gnutls_openpgp_keyid_t " keyid ");" +.SH ARGUMENTS +.IP "gnutls_openpgp_privkey_t key" 12 +the structure that contains the OpenPGP public key. +.IP "const gnutls_openpgp_keyid_t keyid" 12 +the selected keyid +.SH " DESCRIPTION" +This allows setting a preferred key id for the given certificate. +This key will be used by functions that involve key handling. +.SH " RETURNS" +On success, 0 is returned, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5ec2745ee1 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_privkey_sign_hash.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_privkey_sign_hash" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_privkey_sign_hash \- API function +.SH SYNOPSIS +.B #include +.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 will sign the given hash using the private key. You +should use \fBgnutls_openpgp_privkey_set_preferred_key_id()\fP before +calling this function to set the subkey to use. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH " DEPRECATED" +Use \fBgnutls_privkey_sign_hash()\fP instead. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_send_cert.3 b/doc/manpages/gnutls_openpgp_send_cert.3 new file mode 100644 index 0000000000..156d745ad5 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_send_cert.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_send_cert" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_send_cert \- API function +.SH SYNOPSIS +.B #include +.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 pointer to a \fBgnutls_session_t\fP structure. +.IP "gnutls_openpgp_crt_status_t status" 12 +is one of GNUTLS_OPENPGP_CERT, or GNUTLS_OPENPGP_CERT_FINGERPRINT +.SH " DESCRIPTION" +This function will order gnutls to send the key fingerprint +instead of the key in the initial handshake procedure. This should +be used with care and only when there is indication or knowledge +that the server can obtain the client's key. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_openpgp_set_recv_key_function.3 b/doc/manpages/gnutls_openpgp_set_recv_key_function.3 new file mode 100644 index 0000000000..7c10d9aa93 --- /dev/null +++ b/doc/manpages/gnutls_openpgp_set_recv_key_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_openpgp_set_recv_key_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_openpgp_set_recv_key_function \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_openpgp_set_recv_key_function(gnutls_session_t " session ", gnutls_openpgp_recv_key_func " func ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +a TLS session +.IP "gnutls_openpgp_recv_key_func func" 12 +the callback +.SH " DESCRIPTION" +This funtion will set a key retrieval function for OpenPGP keys. This +callback is only useful in server side, and will be used if the peer +sent a key fingerprint instead of a full key. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pcert_deinit.3 b/doc/manpages/gnutls_pcert_deinit.3 new file mode 100644 index 0000000000..280d397894 --- /dev/null +++ b/doc/manpages/gnutls_pcert_deinit.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_deinit \- API function +.SH SYNOPSIS +.B #include +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pcert_import_openpgp.3 b/doc/manpages/gnutls_pcert_import_openpgp.3 new file mode 100644 index 0000000000..3642387ebf --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_openpgp.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_openpgp" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_openpgp \- API function +.SH SYNOPSIS +.B #include +.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 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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..23dd9185a3 --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_openpgp_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_openpgp_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_openpgp_raw \- API function +.SH SYNOPSIS +.B #include +.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 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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pcert_import_x509.3 b/doc/manpages/gnutls_pcert_import_x509.3 new file mode 100644 index 0000000000..4558566e85 --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_x509.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_x509" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_x509 \- API function +.SH SYNOPSIS +.B #include +.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 raw 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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..64486dcd9a --- /dev/null +++ b/doc/manpages/gnutls_pcert_import_x509_raw.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pcert_import_x509_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_import_x509_raw \- API function +.SH SYNOPSIS +.B #include +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..43a79d7e02 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pcert_list_import_x509_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pcert_list_import_x509_raw(gnutls_pcert_st * " pcerts ", unsigned int * " pcert_max ", const gnutls_datum_t * " data ", gnutls_x509_crt_fmt_t " format ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pcert_st * pcerts" 12 +The structures to store the parsed certificate. Must not be initialized. +.IP "unsigned int * pcert_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 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 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. + +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 " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pem_base64_decode.3 b/doc/manpages/gnutls_pem_base64_decode.3 new file mode 100644 index 0000000000..01ced2f3a6 --- /dev/null +++ b/doc/manpages/gnutls_pem_base64_decode.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pem_base64_decode" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pem_base64_decode \- API function +.SH SYNOPSIS +.B #include +.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 null 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pem_base64_decode_alloc.3 b/doc/manpages/gnutls_pem_base64_decode_alloc.3 new file mode 100644 index 0000000000..e62675c065 --- /dev/null +++ b/doc/manpages/gnutls_pem_base64_decode_alloc.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pem_base64_decode_alloc" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pem_base64_decode_alloc \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pem_base64_decode_alloc(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 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. 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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pem_base64_encode.3 b/doc/manpages/gnutls_pem_base64_encode.3 new file mode 100644 index 0000000000..148413d5ae --- /dev/null +++ b/doc/manpages/gnutls_pem_base64_encode.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pem_base64_encode" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pem_base64_encode \- API function +.SH SYNOPSIS +.B #include +.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 +.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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pem_base64_encode_alloc.3 b/doc/manpages/gnutls_pem_base64_encode_alloc.3 new file mode 100644 index 0000000000..537f8a1b7a --- /dev/null +++ b/doc/manpages/gnutls_pem_base64_encode_alloc.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pem_base64_encode_alloc" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pem_base64_encode_alloc \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pem_base64_encode_alloc(const char * " msg ", const gnutls_datum_t * " data ", gnutls_datum_t * " result ");" +.SH ARGUMENTS +.IP "const char * msg" 12 +is a message to be put in the encoded header +.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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_perror.3 b/doc/manpages/gnutls_perror.3 new file mode 100644 index 0000000000..3b4bd4061f --- /dev/null +++ b/doc/manpages/gnutls_perror.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_perror" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_perror \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..6d78ffde59 --- /dev/null +++ b/doc/manpages/gnutls_pk_algorithm_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_algorithm_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pk_algorithm_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..10672d9e3d --- /dev/null +++ b/doc/manpages/gnutls_pk_bits_to_sec_param.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_bits_to_sec_param" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pk_bits_to_sec_param \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pk_get_id.3 b/doc/manpages/gnutls_pk_get_id.3 new file mode 100644 index 0000000000..2fcd606733 --- /dev/null +++ b/doc/manpages/gnutls_pk_get_id.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_get_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pk_get_id \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pk_get_name.3 b/doc/manpages/gnutls_pk_get_name.3 new file mode 100644 index 0000000000..5fd657134a --- /dev/null +++ b/doc/manpages/gnutls_pk_get_name.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pk_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pk_list.3 b/doc/manpages/gnutls_pk_list.3 new file mode 100644 index 0000000000..ac77a33880 --- /dev/null +++ b/doc/manpages/gnutls_pk_list.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pk_list" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pk_list \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_add_provider.3 b/doc/manpages/gnutls_pkcs11_add_provider.3 new file mode 100644 index 0000000000..9b500d0e6c --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_add_provider.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_add_provider" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_add_provider \- API function +.SH SYNOPSIS +.B #include +.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 +.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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ffae9d2614 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_copy_secret_key.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_copy_secret_key" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_secret_key \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..489eb0542f --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_copy_x509_crt.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_copy_x509_crt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_x509_crt \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..14bb180478 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_copy_x509_privkey \- API function +.SH SYNOPSIS +.B #include +.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. It is highly recommended flags to contain \fBGNUTLS_PKCS11_OBJ_FLAG_MARK_SENSITIVE\fP +unless there is a strong reason not to. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_deinit.3 b/doc/manpages/gnutls_pkcs11_deinit.3 new file mode 100644 index 0000000000..408e37e820 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_pkcs11_deinit( " void ");" +.SH ARGUMENTS +.IP " void" 12 +.SH " DESCRIPTION" + +This function will deinitialize the PKCS 11 subsystem in gnutls. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_delete_url.3 b/doc/manpages/gnutls_pkcs11_delete_url.3 new file mode 100644 index 0000000000..dec02bee42 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_delete_url.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_delete_url" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_delete_url \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_init.3 b/doc/manpages/gnutls_pkcs11_init.3 new file mode 100644 index 0000000000..68c5d4e5ef --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_init.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs11_init(unsigned int " flags ", const char * " deprecated_config_file ");" +.SH ARGUMENTS +.IP "unsigned int flags" 12 +\fBGNUTLS_PKCS11_FLAG_MANUAL\fP or \fBGNUTLS_PKCS11_FLAG_AUTO\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. + +Normally you don't need to call this function since it is being called +by \fBgnutls_global_init()\fP using the \fBGNUTLS_PKCS11_FLAG_AUTO\fP. If other option +is required then it must be called before it. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_obj_deinit.3 b/doc/manpages/gnutls_pkcs11_obj_deinit.3 new file mode 100644 index 0000000000..c4c517897e --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_deinit.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_pkcs11_obj_deinit(gnutls_pkcs11_obj_t " obj ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t obj" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a certificate structure. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_obj_export.3 b/doc/manpages/gnutls_pkcs11_obj_export.3 new file mode 100644 index 0000000000..bf4ff7d4a9 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_export.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_export \- API function +.SH SYNOPSIS +.B #include +.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 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 PKCS11 object data. It is normal for +data to be inaccesible 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. + +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 \fBGNUTLS_E_SUCCESS\fP (0) on success. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..52dcdfe13f --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_export_url.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_export_url" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_export_url \- API function +.SH SYNOPSIS +.B #include +.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 certificate. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..79335c7743 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_get_info.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_get_info" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_get_info \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs11_obj_get_info(gnutls_pkcs11_obj_t " crt ", gnutls_pkcs11_obj_info_t " itype ", void * " output ", size_t * " output_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t crt" 12 +should contain a \fBgnutls_pkcs11_obj_t\fP structure +.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 PKCS11 certificate +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 \fIoutput_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 " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..f0061ee9e5 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_get_type.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_get_type" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_get_type \- API function +.SH SYNOPSIS +.B #include +.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 certificate being +stored in the structure. +.SH " RETURNS" +The type of the certificate. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ae080729b5 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_import_url.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_import_url" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_import_url \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs11_obj_import_url(gnutls_pkcs11_obj_t " cert ", const char * " url ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t cert" 12 +The structure to store the parsed certificate +.IP "const char * url" 12 +a PKCS 11 url identifying the key +.IP "unsigned int flags" 12 +One of GNUTLS_PKCS11_OBJ_* flags +.SH " DESCRIPTION" +This function will "import" a PKCS 11 URL identifying a certificate +key to the \fBgnutls_pkcs11_obj_t\fP structure. 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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_obj_init.3 b/doc/manpages/gnutls_pkcs11_obj_init.3 new file mode 100644 index 0000000000..e208e1cb4c --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs11_obj_init(gnutls_pkcs11_obj_t * " obj ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_obj_t * obj" 12 +The structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_obj_list_import_url.3 b/doc/manpages/gnutls_pkcs11_obj_list_import_url.3 new file mode 100644 index 0000000000..0812980490 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_obj_list_import_url.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_obj_list_import_url" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_obj_list_import_url \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs11_obj_list_import_url(gnutls_pkcs11_obj_t * " p_list ", unsigned int * " n_list ", const char * " url ", gnutls_pkcs11_obj_attr_t " attrs ", 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 +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 "gnutls_pkcs11_obj_attr_t attrs" 12 +Attributes of type \fBgnutls_pkcs11_obj_attr_t\fP that can be used to limit output +.IP "unsigned int flags" 12 +One 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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_privkey_deinit.3 b/doc/manpages/gnutls_pkcs11_privkey_deinit.3 new file mode 100644 index 0000000000..a99429f327 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_pkcs11_privkey_deinit(gnutls_pkcs11_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t key" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a private key structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..3ee53795e7 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_export_url.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_export_url" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_export_url \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_privkey_generate.3 b/doc/manpages/gnutls_pkcs11_privkey_generate.3 new file mode 100644 index 0000000000..2aee9c7fe3 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_generate.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_generate" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_generate \- API function +.SH SYNOPSIS +.B #include +.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 pivate 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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..16693725aa --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_get_info.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_get_info" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_get_info \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..998c007612 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_get_pk_algorithm.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_get_pk_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..883e288da5 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_import_url.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_import_url" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_import_url \- API function +.SH SYNOPSIS +.B #include +.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 structure to store the parsed key +.IP "const char * url" 12 +a PKCS 11 url identifying the key +.IP "unsigned int flags" 12 +sequence of GNUTLS_PKCS_PRIVKEY_* +.SH " DESCRIPTION" +This function will "import" a PKCS 11 URL identifying a private +key to the \fBgnutls_pkcs11_privkey_t\fP structure. 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_privkey_init.3 b/doc/manpages/gnutls_pkcs11_privkey_init.3 new file mode 100644 index 0000000000..3090b26a7a --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_privkey_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_privkey_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_privkey_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs11_privkey_init(gnutls_pkcs11_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_privkey_t * key" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will initialize an private key structure. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1a671eedb4 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_set_pin_function.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_set_pin_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_set_pin_function \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_pkcs11_set_pin_function(gnutls_pkcs11_pin_callback_t " fn ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_pkcs11_pin_callback_t fn" 12 +The PIN callback, a \fBgnutls_pkcs11_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_pkcs11_pin_callback_t()\fP on how the callback should behave. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..24f4819bf8 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_set_token_function.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_set_token_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_set_token_function \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e9b90f7f74 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_flags.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_flags" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_flags \- API function +.SH SYNOPSIS +.B #include +.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 flags from the \fBgnutls_pkcs11_token_info_t\fP enumeration. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..913723a4e4 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_info.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_info" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_info \- API function +.SH SYNOPSIS +.B #include +.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 and will be overwritten with actual +.SH " DESCRIPTION" +This function will return information about the PKCS 11 token such +as the label, id, etc. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..765f1f27b6 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_mechanism.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_mechanism" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_mechanism \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs11_token_get_mechanism(const char * " url ", int " idx ", unsigned long * " mechanism ");" +.SH ARGUMENTS +.IP "const char * url" 12 +should contain a PKCS 11 URL +.IP "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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8df22567c6 --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_get_url.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_get_url" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_get_url \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs11_token_init.3 b/doc/manpages/gnutls_pkcs11_token_init.3 new file mode 100644 index 0000000000..411bea472d --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_token_init.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_token_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_init \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b0c48a367c --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_token_set_pin \- API function +.SH SYNOPSIS +.B #include +.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_pkcs11_pin_flag_t\fP. +.SH " DESCRIPTION" +This function will modify or set a user's PIN for the given token. +If it is called to set a user pin for first time the oldpin must +be NULL. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..42b97598ed --- /dev/null +++ b/doc/manpages/gnutls_pkcs11_type_get_name.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs11_type_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs11_type_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_bag_decrypt.3 b/doc/manpages/gnutls_pkcs12_bag_decrypt.3 new file mode 100644 index 0000000000..060d68ee0a --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_decrypt.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_decrypt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_decrypt \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_bag_deinit.3 b/doc/manpages/gnutls_pkcs12_bag_deinit.3 new file mode 100644 index 0000000000..93e0bbf4eb --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_pkcs12_bag_deinit(gnutls_pkcs12_bag_t " bag ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a PKCS12 Bag structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_bag_encrypt.3 b/doc/manpages/gnutls_pkcs12_bag_encrypt.3 new file mode 100644 index 0000000000..15a10ce30a --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_encrypt.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_encrypt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_encrypt \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0bbaf16ef0 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_count.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_count" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_count \- API function +.SH SYNOPSIS +.B #include +.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 withing the bag. +.SH " RETURNS" +Number of elements in bag, or an negative error code on +error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..4f7bde3c67 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_data.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_data \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs12_bag_get_data(gnutls_pkcs12_bag_t " bag ", int " indx ", gnutls_datum_t * " data ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..115a71ada2 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_friendly_name.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_friendly_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_friendly_name \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs12_bag_get_friendly_name(gnutls_pkcs12_bag_t " bag ", int " indx ", char ** " name ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e3a4f6264f --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_key_id.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs12_bag_get_key_id(gnutls_pkcs12_bag_t " bag ", int " indx ", gnutls_datum_t * " id ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..83148da465 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_get_type.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_get_type" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_get_type \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "gnutls_pkcs12_bag_type_t gnutls_pkcs12_bag_get_type(gnutls_pkcs12_bag_t " bag ", int " indx ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "int indx" 12 +The element of the bag to get the type +.SH " DESCRIPTION" +This function will return the bag's type. +.SH " RETURNS" +One of the \fBgnutls_pkcs12_bag_type_t\fP enumerations. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_bag_init.3 b/doc/manpages/gnutls_pkcs12_bag_init.3 new file mode 100644 index 0000000000..f83a79780f --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs12_bag_init(gnutls_pkcs12_bag_t * " bag ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t * bag" 12 +The structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ec979e144f --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_crl.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_crl" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_crl \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..028c6bbbef --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_crt.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_crt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_crt \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5b36f90c18 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_data.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_data \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..3c895223c9 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_friendly_name.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_friendly_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_friendly_name \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs12_bag_set_friendly_name(gnutls_pkcs12_bag_t " bag ", int " indx ", const char * " name ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..4cd4b241c1 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_bag_set_key_id.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_bag_set_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_bag_set_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs12_bag_set_key_id(gnutls_pkcs12_bag_t " bag ", int " indx ", const gnutls_datum_t * " id ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_bag_t bag" 12 +The bag +.IP "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_deinit.3 b/doc/manpages/gnutls_pkcs12_deinit.3 new file mode 100644 index 0000000000..1cefb46a15 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_pkcs12_deinit(gnutls_pkcs12_t " pkcs12 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a PKCS12 structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_export.3 b/doc/manpages/gnutls_pkcs12_export.3 new file mode 100644 index 0000000000..c1b9fbf7b1 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_export.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_export \- API function +.SH SYNOPSIS +.B #include +.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 +Holds the pkcs12 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_generate_mac.3 b/doc/manpages/gnutls_pkcs12_generate_mac.3 new file mode 100644 index 0000000000..99f81f17d6 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_generate_mac.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_generate_mac" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_generate_mac \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs12_generate_mac(gnutls_pkcs12_t " pkcs12 ", const char * " pass ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t pkcs12" 12 +should contain a gnutls_pkcs12_t structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_get_bag.3 b/doc/manpages/gnutls_pkcs12_get_bag.3 new file mode 100644 index 0000000000..0209c9af12 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_get_bag.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_get_bag" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_get_bag \- API function +.SH SYNOPSIS +.B #include +.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 +should contain a gnutls_pkcs12_t structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_import.3 b/doc/manpages/gnutls_pkcs12_import.3 new file mode 100644 index 0000000000..517ca79c6c --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_import.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_import \- API function +.SH SYNOPSIS +.B #include +.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 structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_init.3 b/doc/manpages/gnutls_pkcs12_init.3 new file mode 100644 index 0000000000..e4bb4a3888 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs12_init(gnutls_pkcs12_t * " pkcs12 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs12_t * pkcs12" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will initialize a PKCS12 structure. 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_set_bag.3 b/doc/manpages/gnutls_pkcs12_set_bag.3 new file mode 100644 index 0000000000..3c0eead854 --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_set_bag.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_set_bag" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_set_bag \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs12_verify_mac.3 b/doc/manpages/gnutls_pkcs12_verify_mac.3 new file mode 100644 index 0000000000..6624c87b3a --- /dev/null +++ b/doc/manpages/gnutls_pkcs12_verify_mac.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs12_verify_mac" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs12_verify_mac \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs7_deinit.3 b/doc/manpages/gnutls_pkcs7_deinit.3 new file mode 100644 index 0000000000..5ec912276a --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_pkcs7_deinit(gnutls_pkcs7_t " pkcs7 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a PKCS7 structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs7_delete_crl.3 b/doc/manpages/gnutls_pkcs7_delete_crl.3 new file mode 100644 index 0000000000..c096546594 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_delete_crl.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_delete_crl" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_delete_crl \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs7_delete_crl(gnutls_pkcs7_t " pkcs7 ", int " indx ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs7_delete_crt.3 b/doc/manpages/gnutls_pkcs7_delete_crt.3 new file mode 100644 index 0000000000..e03ebb3bf5 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_delete_crt.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_delete_crt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_delete_crt \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs7_delete_crt(gnutls_pkcs7_t " pkcs7 ", int " indx ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a gnutls_pkcs7_t structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs7_export.3 b/doc/manpages/gnutls_pkcs7_export.3 new file mode 100644 index 0000000000..a7f5da1799 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_export.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_export \- API function +.SH SYNOPSIS +.B #include +.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 +Holds the pkcs7 structure +.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 +*@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 PKCS7". +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c96973260b --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crl_count.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crl_count" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crl_count \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs7_get_crl_count(gnutls_pkcs7_t " pkcs7 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a gnutls_pkcs7_t structure +.SH " DESCRIPTION" +This function will return the number of certifcates 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..bbee8f87dc --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crl_raw.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crl_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crl_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs7_get_crl_raw(gnutls_pkcs7_t " pkcs7 ", int " indx ", void * " crl ", size_t * " crl_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP structure +.IP "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..2e3c339bdd --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crt_count.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crt_count" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crt_count \- API function +.SH SYNOPSIS +.B #include +.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 structure +.SH " DESCRIPTION" +This function will return the number of certifcates in 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..bf71915b4a --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_get_crt_raw.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_get_crt_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_get_crt_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs7_get_crt_raw(gnutls_pkcs7_t " pkcs7 ", int " indx ", void * " certificate ", size_t * " certificate_size ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a gnutls_pkcs7_t structure +.IP "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs7_import.3 b/doc/manpages/gnutls_pkcs7_import.3 new file mode 100644 index 0000000000..c988ad87a8 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_import \- API function +.SH SYNOPSIS +.B #include +.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 structure 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. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs7_init.3 b/doc/manpages/gnutls_pkcs7_init.3 new file mode 100644 index 0000000000..c823fa29ec --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs7_init(gnutls_pkcs7_t * " pkcs7 ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t * pkcs7" 12 +The structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs7_set_crl.3 b/doc/manpages/gnutls_pkcs7_set_crl.3 new file mode 100644 index 0000000000..3e138cbafb --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_set_crl.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_set_crl" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_set_crl \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs7_set_crl(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1ac927c8f4 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_set_crl_raw.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_set_crl_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_set_crl_raw \- API function +.SH SYNOPSIS +.B #include +.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 +should contain a \fBgnutls_pkcs7_t\fP structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pkcs7_set_crt.3 b/doc/manpages/gnutls_pkcs7_set_crt.3 new file mode 100644 index 0000000000..e05cfd4851 --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_set_crt.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_set_crt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_set_crt \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pkcs7_set_crt(gnutls_pkcs7_t " pkcs7 ", gnutls_x509_crt_t " crt ");" +.SH ARGUMENTS +.IP "gnutls_pkcs7_t pkcs7" 12 +should contain a \fBgnutls_pkcs7_t\fP structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..28d108673d --- /dev/null +++ b/doc/manpages/gnutls_pkcs7_set_crt_raw.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pkcs7_set_crt_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pkcs7_set_crt_raw \- API function +.SH SYNOPSIS +.B #include +.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 +should contain a \fBgnutls_pkcs7_t\fP structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_prf.3 b/doc/manpages/gnutls_prf.3 new file mode 100644 index 0000000000..40c152e98f --- /dev/null +++ b/doc/manpages/gnutls_prf.3 @@ -0,0 +1,65 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_prf" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_prf \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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\-0 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\-allocate buffer to hold the generated data. +.SH " DESCRIPTION" +Apply the TLS Pseudo\-Random\-Function (PRF) using the master secret +on some data, seeded with the client and server random fields. + +The \fIlabel\fP variable usually contain a string denoting the purpose +for the generated data. The \fIserver_random_first\fP indicate whether +the client random field or the server random field should be first +in the seed. Non\-0 indicate 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 tie 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 *@OUT, which must be pre\-allocated. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_prf_raw.3 b/doc/manpages/gnutls_prf_raw.3 new file mode 100644 index 0000000000..661a1e9ff2 --- /dev/null +++ b/doc/manpages/gnutls_prf_raw.3 @@ -0,0 +1,64 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_prf_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_prf_raw \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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\-allocate buffer to hold the generated data. +.SH " DESCRIPTION" +Apply the TLS Pseudo\-Random\-Function (PRF) using the master secret +on some data. + +The \fIlabel\fP variable usually contain a string denoting the purpose +for the generated data. The \fIseed\fP usually contain 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 include 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 seed 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 " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_priority_deinit.3 b/doc/manpages/gnutls_priority_deinit.3 new file mode 100644 index 0000000000..847ad325fd --- /dev/null +++ b/doc/manpages/gnutls_priority_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_priority_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_priority_deinit(gnutls_priority_t " priority_cache ");" +.SH ARGUMENTS +.IP "gnutls_priority_t priority_cache" 12 +is a \fBgnutls_prioritity_t\fP structure. +.SH " DESCRIPTION" +Deinitializes the priority cache. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_priority_init.3 b/doc/manpages/gnutls_priority_init.3 new file mode 100644 index 0000000000..ef1cf05829 --- /dev/null +++ b/doc/manpages/gnutls_priority_init.3 @@ -0,0 +1,95 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_priority_init \- API function +.SH SYNOPSIS +.B #include +.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_prioritity_t\fP structure. +.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 occured +.SH " DESCRIPTION" +Sets priorities for the ciphers, key exchange methods, macs and +compression methods. + +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. + +"PERFORMANCE" means all the "secure" ciphersuites are enabled, +limited to 128 bit ciphers and sorted by terms of speed +performance. + +"NORMAL" means all "secure" ciphersuites. 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. + +"EXPORT" means all ciphersuites are enabled, including the +low\-security 40 bit ciphers. + +"NONE" means nothing is enabled. This disables even protocols and +compression methods. + +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 except for ARCFOUR\-128. + +"SECURE:\-VERS\-SSL3.0:+COMP\-DEFLATE" means that only secure ciphers are +enabled, SSL3.0 is disabled, and libz compression enabled. + +"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", + +"NORMAL:\fBCOMPAT\fP" is the most compatible mode. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_priority_set.3 b/doc/manpages/gnutls_priority_set.3 new file mode 100644 index 0000000000..d71e2d873d --- /dev/null +++ b/doc/manpages/gnutls_priority_set.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_set" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_priority_set \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "gnutls_priority_t priority" 12 +is a \fBgnutls_priority_t\fP structure. +.SH " DESCRIPTION" +Sets the priorities to use on the ciphers, key exchange methods, +macs and compression methods. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_priority_set_direct.3 b/doc/manpages/gnutls_priority_set_direct.3 new file mode 100644 index 0000000000..b185d73090 --- /dev/null +++ b/doc/manpages/gnutls_priority_set_direct.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_priority_set_direct" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_priority_set_direct \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 occured +.SH " DESCRIPTION" +Sets the priorities to use on the ciphers, key exchange methods, +macs and compression methods. 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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_decrypt_data.3 b/doc/manpages/gnutls_privkey_decrypt_data.3 new file mode 100644 index 0000000000..025673d50d --- /dev/null +++ b/doc/manpages/gnutls_privkey_decrypt_data.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_decrypt_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_decrypt_data \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_deinit.3 b/doc/manpages/gnutls_privkey_deinit.3 new file mode 100644 index 0000000000..75e89dc552 --- /dev/null +++ b/doc/manpages/gnutls_privkey_deinit.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_privkey_deinit(gnutls_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t key" 12 +The structure to be deinitialized +.SH " DESCRIPTION" +This function will deinitialize a private key structure. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..fb052232ee --- /dev/null +++ b/doc/manpages/gnutls_privkey_get_pk_algorithm.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_get_pk_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_get_type.3 b/doc/manpages/gnutls_privkey_get_type.3 new file mode 100644 index 0000000000..8b435112c4 --- /dev/null +++ b/doc/manpages/gnutls_privkey_get_type.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_get_type" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_get_type \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_import_ext.3 b/doc/manpages/gnutls_privkey_import_ext.3 new file mode 100644 index 0000000000..8341b119b3 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_ext.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_ext" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_ext \- API function +.SH SYNOPSIS +.B #include +.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 structure. At least one of the two callbacks +must be non\-null. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_import_openpgp.3 b/doc/manpages/gnutls_privkey_import_openpgp.3 new file mode 100644 index 0000000000..0e03bbab42 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_openpgp.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_openpgp" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_openpgp \- API function +.SH SYNOPSIS +.B #include +.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 will import the given private key to the abstract +\fBgnutls_privkey_t\fP structure. + +The \fBgnutls_openpgp_privkey_t\fP object must not be deallocated +during the lifetime of this structure. The subkey set as +preferred will be used, or the master key otherwise. + \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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_import_pkcs11.3 b/doc/manpages/gnutls_privkey_import_pkcs11.3 new file mode 100644 index 0000000000..86550b2c0d --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_pkcs11.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_pkcs11" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_pkcs11 \- API function +.SH SYNOPSIS +.B #include +.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 structure. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_import_x509.3 b/doc/manpages/gnutls_privkey_import_x509.3 new file mode 100644 index 0000000000..748ba77375 --- /dev/null +++ b/doc/manpages/gnutls_privkey_import_x509.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_import_x509" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_import_x509 \- API function +.SH SYNOPSIS +.B #include +.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 structure. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_init.3 b/doc/manpages/gnutls_privkey_init.3 new file mode 100644 index 0000000000..adcd8d5b49 --- /dev/null +++ b/doc/manpages/gnutls_privkey_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_privkey_init(gnutls_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_privkey_t * key" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will initialize an private key 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_sign_data.3 b/doc/manpages/gnutls_privkey_sign_data.3 new file mode 100644 index 0000000000..4b1557b73a --- /dev/null +++ b/doc/manpages/gnutls_privkey_sign_data.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_sign_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_sign_data \- API function +.SH SYNOPSIS +.B #include +.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 +should be 0 for now +.IP "const gnutls_datum_t * data" 12 +holds the data to be signed +.IP "gnutls_datum_t * signature" 12 +will contain the signature allocate 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. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_privkey_sign_hash.3 b/doc/manpages/gnutls_privkey_sign_hash.3 new file mode 100644 index 0000000000..52cd4b1773 --- /dev/null +++ b/doc/manpages/gnutls_privkey_sign_hash.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_privkey_sign_hash" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_privkey_sign_hash \- API function +.SH SYNOPSIS +.B #include +.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 for now +.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. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_protocol_get_id.3 b/doc/manpages/gnutls_protocol_get_id.3 new file mode 100644 index 0000000000..11abe0530d --- /dev/null +++ b/doc/manpages/gnutls_protocol_get_id.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_get_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_get_id \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_protocol_get_name.3 b/doc/manpages/gnutls_protocol_get_name.3 new file mode 100644 index 0000000000..d6f3f84c2c --- /dev/null +++ b/doc/manpages/gnutls_protocol_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_protocol_get_version.3 b/doc/manpages/gnutls_protocol_get_version.3 new file mode 100644 index 0000000000..0370fad280 --- /dev/null +++ b/doc/manpages/gnutls_protocol_get_version.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_get_version" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_get_version \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_protocol_list.3 b/doc/manpages/gnutls_protocol_list.3 new file mode 100644 index 0000000000..be8417b868 --- /dev/null +++ b/doc/manpages/gnutls_protocol_list.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_list" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_list \- API function +.SH SYNOPSIS +.B #include +.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 threat safe. +.SH " RETURNS" +a (0)\-terminated list of \fBgnutls_protocol_t\fP integers +indicating the available protocols. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_protocol_set_priority.3 b/doc/manpages/gnutls_protocol_set_priority.3 new file mode 100644 index 0000000000..640fb62f0b --- /dev/null +++ b/doc/manpages/gnutls_protocol_set_priority.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_protocol_set_priority" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_protocol_set_priority \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_protocol_set_priority(gnutls_session_t " session ", const int * " list ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.IP "const int * list" 12 +is a 0 terminated list of gnutls_protocol_t elements. +.SH " DESCRIPTION" +Sets the priority on the protocol versions supported by gnutls. +This function actually enables or disables protocols. Newer protocol +versions always have highest priority. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..392a1f8abc --- /dev/null +++ b/doc/manpages/gnutls_psk_allocate_client_credentials.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_allocate_client_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_allocate_client_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to allocate it. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..93b7e332ec --- /dev/null +++ b/doc/manpages/gnutls_psk_allocate_server_credentials.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_allocate_server_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_allocate_server_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to allocate it. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..3bb11f0429 --- /dev/null +++ b/doc/manpages/gnutls_psk_client_get_hint.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_client_get_hint" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_client_get_hint \- API function +.SH SYNOPSIS +.B #include +.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 " RETURNS" +the identity hint of the peer, or \fBNULL\fP in case of an error. +.SH " SINCE" +2.4.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8357fe8159 --- /dev/null +++ b/doc/manpages/gnutls_psk_free_client_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_free_client_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_free_client_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to free (deallocate) it. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e85ce65154 --- /dev/null +++ b/doc/manpages/gnutls_psk_free_server_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_free_server_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_free_server_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to free (deallocate) it. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c4f8e8d95d --- /dev/null +++ b/doc/manpages/gnutls_psk_server_get_username.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_server_get_username" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_server_get_username \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +the username of the peer, or \fBNULL\fP in case of an error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..da040e3bd6 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_client_credentials.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_client_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_client_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 structure. Those will be used in +PSK authentication. \fIusername\fP should be an ASCII string or UTF\-8 +strings prepared using the "SASLprep" profile of "stringprep". 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..687e608f50 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_params_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_params_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_params_function \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..dc56bce79e --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_credentials_file.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_credentials_file" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_credentials_file \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 structure. This password file +holds usernames and keys and will be used for PSK authentication. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..be79a35925 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_credentials_hint.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_credentials_hint" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_credentials_hint \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 structure. 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8241e511de --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_dh_params.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_dh_params" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_dh_params \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..93e003f265 --- /dev/null +++ b/doc/manpages/gnutls_psk_set_server_params_function.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_psk_set_server_params_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_psk_set_server_params_function \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_deinit.3 b/doc/manpages/gnutls_pubkey_deinit.3 new file mode 100644 index 0000000000..7e3b9cd627 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_deinit.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_pubkey_deinit(gnutls_pubkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +The structure to be deinitialized +.SH " DESCRIPTION" +This function will deinitialize a public key structure. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_export.3 b/doc/manpages/gnutls_pubkey_export.3 new file mode 100644 index 0000000000..950101b887 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_export \- API function +.SH SYNOPSIS +.B #include +.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 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 \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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c02ff1094a --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_key_id.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_key_id \- API function +.SH SYNOPSIS +.B #include +.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 0 for now +.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 the 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b3a9462a23 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_key_usage.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_key_usage" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_key_usage \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c17e6ebe5d --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_openpgp_key_id.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_openpgp_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_openpgp_key_id \- API function +.SH SYNOPSIS +.B #include +.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 0 for now +.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 +Will be non zero if the key ID corresponds to a subkey +.SH " DESCRIPTION" +This function will return a unique ID the 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" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1343a11b3e --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_pk_algorithm.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_pk_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_get_pk_dsa_raw.3 b/doc/manpages/gnutls_pubkey_get_pk_dsa_raw.3 new file mode 100644 index 0000000000..fda82b6f11 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_pk_dsa_raw.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_pk_dsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_pk_dsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pubkey_get_pk_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 +.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 " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_get_pk_ecc_raw.3 b/doc/manpages/gnutls_pubkey_get_pk_ecc_raw.3 new file mode 100644 index 0000000000..2fb29da593 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_pk_ecc_raw.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_pk_ecc_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_pk_ecc_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pubkey_get_pk_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 +.IP "gnutls_datum_t * x" 12 +will hold x +.IP "gnutls_datum_t * y" 12 +will hold y +.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.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_get_pk_ecc_x962.3 b/doc/manpages/gnutls_pubkey_get_pk_ecc_x962.3 new file mode 100644 index 0000000000..a3f16047fc --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_pk_ecc_x962.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_pk_ecc_x962" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_pk_ecc_x962 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pubkey_get_pk_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.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_get_pk_rsa_raw.3 b/doc/manpages/gnutls_pubkey_get_pk_rsa_raw.3 new file mode 100644 index 0000000000..0b4b9eee59 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_pk_rsa_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_pk_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_pk_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pubkey_get_pk_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 +.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 " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..709afdb041 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_preferred_hash_algorithm.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_preferred_hash_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_preferred_hash_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 certifcate 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 " 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_get_verify_algorithm.3 b/doc/manpages/gnutls_pubkey_get_verify_algorithm.3 new file mode 100644 index 0000000000..a1acd9b659 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_verify_algorithm.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_verify_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_verify_algorithm \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pubkey_get_verify_algorithm(gnutls_pubkey_t " key ", const gnutls_datum_t * " signature ", gnutls_digest_algorithm_t * " hash ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the certificate +.IP "const gnutls_datum_t * signature" 12 +contains the signature +.IP "gnutls_digest_algorithm_t * hash" 12 +The result of the call with the hash algorithm used for signature +.SH " DESCRIPTION" +This function will read the certifcate and the signed data to +determine the hash algorithm used to generate the signature. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_import.3 b/doc/manpages/gnutls_pubkey_import.3 new file mode 100644 index 0000000000..2e79875d8c --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import \- API function +.SH SYNOPSIS +.B #include +.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 structure to store the parsed 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 convert the given DER or PEM encoded Public key +to the native gnutls_pubkey_t format.The output will be stored +in \fIkey\fP. +If the Certificate 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..10d912e359 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_dsa_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_dsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_dsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..17b64066a2 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_ecc_raw.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_ecc_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_ecc_raw \- API function +.SH SYNOPSIS +.B #include +.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 +.IP "const gnutls_datum_t * y" 12 +holds the y +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..7ff0840df5 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_ecc_x962.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_ecc_x962" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_ecc_x962 \- API function +.SH SYNOPSIS +.B #include +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_import_openpgp.3 b/doc/manpages/gnutls_pubkey_import_openpgp.3 new file mode 100644 index 0000000000..6d50b2a36c --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_openpgp.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_openpgp" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_openpgp \- API function +.SH SYNOPSIS +.B #include +.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" +Imports a public key from an openpgp key. This function will import +the given public key to the abstract \fBgnutls_pubkey_t\fP +structure. The subkey set as preferred will be imported or the +master key otherwise. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_import_pkcs11.3 b/doc/manpages/gnutls_pubkey_import_pkcs11.3 new file mode 100644 index 0000000000..40426ea724 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_pkcs11.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_pkcs11" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_pkcs11 \- API function +.SH SYNOPSIS +.B #include +.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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_import_pkcs11_url.3 b/doc/manpages/gnutls_pubkey_import_pkcs11_url.3 new file mode 100644 index 0000000000..cc41065000 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_pkcs11_url.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_pkcs11_url" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_pkcs11_url \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pubkey_import_pkcs11_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 PKCS 11 certificate to a \fBgnutls_pubkey_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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_import_privkey.3 b/doc/manpages/gnutls_pubkey_import_privkey.3 new file mode 100644 index 0000000000..6112cfa313 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_privkey.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_privkey" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_privkey \- API function +.SH SYNOPSIS +.B #include +.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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5b505d24c1 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_rsa_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 +Is a structure will hold the parameters +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_import_x509.3 b/doc/manpages/gnutls_pubkey_import_x509.3 new file mode 100644 index 0000000000..867ea87c71 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_import_x509.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_import_x509" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_import_x509 \- API function +.SH SYNOPSIS +.B #include +.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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_init.3 b/doc/manpages/gnutls_pubkey_init.3 new file mode 100644 index 0000000000..4f6a77fa08 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_init.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pubkey_init(gnutls_pubkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t * key" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will initialize an public key 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b1a834269b --- /dev/null +++ b/doc/manpages/gnutls_pubkey_set_key_usage.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_set_key_usage" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_set_key_usage \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_verify_data.3 b/doc/manpages/gnutls_pubkey_verify_data.3 new file mode 100644 index 0000000000..75a9930594 --- /dev/null +++ b/doc/manpages/gnutls_pubkey_verify_data.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_verify_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_verify_data \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pubkey_verify_data(gnutls_pubkey_t " pubkey ", 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 "unsigned int flags" 12 +should be 0 for now +.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" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value (\fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP in verification failure). +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_verify_data2.3 b/doc/manpages/gnutls_pubkey_verify_data2.3 new file mode 100644 index 0000000000..f9417e869f --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_verify_data2 \- API function +.SH SYNOPSIS +.B #include +.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 +should be 0 for now +.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" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value (\fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP in verification failure). +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_pubkey_verify_hash.3 b/doc/manpages/gnutls_pubkey_verify_hash.3 new file mode 100644 index 0000000000..8d74dcb71f --- /dev/null +++ b/doc/manpages/gnutls_pubkey_verify_hash.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_verify_hash" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_verify_hash \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_pubkey_verify_hash(gnutls_pubkey_t " key ", unsigned int " flags ", const gnutls_datum_t * " hash ", const gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the certificate +.IP "unsigned int flags" 12 +should be 0 for now +.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 certificate. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value (\fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP in verification failure). +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_record_check_pending.3 b/doc/manpages/gnutls_record_check_pending.3 new file mode 100644 index 0000000000..3bad3e3720 --- /dev/null +++ b/doc/manpages/gnutls_record_check_pending.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_check_pending" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_record_check_pending \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 guarranteed not to block. +.SH " RETURNS" +Returns the size of the data or zero. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_record_disable_padding.3 b/doc/manpages/gnutls_record_disable_padding.3 new file mode 100644 index 0000000000..698726815e --- /dev/null +++ b/doc/manpages/gnutls_record_disable_padding.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_disable_padding" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_record_disable_padding \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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. + +Normally only servers that require maximum compatibility with everything +out there, need to call this function. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_record_get_direction.3 b/doc/manpages/gnutls_record_get_direction.3 new file mode 100644 index 0000000000..8c3b5a3164 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_record_get_direction \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This function 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 for some reason, that +is, if a function returned \fBGNUTLS_E_INTERRUPTED\fP or +\fBGNUTLS_E_AGAIN\fP. In such a case, you might want to call \fBselect()\fP +or \fBpoll()\fP before calling the interrupted gnutls function again. To +tell you whether a file descriptor should be selected for either +reading or writing, \fBgnutls_record_get_direction()\fP returns 0 if the +interrupted function was trying to read data, and 1 if it was +trying to write data. +.SH " RETURNS" +0 if trying to read data, 1 if trying to write data. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_record_get_discarded.3 b/doc/manpages/gnutls_record_get_discarded.3 new file mode 100644 index 0000000000..a8c851ac1c --- /dev/null +++ b/doc/manpages/gnutls_record_get_discarded.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_get_discarded" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_record_get_discarded \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +Returns the number of discarded packets in a +DTLS connection. +.SH " RETURNS" +The number of discarded packets. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..09c51fe83f --- /dev/null +++ b/doc/manpages/gnutls_record_get_max_size.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_get_max_size" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_record_get_max_size \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_record_recv.3 b/doc/manpages/gnutls_record_recv.3 new file mode 100644 index 0000000000..a8ffc68606 --- /dev/null +++ b/doc/manpages/gnutls_record_recv.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_recv" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_record_recv \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 a server requests a renegotiation, the +client may receive an error code of \fBGNUTLS_E_REHANDSHAKE\fP. 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. +If \fBEINTR\fP is returned by the internal push 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. +A server may also receive \fBGNUTLS_E_REHANDSHAKE\fP when a client has +initiated a handshake. In that case the server can only initiate a +handshake or terminate the connection. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_record_recv_seq.3 b/doc/manpages/gnutls_record_recv_seq.3 new file mode 100644 index 0000000000..299e57dfa2 --- /dev/null +++ b/doc/manpages/gnutls_record_recv_seq.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_recv_seq" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_record_recv_seq \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_record_send.3 b/doc/manpages/gnutls_record_send.3 new file mode 100644 index 0000000000..4086b32200 --- /dev/null +++ b/doc/manpages/gnutls_record_send.3 @@ -0,0 +1,57 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_send" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_record_send \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 full information. You +can replace the default push function by using +\fBgnutls_transport_set_ptr2()\fP with a call to \fBsend()\fP with a +MSG_DONTWAIT flag if blocking is a problem. +If the EINTR is returned by the internal push function (the +default is \fBsend()\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, with the same parameters; alternatively +you could provide a \fBNULL\fP pointer for data, and 0 for +size. cf. \fBgnutls_record_get_direction()\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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..54eda653e7 --- /dev/null +++ b/doc/manpages/gnutls_record_set_max_size.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_record_set_max_size" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_record_set_max_size \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "size_t size" 12 +is the new size +.SH " DESCRIPTION" +This function sets the maximum record packet size in this +connection. This property can only be set to clients. The server +may choose not to accept the requested size. + +Acceptable values are 512(=2^9), 1024(=2^10), 2048(=2^11) and +4096(=2^12). The requested record size does get in effect +immediately only while sending data. The receive part will take +effect after a successful handshake. + +This function uses a TLS extension called 'max record size'. Not +all TLS implementations use or even understand this extension. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rehandshake.3 b/doc/manpages/gnutls_rehandshake.3 new file mode 100644 index 0000000000..ef80dd1482 --- /dev/null +++ b/doc/manpages/gnutls_rehandshake.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rehandshake" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rehandshake \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rehandshake(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.SH " DESCRIPTION" +This function will renegotiate security parameters with the +client. This should only be called in case of a server. + +This message informs the peer that we want to renegotiate +parameters (perform a handshake). + +If this function succeeds (returns 0), you must call the +\fBgnutls_handshake()\fP function in order to negotiate the new +parameters. + +Since TLS is full duplex some application data might have been +sent during peer's processing of this message. In that case +one should call \fBgnutls_record_recv()\fP until GNUTLS_E_REHANDSHAKE +is returned to clear any pending data. Care must be taken if +rehandshake is mandatory to terminate if it does not start after +some threshold. + +If the client does not wish to renegotiate parameters he will +should with an alert message, thus the return code will be +\fBGNUTLS_E_WARNING_ALERT_RECEIVED\fP and the alert will be +\fBGNUTLS_A_NO_RENEGOTIATION\fP. A client may also choose to ignore +this message. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rnd.3 b/doc/manpages/gnutls_rnd.3 new file mode 100644 index 0000000000..bafcc3968e --- /dev/null +++ b/doc/manpages/gnutls_rnd.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rnd" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rnd \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +Zero or a negative error code on error. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_export_get_modulus_bits.3 b/doc/manpages/gnutls_rsa_export_get_modulus_bits.3 new file mode 100644 index 0000000000..e9e9c5a6a9 --- /dev/null +++ b/doc/manpages/gnutls_rsa_export_get_modulus_bits.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_export_get_modulus_bits" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_export_get_modulus_bits \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rsa_export_get_modulus_bits(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.SH " DESCRIPTION" +Get the export RSA parameter's modulus size. +.SH " RETURNS" +The bits used in the last RSA\-EXPORT key exchange with the +peer, or a negative error code in case of error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_export_get_pubkey.3 b/doc/manpages/gnutls_rsa_export_get_pubkey.3 new file mode 100644 index 0000000000..51b58071ff --- /dev/null +++ b/doc/manpages/gnutls_rsa_export_get_pubkey.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_export_get_pubkey" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_export_get_pubkey \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rsa_export_get_pubkey(gnutls_session_t " session ", gnutls_datum_t * " exponent ", gnutls_datum_t * " modulus ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "gnutls_datum_t * exponent" 12 +will hold the exponent. +.IP "gnutls_datum_t * modulus" 12 +will hold the modulus. +.SH " DESCRIPTION" +This function will return the peer's public key exponent and +modulus used in the last RSA\-EXPORT authentication. The output +parameters must be freed with \fBgnutls_free()\fP. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_params_cpy.3 b/doc/manpages/gnutls_rsa_params_cpy.3 new file mode 100644 index 0000000000..00da0e8018 --- /dev/null +++ b/doc/manpages/gnutls_rsa_params_cpy.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_params_cpy" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_params_cpy \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rsa_params_cpy(gnutls_rsa_params_t " dst ", gnutls_rsa_params_t " src ");" +.SH ARGUMENTS +.IP "gnutls_rsa_params_t dst" 12 +Is the destination structure, which should be initialized. +.IP "gnutls_rsa_params_t src" 12 +Is the source structure +.SH " DESCRIPTION" +This function will copy the RSA parameters structure from source +to destination. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_params_deinit.3 b/doc/manpages/gnutls_rsa_params_deinit.3 new file mode 100644 index 0000000000..feb8529e62 --- /dev/null +++ b/doc/manpages/gnutls_rsa_params_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_params_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_params_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_rsa_params_deinit(gnutls_rsa_params_t " rsa_params ");" +.SH ARGUMENTS +.IP "gnutls_rsa_params_t rsa_params" 12 +Is a structure that holds the parameters +.SH " DESCRIPTION" +This function will deinitialize the RSA parameters structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_params_export_pkcs1.3 b/doc/manpages/gnutls_rsa_params_export_pkcs1.3 new file mode 100644 index 0000000000..582ef7bca8 --- /dev/null +++ b/doc/manpages/gnutls_rsa_params_export_pkcs1.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_params_export_pkcs1" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_params_export_pkcs1 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rsa_params_export_pkcs1(gnutls_rsa_params_t " params ", gnutls_x509_crt_fmt_t " format ", unsigned char * " params_data ", size_t * " params_data_size ");" +.SH ARGUMENTS +.IP "gnutls_rsa_params_t params" 12 +Holds the RSA 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 PKCS1 RSAPublicKey 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 RSA parameters to a PKCS1 +RSAPublicKey structure. 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 RSA PRIVATE KEY". +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_params_export_raw.3 b/doc/manpages/gnutls_rsa_params_export_raw.3 new file mode 100644 index 0000000000..ee0fce357a --- /dev/null +++ b/doc/manpages/gnutls_rsa_params_export_raw.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_params_export_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_params_export_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rsa_params_export_raw(gnutls_rsa_params_t " rsa ", gnutls_datum_t * " m ", gnutls_datum_t * " e ", gnutls_datum_t * " d ", gnutls_datum_t * " p ", gnutls_datum_t * " q ", gnutls_datum_t * " u ", unsigned int * " bits ");" +.SH ARGUMENTS +.IP "gnutls_rsa_params_t rsa" 12 +a structure that holds the rsa parameters +.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 "unsigned int * bits" 12 +if non null will hold the prime's number of bits +.SH " DESCRIPTION" +This function will export the RSA 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, or an negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_params_generate2.3 b/doc/manpages/gnutls_rsa_params_generate2.3 new file mode 100644 index 0000000000..e89f944bab --- /dev/null +++ b/doc/manpages/gnutls_rsa_params_generate2.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_params_generate2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_params_generate2 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rsa_params_generate2(gnutls_rsa_params_t " params ", unsigned int " bits ");" +.SH ARGUMENTS +.IP "gnutls_rsa_params_t params" 12 +The structure where the parameters will be stored +.IP "unsigned int bits" 12 +is the prime's number of bits +.SH " DESCRIPTION" +This function will generate new temporary RSA parameters for use in +RSA\-EXPORT ciphersuites. This function is normally slow. + +Note that if the parameters are to be used in export cipher suites the +bits value should be 512 or less. +Also note that the generation of new RSA parameters is only useful +to servers. Clients use the parameters sent by the server, thus it's +no use calling this in client side. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_params_import_pkcs1.3 b/doc/manpages/gnutls_rsa_params_import_pkcs1.3 new file mode 100644 index 0000000000..53c07356e4 --- /dev/null +++ b/doc/manpages/gnutls_rsa_params_import_pkcs1.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_params_import_pkcs1" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_params_import_pkcs1 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rsa_params_import_pkcs1(gnutls_rsa_params_t " params ", const gnutls_datum_t * " pkcs1_params ", gnutls_x509_crt_fmt_t " format ");" +.SH ARGUMENTS +.IP "gnutls_rsa_params_t params" 12 +A structure where the parameters will be copied to +.IP "const gnutls_datum_t * pkcs1_params" 12 +should contain a PKCS1 RSAPublicKey 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 RSAPublicKey found in a PKCS1 formatted +structure. + +If the structure is PEM encoded, it should have a header +of "BEGIN RSA PRIVATE KEY". +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_params_import_raw.3 b/doc/manpages/gnutls_rsa_params_import_raw.3 new file mode 100644 index 0000000000..bfe02c51be --- /dev/null +++ b/doc/manpages/gnutls_rsa_params_import_raw.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_params_import_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_params_import_raw \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rsa_params_import_raw(gnutls_rsa_params_t " rsa_params ", 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_rsa_params_t rsa_params" 12 +Is a structure will hold the parameters +.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 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 "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_rsa_params_init.3 b/doc/manpages/gnutls_rsa_params_init.3 new file mode 100644 index 0000000000..c3dc43a71d --- /dev/null +++ b/doc/manpages/gnutls_rsa_params_init.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_rsa_params_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_rsa_params_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_rsa_params_init(gnutls_rsa_params_t * " rsa_params ");" +.SH ARGUMENTS +.IP "gnutls_rsa_params_t * rsa_params" 12 +Is a structure that will hold the parameters +.SH " DESCRIPTION" +This function will initialize the temporary RSA parameters structure. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_safe_renegotiation_status.3 b/doc/manpages/gnutls_safe_renegotiation_status.3 new file mode 100644 index 0000000000..fb84e17e38 --- /dev/null +++ b/doc/manpages/gnutls_safe_renegotiation_status.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_safe_renegotiation_status" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_safe_renegotiation_status \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_safe_renegotiation_status(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..13f611478d --- /dev/null +++ b/doc/manpages/gnutls_sec_param_get_name.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sec_param_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_sec_param_get_name \- API function +.SH SYNOPSIS +.B #include +.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 public key algorithm, or \fBNULL\fP. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..372f2c543a --- /dev/null +++ b/doc/manpages/gnutls_sec_param_to_pk_bits.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sec_param_to_pk_bits" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_sec_param_to_pk_bits \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_server_name_get.3 b/doc/manpages/gnutls_server_name_get.3 new file mode 100644 index 0000000000..77e10eb588 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_server_name_get \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 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. + \fIindex\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, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_server_name_set.3 b/doc/manpages/gnutls_server_name_set.3 new file mode 100644 index 0000000000..83f6ab536b --- /dev/null +++ b/doc/manpages/gnutls_server_name_set.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_server_name_set" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_server_name_set \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 +.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, an ASCII (0)\-terminated domain name string, +without the trailing dot, is expected. IPv4 or IPv6 addresses are +not permitted. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +otherwise a negative error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_session_channel_binding.3 b/doc/manpages/gnutls_session_channel_binding.3 new file mode 100644 index 0000000000..8b931b8c2c --- /dev/null +++ b/doc/manpages/gnutls_session_channel_binding.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_channel_binding" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_channel_binding \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..943a92f766 --- /dev/null +++ b/doc/manpages/gnutls_session_enable_compatibility_mode.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_enable_compatibility_mode" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_enable_compatibility_mode \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This function can be used to disable certain (security) features in +TLS in order to maintain maximum compatibility with buggy +clients. It is equivalent to calling: +\fBgnutls_record_disable_padding()\fP + +Normally only servers that require maximum compatibility with +everything out there, need to call this function. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_session_get_data.3 b/doc/manpages/gnutls_session_get_data.3 new file mode 100644 index 0000000000..a4a0df7dcd --- /dev/null +++ b/doc/manpages/gnutls_session_get_data.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_data \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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, in order to support resuming. The +client should call this, and keep the returned session, if he +wants to resume that current version later by calling +\fBgnutls_session_set_data()\fP This function must be called after a +successful handshake. + +Resuming sessions is really useful and speedups connections after +a successful one. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_session_get_data2.3 b/doc/manpages/gnutls_session_get_data2.3 new file mode 100644 index 0000000000..d2f8e0b7f9 --- /dev/null +++ b/doc/manpages/gnutls_session_get_data2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_data2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_data2 \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "gnutls_datum_t * data" 12 +is a pointer to a datum that will hold the session. +.SH " DESCRIPTION" +Returns all session parameters, in order to support resuming. The +client should call this, and keep the returned session, if he wants +to resume that current version later by calling +\fBgnutls_session_set_data()\fP. This function must be called after a +successful handshake. The returned datum must be freed with +\fBgnutls_free()\fP. + +Resuming sessions is really useful and speedups connections after +a successful one. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_session_get_id.3 b/doc/manpages/gnutls_session_get_id.3 new file mode 100644 index 0000000000..e353861be6 --- /dev/null +++ b/doc/manpages/gnutls_session_get_id.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_id \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "void * session_id" 12 +is a pointer to space to hold the session id. +.IP "size_t * session_id_size" 12 +is the session id's size, or it will be set by the function. +.SH " DESCRIPTION" +Returns the current session id. This can be used if you want to +check if the next session you tried to resume was actually +resumed. This is because resumed sessions have the same sessionID +with the original session. + +Session id is some data set by the server, that identify the +current session. In TLS 1.0 and SSL 3.0 session id is always less +than 32 bytes. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise +an error code is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_session_get_ptr.3 b/doc/manpages/gnutls_session_get_ptr.3 new file mode 100644 index 0000000000..9db5635f5e --- /dev/null +++ b/doc/manpages/gnutls_session_get_ptr.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_get_ptr" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_get_ptr \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_session_is_resumed.3 b/doc/manpages/gnutls_session_is_resumed.3 new file mode 100644 index 0000000000..438d245a07 --- /dev/null +++ b/doc/manpages/gnutls_session_is_resumed.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_is_resumed" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_is_resumed \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +Check whether session is resumed or not. +.SH " RETURNS" +non zero if this session is resumed, or a zero if this is +a new session. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_session_set_data.3 b/doc/manpages/gnutls_session_set_data.3 new file mode 100644 index 0000000000..abc11f1a36 --- /dev/null +++ b/doc/manpages/gnutls_session_set_data.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_data \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_session_set_ptr.3 b/doc/manpages/gnutls_session_set_ptr.3 new file mode 100644 index 0000000000..649ca6fd91 --- /dev/null +++ b/doc/manpages/gnutls_session_set_ptr.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_set_ptr" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_set_ptr \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 is pointer can be accessed with +\fBgnutls_session_get_ptr()\fP. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..870ba373e0 --- /dev/null +++ b/doc/manpages/gnutls_session_ticket_enable_client.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_ticket_enable_client" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_ticket_enable_client \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +Request that the client should attempt session resumption using +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..80f4ac3e2b --- /dev/null +++ b/doc/manpages/gnutls_session_ticket_enable_server.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_ticket_enable_server" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_ticket_enable_server \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.IP "const gnutls_datum_t * key" 12 +key to encrypt session parameters. +.SH " DESCRIPTION" +Request that the server should attempt session resumption using +SessionTicket. \fIkey\fP must be initialized with +\fBgnutls_session_ticket_key_generate()\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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..9849699d2e --- /dev/null +++ b/doc/manpages/gnutls_session_ticket_key_generate.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_session_ticket_key_generate" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_session_ticket_key_generate \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_set_default_export_priority.3 b/doc/manpages/gnutls_set_default_export_priority.3 new file mode 100644 index 0000000000..3b70cc2e99 --- /dev/null +++ b/doc/manpages/gnutls_set_default_export_priority.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_set_default_export_priority" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_set_default_export_priority \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_set_default_export_priority(gnutls_session_t " session ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a \fBgnutls_session_t\fP structure. +.SH " DESCRIPTION" +Sets some default priority on the ciphers, key exchange methods, macs +and compression methods. This function also includes weak algorithms. +.SH " THIS IS THE SAME AS CALLING" + +gnutls_priority_set_direct (session, "EXPORT", NULL); + +This function is kept around for backwards compatibility, but +because of its wide use it is still fully supported. If you wish +to allow users to provide a string that specify which ciphers to +use (which is recommended), you should use +\fBgnutls_priority_set_direct()\fP or \fBgnutls_priority_set()\fP instead. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_set_default_priority.3 b/doc/manpages/gnutls_set_default_priority.3 new file mode 100644 index 0000000000..da150e300c --- /dev/null +++ b/doc/manpages/gnutls_set_default_priority.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_set_default_priority" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_set_default_priority \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +Sets some default priority on the ciphers, key exchange methods, +macs and compression methods. +.SH " THIS IS THE SAME AS CALLING" + +gnutls_priority_set_direct (session, "NORMAL", NULL); + +This function is kept around for backwards compatibility, but +because of its wide use it is still fully supported. If you wish +to allow users to provide a string that specify which ciphers to +use (which is recommended), you should use +\fBgnutls_priority_set_direct()\fP or \fBgnutls_priority_set()\fP instead. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..f214536829 --- /dev/null +++ b/doc/manpages/gnutls_sign_algorithm_get_requested.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_algorithm_get_requested" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_sign_algorithm_get_requested \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_sign_callback_get.3 b/doc/manpages/gnutls_sign_callback_get.3 new file mode 100644 index 0000000000..b248561ae7 --- /dev/null +++ b/doc/manpages/gnutls_sign_callback_get.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_callback_get" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_sign_callback_get \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "gnutls_sign_func gnutls_sign_callback_get(gnutls_session_t " session ", void ** " userdata ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "void ** userdata" 12 +if non\-\fBNULL\fP, will be set to abstract callback pointer. +.SH " DESCRIPTION" +Retrieve the callback function, and its userdata pointer. +.SH " RETURNS" +The function pointer set by \fBgnutls_sign_callback_set()\fP, or +if not set, \fBNULL\fP. +.SH " DEPRECATED" +Use the PKCS 11 interfaces instead. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_sign_callback_set.3 b/doc/manpages/gnutls_sign_callback_set.3 new file mode 100644 index 0000000000..efbed3b02f --- /dev/null +++ b/doc/manpages/gnutls_sign_callback_set.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_callback_set" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_sign_callback_set \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_sign_callback_set(gnutls_session_t " session ", gnutls_sign_func " sign_func ", void * " userdata ");" +.SH ARGUMENTS +.IP "gnutls_session_t session" 12 +is a gnutls session +.IP "gnutls_sign_func sign_func" 12 +function pointer to application's sign callback. +.IP "void * userdata" 12 +void pointer that will be passed to sign callback. +.SH " DESCRIPTION" +Set the callback function. The function must have this prototype: + +typedef int (*gnutls_sign_func) (gnutls_session_t session, +void *userdata, +gnutls_certificate_type_t cert_type, +const gnutls_datum_t * cert, +const gnutls_datum_t * hash, +gnutls_datum_t * signature); + +The \fIuserdata\fP parameter is passed to the \fIsign_func\fP verbatim, and +can be used to store application\-specific data needed in the +callback function. See also \fBgnutls_sign_callback_get()\fP. +.SH " DEPRECATED" +Use the PKCS 11 or \fBgnutls_privkey_t\fP interfacess like \fBgnutls_privkey_import_ext()\fP instead. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_sign_get_id.3 b/doc/manpages/gnutls_sign_get_id.3 new file mode 100644 index 0000000000..a5be80499f --- /dev/null +++ b/doc/manpages/gnutls_sign_get_id.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_get_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_sign_get_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "gnutls_sign_algorithm_t gnutls_sign_get_id(const char * " name ");" +.SH ARGUMENTS +.IP "const char * name" 12 +is a MAC 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 cipher, or \fBGNUTLS_SIGN_UNKNOWN\fP on error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_sign_get_name.3 b/doc/manpages/gnutls_sign_get_name.3 new file mode 100644 index 0000000000..fb7b3739a0 --- /dev/null +++ b/doc/manpages/gnutls_sign_get_name.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_sign_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_sign_list.3 b/doc/manpages/gnutls_sign_list.3 new file mode 100644 index 0000000000..19445e8b5f --- /dev/null +++ b/doc/manpages/gnutls_sign_list.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_sign_list" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_sign_list \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +a (0)\-terminated list of \fBgnutls_sign_algorithm_t\fP +integers indicating the available ciphers. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..431b64124a --- /dev/null +++ b/doc/manpages/gnutls_srp_allocate_client_credentials.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_allocate_client_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_allocate_client_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus +this helper function is provided in order to allocate it. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ab5f1cede3 --- /dev/null +++ b/doc/manpages/gnutls_srp_allocate_server_credentials.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_allocate_server_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_allocate_server_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus this +helper function is provided in order to allocate it. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_srp_base64_decode.3 b/doc/manpages/gnutls_srp_base64_decode.3 new file mode 100644 index 0000000000..20e52e01a0 --- /dev/null +++ b/doc/manpages/gnutls_srp_base64_decode.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_base64_decode" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_base64_decode \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_srp_base64_decode_alloc.3 b/doc/manpages/gnutls_srp_base64_decode_alloc.3 new file mode 100644 index 0000000000..04ba6e4975 --- /dev/null +++ b/doc/manpages/gnutls_srp_base64_decode_alloc.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_base64_decode_alloc" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_base64_decode_alloc \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_srp_base64_decode_alloc(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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_srp_base64_encode.3 b/doc/manpages/gnutls_srp_base64_encode.3 new file mode 100644 index 0000000000..445332e486 --- /dev/null +++ b/doc/manpages/gnutls_srp_base64_encode.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_base64_encode" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_base64_encode \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_srp_base64_encode_alloc.3 b/doc/manpages/gnutls_srp_base64_encode_alloc.3 new file mode 100644 index 0000000000..264a035c76 --- /dev/null +++ b/doc/manpages/gnutls_srp_base64_encode_alloc.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_base64_encode_alloc" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_base64_encode_alloc \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_srp_base64_encode_alloc(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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c735630d83 --- /dev/null +++ b/doc/manpages/gnutls_srp_free_client_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_free_client_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_free_client_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus +this helper function is provided in order to free (deallocate) it. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a9923c19e8 --- /dev/null +++ b/doc/manpages/gnutls_srp_free_server_credentials.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_free_server_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_free_server_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.SH " DESCRIPTION" +This structure is complex enough to manipulate directly thus +this helper function is provided in order to free (deallocate) it. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e8a0e01643 --- /dev/null +++ b/doc/manpages/gnutls_srp_server_get_username.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_server_get_username" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_server_get_username \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..d50f4780f0 --- /dev/null +++ b/doc/manpages/gnutls_srp_set_client_credentials.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_set_client_credentials" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_set_client_credentials \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 structure. Those will be used in +SRP authentication. \fIusername\fP and \fIpassword\fP should be ASCII +strings or UTF\-8 strings prepared using the "SASLprep" profile of +"stringprep". +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an +error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b0042b61d1 --- /dev/null +++ b/doc/manpages/gnutls_srp_set_prime_bits.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_set_prime_bits" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_set_prime_bits \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..fa849b8e90 --- /dev/null +++ b/doc/manpages/gnutls_srp_set_server_credentials_file.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_set_server_credentials_file" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_set_server_credentials_file \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 structure. 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_srp_verifier.3 b/doc/manpages/gnutls_srp_verifier.3 new file mode 100644 index 0000000000..a4ef62110c --- /dev/null +++ b/doc/manpages/gnutls_srp_verifier.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_srp_verifier" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_srp_verifier \- API function +.SH SYNOPSIS +.B #include +.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 \fIgnutls_malloc\\fBfP()\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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_strerror.3 b/doc/manpages/gnutls_strerror.3 new file mode 100644 index 0000000000..b49ef10599 --- /dev/null +++ b/doc/manpages/gnutls_strerror.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_strerror" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_strerror \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_strerror_name.3 b/doc/manpages/gnutls_strerror_name.3 new file mode 100644 index 0000000000..1bbae8db33 --- /dev/null +++ b/doc/manpages/gnutls_strerror_name.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_strerror_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_strerror_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_supplemental_get_name.3 b/doc/manpages/gnutls_supplemental_get_name.3 new file mode 100644 index 0000000000..33fccde84a --- /dev/null +++ b/doc/manpages/gnutls_supplemental_get_name.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_supplemental_get_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_supplemental_get_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_transport_get_ptr.3 b/doc/manpages/gnutls_transport_get_ptr.3 new file mode 100644 index 0000000000..8b9aeb0fbb --- /dev/null +++ b/doc/manpages/gnutls_transport_get_ptr.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_get_ptr" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_get_ptr \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_transport_get_ptr2.3 b/doc/manpages/gnutls_transport_get_ptr2.3 new file mode 100644 index 0000000000..ea25a787e1 --- /dev/null +++ b/doc/manpages/gnutls_transport_get_ptr2.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_get_ptr2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_get_ptr2 \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_transport_set_errno.3 b/doc/manpages/gnutls_transport_set_errno.3 new file mode 100644 index 0000000000..9361eb8047 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_errno \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 is EAGAIN and EINTR, 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). +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..59ae3bc75d --- /dev/null +++ b/doc/manpages/gnutls_transport_set_errno_function.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_errno_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_errno_function \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_transport_set_ptr.3 b/doc/manpages/gnutls_transport_set_ptr.3 new file mode 100644 index 0000000000..f9685a9062 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_ptr.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_ptr" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_ptr \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_transport_set_ptr2.3 b/doc/manpages/gnutls_transport_set_ptr2.3 new file mode 100644 index 0000000000..21a0f54930 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_ptr2.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_ptr2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_ptr2 \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..3c37bf5261 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_pull_function.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_pull_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_pull_function \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..efb526c1d3 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_pull_timeout_function.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_pull_timeout_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_pull_timeout_function \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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. +The callback function is used in DTLS only. + \fIgnutls_pull_timeout_func\fP is of the form, +ssize_t (*gnutls_pull_timeout_func)(gnutls_transport_ptr_t, unsigned int ms); +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..9712b495f5 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_push_function.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_push_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_push_function \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..50aa949686 --- /dev/null +++ b/doc/manpages/gnutls_transport_set_vec_push_function.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_transport_set_vec_push_function" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_transport_set_vec_push_function \- API function +.SH SYNOPSIS +.B #include +.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 structure. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c91a11b0b7 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_check_issuer.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_check_issuer" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_check_issuer \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int 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. It will return true (1) if the given CRL was +issued by the given issuer, and false (0) if not. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crl_deinit.3 b/doc/manpages/gnutls_x509_crl_deinit.3 new file mode 100644 index 0000000000..5c0db98142 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_x509_crl_deinit(gnutls_x509_crl_t " crl ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a CRL structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crl_export.3 b/doc/manpages/gnutls_x509_crl_export.3 new file mode 100644 index 0000000000..dc59e6f40d --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_export.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_export \- API function +.SH SYNOPSIS +.B #include +.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. and a negative error code on failure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..89dc0386c4 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_authority_key_id.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_authority_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_authority_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_get_authority_key_id(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 structure +.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 (0) 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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..9e834c6855 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_crt_count.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_crt_count" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_crt_count \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..2c26cf8d90 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_crt_serial.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_crt_serial" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_crt_serial \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_get_crt_serial(gnutls_x509_crl_t " crl ", int " 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 structure +.IP "int 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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. and a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c22d738033 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_dn_oid.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_dn_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_dn_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_get_dn_oid(gnutls_x509_crl_t " crl ", int " indx ", void * " oid ", size_t * " sizeof_oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t structure +.IP "int indx" 12 +Specifies which DN OID to send. Use (0) to get the first one. +.IP "void * oid" 12 +a pointer to a structure to hold the name (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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..67502afa1a --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_extension_data.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_extension_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_extension_data \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_get_extension_data(gnutls_x509_crl_t " crl ", int " indx ", void * " data ", size_t * " sizeof_data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP structure +.IP "int 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..2ee56accc9 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_extension_info.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_extension_info" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_extension_info \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_get_extension_info(gnutls_x509_crl_t " crl ", int " indx ", void * " oid ", size_t * " sizeof_oid ", int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP structure +.IP "int 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 * sizeof_oid" 12 +initially holds the maximum size of \fIoid\fP, on return +holds actual size of \fIoid\fP. +.IP "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 +*@sizeof_oid 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0e418f16f3 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_extension_oid.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_extension_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_extension_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_get_extension_oid(gnutls_x509_crl_t " crl ", int " indx ", void * " oid ", size_t * " sizeof_oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t crl" 12 +should contain a \fBgnutls_x509_crl_t\fP structure +.IP "int 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 * 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..857c5a3754 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_issuer_dn.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_issuer_dn" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_issuer_dn \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_get_issuer_dn(const gnutls_x509_crl_t " crl ", char * " buf ", size_t * " sizeof_buf ");" +.SH ARGUMENTS +.IP "const gnutls_x509_crl_t crl" 12 +should contain a gnutls_x509_crl_t structure +.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 RFC2253. 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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..2e033221fc --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_issuer_dn_by_oid.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_issuer_dn_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_issuer_dn_by_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_get_issuer_dn_by_oid(gnutls_x509_crl_t " crl ", const char * " oid ", int " 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 structure +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "int 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 (0) 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 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. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e1faa45a2b --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_next_update.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_next_update" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_next_update \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..209666e436 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_number.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_number" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_number \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 (0) 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1cc9d2b9c1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_raw_issuer_dn.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_raw_issuer_dn" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_raw_issuer_dn \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1bb4b17fda --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_signature.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_signature" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_signature \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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. and a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..d79912a0ba --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_signature_algorithm.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_signature_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_signature_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 structure +.SH " DESCRIPTION" +This function will return a value of the \fBgnutls_sign_algorithm_t\fP +enumeration that is the signature algorithm. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..dfefeef09c --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_this_update.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_this_update" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_this_update \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a4c7abaec8 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_get_version.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_get_version" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_get_version \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crl_import.3 b/doc/manpages/gnutls_x509_crl_import.3 new file mode 100644 index 0000000000..1ce06f0dce --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_import.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_import \- API function +.SH SYNOPSIS +.B #include +.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 structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crl_init.3 b/doc/manpages/gnutls_x509_crl_init.3 new file mode 100644 index 0000000000..44af061ae8 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_init.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_init(gnutls_x509_crl_t * " crl ");" +.SH ARGUMENTS +.IP "gnutls_x509_crl_t * crl" 12 +The structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..6f5302089c --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_list_import.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_list_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_list_import \- API function +.SH SYNOPSIS +.B #include +.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 +The structures to store the parsed CRLs. 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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..cd5c5ab71e --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_list_import2.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_list_import2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_list_import2 \- API function +.SH SYNOPSIS +.B #include +.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 +The structures to store the parsed crl list. Must not be initialized. +.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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crl_print.3 b/doc/manpages/gnutls_x509_crl_print.3 new file mode 100644 index 0000000000..fbcd287133 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_print.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_print" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_print \- API function +.SH SYNOPSIS +.B #include +.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 structure 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 (0) 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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5e7892a519 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_privkey_sign.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_privkey_sign" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_privkey_sign \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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_SHA1 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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..303d097dec --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_authority_key_id.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_authority_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_authority_key_id \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..626569b22e --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_crt.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_crt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_crt \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a373dd0431 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_crt_serial.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_crt_serial" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_crt_serial \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0c4392f828 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_next_update.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_next_update" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_next_update \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "time_t exp_time" 12 +The actual time +.SH " DESCRIPTION" +This function will set the time this CRL will be updated. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..032cb0a368 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_number.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_number" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_number \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..d469046f8c --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_this_update.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_this_update" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_this_update \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..63c23d7949 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_set_version.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_set_version" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_set_version \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crl_sign.3 b/doc/manpages/gnutls_x509_crl_sign.3 new file mode 100644 index 0000000000..c7fb61d8c9 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_sign.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_sign" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_sign \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 +SHA1 as the hash algorithm. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH " DEPRECATED" +Use \fBgnutls_x509_crl_privkey_sign()\fP. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crl_sign2.3 b/doc/manpages/gnutls_x509_crl_sign2.3 new file mode 100644 index 0000000000..98f83738f6 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_sign2.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_sign2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_sign2 \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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_SHA1 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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crl_verify.3 b/doc/manpages/gnutls_x509_crl_verify.3 new file mode 100644 index 0000000000..4abbe02eb4 --- /dev/null +++ b/doc/manpages/gnutls_x509_crl_verify.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crl_verify" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crl_verify \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crl_verify(gnutls_x509_crl_t " crl ", const gnutls_x509_crt_t * " CA_list ", int " CA_list_length ", 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 * CA_list" 12 +is a certificate list that is considered to be trusted one +.IP "int CA_list_length" 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 status. +See \fBgnutls_x509_crt_list_verify()\fP for a detailed description of +return values. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crq_deinit.3 b/doc/manpages/gnutls_x509_crq_deinit.3 new file mode 100644 index 0000000000..bd9a27bfaa --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_deinit.3 @@ -0,0 +1,36 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_x509_crq_deinit(gnutls_x509_crq_t " crq ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will deinitialize a PKCS\fB10\fP certificate request +structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crq_export.3 b/doc/manpages/gnutls_x509_crq_export.3 new file mode 100644 index 0000000000..bba8e81e4e --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_export.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_export \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 +*@output_data_size 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a57b8abddb --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_attribute_by_oid.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_attribute_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_attribute_by_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_attribute_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", int " indx ", void * " buf ", size_t * " sizeof_buf ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP structure +.IP "const char * oid" 12 +holds an Object Identified in (0)\-terminated string +.IP "int indx" 12 +In case multiple same OIDs exist in the attribute list, this +specifies which to send, 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 * sizeof_buf" 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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b0d1a68126 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_attribute_data.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_attribute_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_attribute_data \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_attribute_data(gnutls_x509_crq_t " crq ", int " indx ", void * " data ", size_t * " sizeof_data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP structure +.IP "int indx" 12 +Specifies which attribute 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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b25b1ad22e --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_attribute_info.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_attribute_info" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_attribute_info \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_attribute_info(gnutls_x509_crq_t " crq ", int " indx ", void * " oid ", size_t * " sizeof_oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP structure +.IP "int indx" 12 +Specifies which attribute 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 * 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 +*@sizeof_oid 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..359f9bf3fa --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_basic_constraints.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_basic_constraints" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_basic_constraints \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "unsigned int * critical" 12 +will be non (0) 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1220eae698 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_challenge_password.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_challenge_password" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_challenge_password \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_challenge_password(gnutls_x509_crq_t " crq ", char * " pass ", size_t * " sizeof_pass ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP structure +.IP "char * pass" 12 +will hold a (0)\-terminated password string +.IP "size_t * sizeof_pass" 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c7beb7177d --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_dn.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_dn" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_dn \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_dn(gnutls_x509_crq_t " crq ", char * " buf ", size_t * " sizeof_buf ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP structure +.IP "char * buf" 12 +a pointer to a structure to hold the name (may be \fBNULL\fP) +.IP "size_t * sizeof_buf" 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. +.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. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..f9221a6cff --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_dn_by_oid.3 @@ -0,0 +1,59 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_dn_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_dn_by_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_dn_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", int " indx ", unsigned int " raw_flag ", void * " buf ", size_t * " sizeof_buf ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a gnutls_x509_crq_t structure +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "int 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 (0) 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 * sizeof_buf" 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 *@sizeof_buf will be +updated with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a00fb61875 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_dn_oid.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_dn_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_dn_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_dn_oid(gnutls_x509_crq_t " crq ", int " indx ", void * " oid ", size_t * " sizeof_oid ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a gnutls_x509_crq_t structure +.IP "int indx" 12 +Specifies which DN OID to send. 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 *@sizeof_oid will be +updated with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..398bbb10a1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_extension_by_oid.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_extension_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_extension_by_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_extension_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", int " indx ", void * " buf ", size_t * " sizeof_buf ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP structure +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "int 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 * sizeof_buf" 12 +initially holds the size of \fIbuf\fP +.IP "unsigned int * critical" 12 +will be non (0) 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..d30ee6f04d --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_extension_data.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_extension_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_extension_data \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_extension_data(gnutls_x509_crq_t " crq ", int " indx ", void * " data ", size_t * " sizeof_data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP structure +.IP "int 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 +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..71c0f74e83 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_extension_info.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_extension_info" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_extension_info \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_extension_info(gnutls_x509_crq_t " crq ", int " 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 structure +.IP "int 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 * 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 +*@sizeof_oid 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..deab2f06c0 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_key_id.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_key_id \- API function +.SH SYNOPSIS +.B #include +.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 0 for now +.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 the 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 " SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..9786e3e2fb --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_key_purpose_oid.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_key_purpose_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_key_purpose_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_get_key_purpose_oid(gnutls_x509_crq_t " crq ", int " 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 structure +.IP "int 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 \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 *@sizeof_oid will be +updated with the required size. On success 0 is returned. +.SH " SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..3811a92a56 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_key_rsa_raw.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_key_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_key_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..07811157a6 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_key_usage.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_key_usage" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_key_usage \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "unsigned int * key_usage" 12 +where the key usage bits will be stored +.IP "unsigned int * critical" 12 +will be non (0) 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 +.SH " 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5467ee8d7a --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_pk_algorithm.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_pk_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..168afe332f --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_subject_alt_name.3 @@ -0,0 +1,62 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_subject_alt_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_subject_alt_name \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 (0) 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..50ce75e1a7 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_subject_alt_othername_oid \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a9394c1958 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_get_version.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_get_version" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_get_version \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crq_import.3 b/doc/manpages/gnutls_x509_crq_import.3 new file mode 100644 index 0000000000..410a69d892 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_import.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_import \- API function +.SH SYNOPSIS +.B #include +.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 structure 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 structure. 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crq_init.3 b/doc/manpages/gnutls_x509_crq_init.3 new file mode 100644 index 0000000000..24f26dfcdb --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_init.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_init(gnutls_x509_crq_t * " crq ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t * crq" 12 +The structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crq_print.3 b/doc/manpages/gnutls_x509_crq_print.3 new file mode 100644 index 0000000000..dc53a0b428 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_print.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_print" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_print \- API function +.SH SYNOPSIS +.B #include +.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 structure 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 (0) 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 deallocate 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1e2a178ac1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_privkey_sign.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_privkey_sign" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_privkey_sign \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..98a2c9ba59 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_attribute_by_oid.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_attribute_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_attribute_by_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crq_set_attribute_by_oid(gnutls_x509_crq_t " crq ", const char * " oid ", void * " buf ", size_t " sizeof_buf ");" +.SH ARGUMENTS +.IP "gnutls_x509_crq_t crq" 12 +should contain a \fBgnutls_x509_crq_t\fP structure +.IP "const char * oid" 12 +holds an Object Identified in (0)\-terminated string +.IP "void * buf" 12 +a pointer to a structure that holds the attribute data +.IP "size_t sizeof_buf" 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 attribute must be be DER +encoded. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..d0fe7615b5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_basic_constraints.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_basic_constraints" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_basic_constraints \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ed787f2699 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_challenge_password.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_challenge_password" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_challenge_password \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0fab8d7a93 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_dn_by_oid.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_dn_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_dn_by_oid \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1e13b5826e --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_key.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_key" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_key \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..353665c863 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_key_purpose_oid.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_key_purpose_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_key_purpose_oid \- API function +.SH SYNOPSIS +.B #include +.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 (0)\-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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..87aee8ff27 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_key_rsa_raw.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_key_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_key_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..d69e849b35 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_key_usage.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_key_usage" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_key_usage \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ec96958317 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_pubkey.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_pubkey" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_pubkey \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..24c7653249 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_subject_alt_name.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_subject_alt_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_subject_alt_name \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c529b5a5bd --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_set_version.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_set_version" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_set_version \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crq_sign.3 b/doc/manpages/gnutls_x509_crq_sign.3 new file mode 100644 index 0000000000..a349d3326d --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_sign.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_sign" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_sign \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 SHA1 as the hash algorithm. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH " DEPRECATED" +Use \fBgnutls_x509_crq_privkey_sign()\fP instead. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crq_sign2.3 b/doc/manpages/gnutls_x509_crq_sign2.3 new file mode 100644 index 0000000000..fa6fb9fa0e --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_sign2.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_sign2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_sign2 \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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_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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crq_verify.3 b/doc/manpages/gnutls_x509_crq_verify.3 new file mode 100644 index 0000000000..39530ebb02 --- /dev/null +++ b/doc/manpages/gnutls_x509_crq_verify.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crq_verify" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crq_verify \- API function +.SH SYNOPSIS +.B #include +.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" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, +\fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP if verification failed, otherwise a +negative error value. + +Since 2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ac0114c2f2 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_hostname \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int 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 structure +.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 RFC2818 (HTTPS), which takes into account wildcards, +and the DNSName/IPAddress subject alternative name PKIX extension. +.SH " RETURNS" +non (0) for a successful match, and (0) on failure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1806f84a4e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_check_issuer.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_check_issuer" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_issuer \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int 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. +.SH " RETURNS" +It will return true (1) if the given certificate is issued +by the given issuer, and false (0) if not. A negative error code is +returned in case of an error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..f27165da45 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_check_revocation.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_check_revocation" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_check_revocation \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_check_revocation(gnutls_x509_crt_t " cert ", const gnutls_x509_crl_t * " crl_list ", int " crl_list_length ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.IP "const gnutls_x509_crl_t * crl_list" 12 +should contain a list of gnutls_x509_crl_t structures +.IP "int crl_list_length" 12 +the length of the crl_list +.SH " DESCRIPTION" +This function will return 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0f90d507c9 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_cpy_crl_dist_points.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_cpy_crl_dist_points" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_cpy_crl_dist_points \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_deinit.3 b/doc/manpages/gnutls_x509_crt_deinit.3 new file mode 100644 index 0000000000..5df4ea0b53 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_x509_crt_deinit(gnutls_x509_crt_t " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +The structure to be deinitialized +.SH " DESCRIPTION" +This function will deinitialize a certificate structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_export.3 b/doc/manpages/gnutls_x509_crt_export.3 new file mode 100644 index 0000000000..4c88c4ceb1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_export.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_export \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b6c6ec7acc --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_activation_time.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_activation_time" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_activation_time \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8da4892247 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_authority_info_access.3 @@ -0,0 +1,103 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_authority_info_access" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_authority_info_access \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_authority_info_access(gnutls_x509_crt_t " crt ", unsigned int " seq ", int " what ", gnutls_datum_t * " data ", 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 "int * critical" 12 +pointer to output integer that is set to non\-0 if the extension is marked as critical (may be \fBNULL\fP) +.SH " DESCRIPTION" +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: + + +.SH " AUTHORITYINFOACCESSSYNTAX " +:= +SEQUENCE SIZE (1..MAX) OF AccessDescription +.SH " ACCESSDESCRIPTION " +:= SEQUENCE { +accessMethod OBJECT IDENTIFIER, +accessLocation GeneralName } + + +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 OSCP, or if accessLocation is not of +the "uniformResourceIdentifier" type. + +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. + +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 *@critical. 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.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..7675960037 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_authority_key_id.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_authority_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_authority_key_id \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_authority_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 structure +.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 (0) 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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..2ec62910d4 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_basic_constraints.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_basic_constraints" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_basic_constraints \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "unsigned int * critical" 12 +will be non (0) 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c0bd05d4a3 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_ca_status \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "unsigned int * critical" 12 +will be non (0) 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" +A negative error code may be returned in case of parsing error. +If the certificate does not contain the basicConstraints extension +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP will be returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..37a7f1332d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_crl_dist_points.3 @@ -0,0 +1,63 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_crl_dist_points" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_crl_dist_points \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_crl_dist_points(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ret ", size_t * " ret_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 structure +.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 * ret" 12 +is the place where the distribution point will be copied to +.IP "size_t * ret_size" 12 +holds the size of ret. +.IP "unsigned int * reason_flags" 12 +Revocation reasons flags. +.IP "unsigned int * critical" 12 +will be non (0) 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. + \fIreason_flags\fP should be an ORed sequence of +\fBGNUTLS_CRL_REASON_UNUSED\fP, \fBGNUTLS_CRL_REASON_KEY_COMPROMISE\fP, +\fBGNUTLS_CRL_REASON_CA_COMPROMISE\fP, +\fBGNUTLS_CRL_REASON_AFFILIATION_CHANGED\fP, +\fBGNUTLS_CRL_REASON_SUPERSEEDED\fP, +\fBGNUTLS_CRL_REASON_CESSATION_OF_OPERATION\fP, +\fBGNUTLS_CRL_REASON_CERTIFICATE_HOLD\fP, +\fBGNUTLS_CRL_REASON_PRIVILEGE_WITHDRAWN\fP, +\fBGNUTLS_CRL_REASON_AA_COMPROMISE\fP, or (0) for all possible reasons. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..cbd1208791 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_dn.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_dn" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_dn \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 RFC2253. 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. 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. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..4d69e70009 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_dn_by_oid.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_dn_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_dn_by_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_dn_by_oid(gnutls_x509_crt_t " cert ", const char * " oid ", int " 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 structure +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "int 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 (0) 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 RFC2253. 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 RFC2253 \-\- +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 *buf_size will be updated +with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..51651238f0 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_dn_oid.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_dn_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_dn_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_dn_oid(gnutls_x509_crt_t " cert ", int " indx ", void * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.IP "int 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. If the \fIraw_flag\fP +is not specified the output is always null terminated, although the \fIoid_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 \fIoid_size\fP will be updated +with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c5caa9f26c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_expiration_time.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_expiration_time" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_expiration_time \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..3c682ab312 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_extension_by_oid.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_extension_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_by_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_extension_by_oid(gnutls_x509_crt_t " cert ", const char * " oid ", int " 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 structure +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "int 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 (0) 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..62c98b9bcb --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_extension_data.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_extension_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_data \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_extension_data(gnutls_x509_crt_t " cert ", int " indx ", void * " data ", size_t * " sizeof_data ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.IP "int 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 +certificate. The extension data will be stored as a string 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5e8379ec20 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_info \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_extension_info(gnutls_x509_crt_t " cert ", int " 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 structure +.IP "int 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_data()\fP to extract the data. + +If the buffer provided is not long enough to hold the output, then +*@oid_size 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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..3a3dcfd3c1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_extension_oid.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_extension_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_extension_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_extension_oid(gnutls_x509_crt_t " cert ", int " indx ", void * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.IP "int 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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..cedb7b57b1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_fingerprint.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_fingerprint" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_fingerprint \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..78c1e9ab88 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "gnutls_x509_dn_t * dn" 12 +output variable with pointer to opaque DN +.SH " DESCRIPTION" +Return the Certificate's Issuer DN as an opaque data type. You may +use \fBgnutls_x509_dn_get_rdn_ava()\fP to decode the DN. + +Note that \fIdn\fP should be treated as constant. Because points +into the \fIcert\fP object, you may not deallocate \fIcert\fP +and continue to access \fIdn\fP. +.SH " RETURNS" +Returns 0 on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..657e4ecd5b --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_alt_name.3 @@ -0,0 +1,66 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_alt_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_alt_name \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_issuer_alt_name(gnutls_x509_crt_t " cert ", unsigned int " seq ", 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 structure +.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 * critical" 12 +will be non (0) 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 \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 then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH " SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..28a5f3b01e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_alt_name2.3 @@ -0,0 +1,60 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_alt_name2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_alt_name2 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_issuer_alt_name2(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ret ", size_t * " ret_size ", unsigned int * " ret_type ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.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 type of the alternative name (one of gnutls_x509_subject_alt_name_t). +.IP "unsigned int * critical" 12 +will be non (0) 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 \fIret_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 \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 then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH " SINCE" +2.10.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..41f1f13040 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_alt_othername_oid \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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. If the \fIraw_flag\fP +is not specified the output is always null terminated, although the \fIoid_size\fP will not include the null character. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e142d832f9 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_dn.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_dn" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_dn \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 RFC2253. 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. 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" +GNUTLS_E_SHORT_MEMORY_BUFFER 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..fa852982a1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_dn_by_oid.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_dn_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_dn_by_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_issuer_dn_by_oid(gnutls_x509_crt_t " cert ", const char * " oid ", int " 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 structure +.IP "const char * oid" 12 +holds an Object Identified in null terminated string +.IP "int 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 (0) 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 RFC2253. 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 RFC2253 \-\- +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" +GNUTLS_E_SHORT_MEMORY_BUFFER 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..cd4b342a6d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_dn_oid.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_dn_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_dn_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_issuer_dn_oid(gnutls_x509_crt_t " cert ", int " indx ", void * " oid ", size_t * " oid_size ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.IP "int 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. If the \fIraw_flag\fP +is not specified the output is always null terminated, although the \fIoid_size\fP will not include the null character. +.SH " RETURNS" +GNUTLS_E_SHORT_MEMORY_BUFFER if the provided buffer is not +long enough, and in that case the \fIoid_size\fP will be updated +with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..f71b746533 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_issuer_unique_id.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_issuer_unique_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_issuer_unique_id \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH " SINCE" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..bfbe13ca29 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_key_id.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_key_id \- API function +.SH SYNOPSIS +.B #include +.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 0 for now +.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 the 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0fc61cc644 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_key_purpose_oid.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_key_purpose_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_key_purpose_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_key_purpose_oid(gnutls_x509_crt_t " cert ", int " 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 structure +.IP "int 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. If the \fIraw_flag\fP +is not specified the output is always null terminated, although the \fIoid_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 *oid_size will be updated +with the required size. On success 0 is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..78fc6c0b37 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_key_usage.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_key_usage" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_key_usage \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "unsigned int * key_usage" 12 +where the key usage bits will be stored +.IP "unsigned int * critical" 12 +will be non (0) 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 "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e63181cd5c --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..db24466b42 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_pk_dsa_raw.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_pk_dsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_pk_dsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a0f5c60919 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_pk_rsa_raw.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_pk_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_pk_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..48332b9850 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_preferred_hash_algorithm.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_preferred_hash_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_preferred_hash_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 (0) it means that the algorithm MUST use this hash. May be NULL. +.SH " DESCRIPTION" +This function will read the certifcate 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1bc19f6395 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_proxy.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_proxy" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_proxy \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "unsigned int * critical" 12 +will be non (0) 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..690446cdba --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_raw_dn.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_raw_dn" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_raw_dn \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_raw_dn(gnutls_x509_crt_t " cert ", gnutls_datum_t * " start ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.IP "gnutls_datum_t * start" 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" +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c9e90e300f --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_raw_issuer_dn.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_raw_issuer_dn" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_raw_issuer_dn \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_raw_issuer_dn(gnutls_x509_crt_t " cert ", gnutls_datum_t * " start ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.IP "gnutls_datum_t * start" 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" +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8c9ab59567 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_serial.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_serial" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_serial \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 opaque. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..32cf77aa97 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_signature.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_signature" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_signature \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_signature(gnutls_x509_crt_t " cert ", char * " sig ", size_t * " sizeof_sig ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.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 certificate. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. and a negative error code on error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b3d7edda55 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_signature_algorithm.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_signature_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_signature_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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. +.SH " RETURNS" +a \fBgnutls_sign_algorithm_t\fP value, or a negative error code on +error. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..4b71640a10 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject \- API function +.SH SYNOPSIS +.B #include +.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 structure +.IP "gnutls_x509_dn_t * dn" 12 +output variable with pointer to opaque DN. +.SH " DESCRIPTION" +Return the Certificate's Subject DN as an opaque data type. You +may use \fBgnutls_x509_dn_get_rdn_ava()\fP to decode the DN. + +Note that \fIdn\fP should be treated as constant. Because points +into the \fIcert\fP object, you may not deallocate \fIcert\fP +and continue to access \fIdn\fP. +.SH " RETURNS" +Returns 0 on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ed5911072c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject_alt_name.3 @@ -0,0 +1,63 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject_alt_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_alt_name \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_subject_alt_name(gnutls_x509_crt_t " cert ", unsigned int " seq ", 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 structure +.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 * critical" 12 +will be non (0) 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 \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 then +\fBGNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE\fP is returned. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b164cc72f2 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject_alt_name2.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject_alt_name2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_alt_name2 \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_subject_alt_name2(gnutls_x509_crt_t " cert ", unsigned int " seq ", void * " ret ", size_t * " ret_size ", unsigned int * " ret_type ", unsigned int * " critical ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t cert" 12 +should contain a \fBgnutls_x509_crt_t\fP structure +.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 type of the alternative name (one of gnutls_x509_subject_alt_name_t). +.IP "unsigned int * critical" 12 +will be non (0) 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 \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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..136676401d --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_alt_othername_oid \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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. If the \fIraw_flag\fP +is not specified the output is always null terminated, although the \fIoid_size\fP will not include the null character. +.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 "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..72bb1d9173 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject_key_id.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_key_id \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 (0) 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, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ca57ec44bb --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_subject_unique_id.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_subject_unique_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_subject_unique_id \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +\fBGNUTLS_E_SUCCESS\fP on success, otherwise a negative error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_get_verify_algorithm.3 b/doc/manpages/gnutls_x509_crt_get_verify_algorithm.3 new file mode 100644 index 0000000000..b31dc01031 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_verify_algorithm.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_verify_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_verify_algorithm \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_get_verify_algorithm(gnutls_x509_crt_t " crt ", const gnutls_datum_t * " signature ", gnutls_digest_algorithm_t * " hash ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "const gnutls_datum_t * signature" 12 +contains the signature +.IP "gnutls_digest_algorithm_t * hash" 12 +The result of the call with the hash algorithm used for signature +.SH " DESCRIPTION" +This function will read the certifcate and the signed data to +determine the hash algorithm used to generate the signature. +.SH " DEPRECATED" +Use \fBgnutls_pubkey_get_verify_algorithm()\fP instead. +.SH " RETURNS" +the 0 if the hash algorithm is found. A negative error code is +returned on error. +.SH " SINCE" +2.8.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..81c33d6fb3 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_get_version.3 @@ -0,0 +1,37 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_get_version" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_get_version \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_import.3 b/doc/manpages/gnutls_x509_crt_import.3 new file mode 100644 index 0000000000..e41b4c81c5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_import.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_import \- API function +.SH SYNOPSIS +.B #include +.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 structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..4ed5a3d711 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_import_pkcs11.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_import_pkcs11" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_import_pkcs11 \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_import_pkcs11_url.3 b/doc/manpages/gnutls_x509_crt_import_pkcs11_url.3 new file mode 100644 index 0000000000..a2062f3102 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_import_pkcs11_url.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_import_pkcs11_url" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_import_pkcs11_url \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_import_pkcs11_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 +.SH " DESCRIPTION" +This function will import a PKCS 11 certificate directly from a token +without involving the \fBgnutls_pkcs11_obj_t\fP structure. This function will +fail if the certificate stored is not of X.509 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_init.3 b/doc/manpages/gnutls_x509_crt_init.3 new file mode 100644 index 0000000000..6f60366d82 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_init(gnutls_x509_crt_t * " cert ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t * cert" 12 +The structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..85c617034d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_list_import.3 @@ -0,0 +1,56 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_list_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_list_import \- API function +.SH SYNOPSIS +.B #include +.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 +The structures to store the parsed certificate. 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c507fe82d2 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_list_import2.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_list_import2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_list_import2 \- API function +.SH SYNOPSIS +.B #include +.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 +The structures to store the parsed certificate. Must not be initialized. +.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. They will be automatically initialized. + +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 " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..2147caffe3 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_list_import_pkcs11.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_list_import_pkcs11" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_list_import_pkcs11 \- API function +.SH SYNOPSIS +.B #include +.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 structure. 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5488b8bf7c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_list_verify.3 @@ -0,0 +1,64 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_list_verify" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_list_verify \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_list_verify(const gnutls_x509_crt_t * " cert_list ", int " cert_list_length ", const gnutls_x509_crt_t * " CA_list ", int " CA_list_length ", const gnutls_x509_crl_t * " CRL_list ", int " 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 "int 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 "int 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 "int 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. If no flags are specified (0), this function +will use the basicConstraints (2.5.29.19) PKIX extension. This +means that only a certificate authority is allowed to sign a +certificate. + +You must also 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_print.3 b/doc/manpages/gnutls_x509_crt_print.3 new file mode 100644 index 0000000000..288b61dc85 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_print.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_print" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_print \- API function +.SH SYNOPSIS +.B #include +.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 structure 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 (0) 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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..aa028d22c0 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_privkey_sign.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_privkey_sign" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_privkey_sign \- API function +.SH SYNOPSIS +.B #include +.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_SHA1\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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..6006a8532e --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_activation_time.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_activation_time" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_activation_time \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..50ec0ab75d --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_authority_key_id.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_authority_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_authority_key_id \- API function +.SH SYNOPSIS +.B #include +.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 serial 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..432d2741dc --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_basic_constraints.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_basic_constraints" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_basic_constraints \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..51b690cbec --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_ca_status.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_ca_status" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_ca_status \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..4cf4a75b51 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_crl_dist_points.3 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_crl_dist_points" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_crl_dist_points \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..3966b439bb --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_crl_dist_points2.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_crl_dist_points2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_crl_dist_points2 \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..882a572fdb --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_crq.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_crq" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_crq \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e6cc713732 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_crq_extensions.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_crq_extensions" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_crq_extensions \- API function +.SH SYNOPSIS +.B #include +.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 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..2f89e9dcb5 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_dn_by_oid.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_dn_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_dn_by_oid \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..cd7536b59d --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_expiration_time \- API function +.SH SYNOPSIS +.B #include +.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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e259bde222 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_extension_by_oid.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_extension_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_extension_by_oid \- API function +.SH SYNOPSIS +.B #include +.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 Identified 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 (0) 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..7c87836044 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_issuer_dn_by_oid.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_issuer_dn_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_issuer_dn_by_oid \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5c4dc41488 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_key \- API function +.SH SYNOPSIS +.B #include +.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. Only RSA keys are currently +supported. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5a1f75f55c --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_key_purpose_oid.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_key_purpose_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_key_purpose_oid \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..506e69410b --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_key_usage.3 @@ -0,0 +1,40 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_key_usage" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_key_usage \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ce74c98d54 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_proxy.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_proxy" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_proxy \- API function +.SH SYNOPSIS +.B #include +.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 +opaque 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..37f6832003 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_proxy_dn.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_proxy_dn" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_proxy_dn \- API function +.SH SYNOPSIS +.B #include +.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 structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..18215b7349 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_pubkey.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_pubkey" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_pubkey \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e2b13a6807 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_serial.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_serial" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_serial \- API function +.SH SYNOPSIS +.B #include +.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. +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 +opaque. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1d8e1f3ae1 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_subject_alt_name.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_subject_alt_name" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_subject_alt_name \- API function +.SH SYNOPSIS +.B #include +.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: +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..2f8dd868cc --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_subject_alternative_name \- API function +.SH SYNOPSIS +.B #include +.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 incosistent with +\fBgnutls_x509_crt_get_subject_alt_name()\fP. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a5e86abf7a --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_subject_key_id.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_subject_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_subject_key_id \- API function +.SH SYNOPSIS +.B #include +.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 serial 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8e98db4eab --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_set_version.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_set_version" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_set_version \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_sign.3 b/doc/manpages/gnutls_x509_crt_sign.3 new file mode 100644 index 0000000000..703a28b57f --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_sign \- API function +.SH SYNOPSIS +.B #include +.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 SHA1 as 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_sign2.3 b/doc/manpages/gnutls_x509_crt_sign2.3 new file mode 100644 index 0000000000..60cfc67179 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_sign2.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_sign2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_sign2 \- API function +.SH SYNOPSIS +.B #include +.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_SHA1\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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_verify.3 b/doc/manpages/gnutls_x509_crt_verify.3 new file mode 100644 index 0000000000..8116c86061 --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_verify.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_verify" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_verify \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_verify(gnutls_x509_crt_t " cert ", const gnutls_x509_crt_t * " CA_list ", int " 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 "int 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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_verify_data.3 b/doc/manpages/gnutls_x509_crt_verify_data.3 new file mode 100644 index 0000000000..13e601bcdb --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_verify_data.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_verify_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_verify_data \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_verify_data(gnutls_x509_crt_t " crt ", 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 +.IP "unsigned int flags" 12 +should be 0 for now +.IP "const gnutls_datum_t * data" 12 +holds the data to be signed +.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. + +Deprecated. Please use \fBgnutls_pubkey_verify_data()\fP. +.SH " RETURNS" +In case of a verification failure \fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP +is returned, and a positive code on success. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_crt_verify_hash.3 b/doc/manpages/gnutls_x509_crt_verify_hash.3 new file mode 100644 index 0000000000..a5ed94caeb --- /dev/null +++ b/doc/manpages/gnutls_x509_crt_verify_hash.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_crt_verify_hash" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_crt_verify_hash \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_crt_verify_hash(gnutls_x509_crt_t " crt ", unsigned int " flags ", const gnutls_datum_t * " hash ", const gnutls_datum_t * " signature ");" +.SH ARGUMENTS +.IP "gnutls_x509_crt_t crt" 12 +Holds the certificate +.IP "unsigned int flags" 12 +should be 0 for now +.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 certificate. + +Deprecated. Please use \fBgnutls_pubkey_verify_data()\fP. +.SH " RETURNS" +In case of a verification failure \fBGNUTLS_E_PK_SIG_VERIFY_FAILED\fP +is returned, and a positive code on success. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_dn_deinit.3 b/doc/manpages/gnutls_x509_dn_deinit.3 new file mode 100644 index 0000000000..e2ba4d5f85 --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_deinit.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_x509_dn_deinit(gnutls_x509_dn_t " dn ");" +.SH ARGUMENTS +.IP "gnutls_x509_dn_t dn" 12 +a DN opaque 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_dn_export.3 b/doc/manpages/gnutls_x509_dn_export.3 new file mode 100644 index 0000000000..f2a55d52e2 --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_export.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_export \- API function +.SH SYNOPSIS +.B #include +.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 opaque 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 +*@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 NAME". +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..2e6bc9bc0e --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_get_rdn_ava.3 @@ -0,0 +1,48 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_get_rdn_ava" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_get_rdn_ava \- API function +.SH SYNOPSIS +.B #include +.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 +input variable with opaque DN pointer +.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. + +Note that \fIava\fP will contain pointers into the \fIdn\fP structure, so you +should not modify any data or deallocate it. Note also that the DN +in turn points into the original certificate structure, and thus +you may not deallocate the certificate and continue to access \fIdn\fP. +.SH " RETURNS" +Returns 0 on success, or an error code. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_dn_import.3 b/doc/manpages/gnutls_x509_dn_import.3 new file mode 100644 index 0000000000..17bb6b85bc --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_import.3 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_import" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_import \- API function +.SH SYNOPSIS +.B #include +.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 structure. The structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_dn_init.3 b/doc/manpages/gnutls_x509_dn_init.3 new file mode 100644 index 0000000000..a9aaec6542 --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_init.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_init \- API function +.SH SYNOPSIS +.B #include +.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 structure. + +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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e99701b11f --- /dev/null +++ b/doc/manpages/gnutls_x509_dn_oid_known.3 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_dn_oid_known" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_dn_oid_known \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_privkey_cpy.3 b/doc/manpages/gnutls_x509_privkey_cpy.3 new file mode 100644 index 0000000000..f950f519a5 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_cpy.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_cpy" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_cpy \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_privkey_deinit.3 b/doc/manpages/gnutls_x509_privkey_deinit.3 new file mode 100644 index 0000000000..88fb43f93a --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_deinit.3 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_deinit \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "void gnutls_x509_privkey_deinit(gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +The structure to be deinitialized +.SH " DESCRIPTION" +This function will deinitialize a private key structure. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_privkey_export.3 b/doc/manpages/gnutls_x509_privkey_export.3 new file mode 100644 index 0000000000..8726d9bf05 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export \- API function +.SH SYNOPSIS +.B #include +.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 PKCS1 structure for +RSA keys, or an integer sequence for DSA keys. The DSA keys are in +the same format with the parameters used by openssl. + +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 RSA PRIVATE KEY". +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..0f07676192 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_dsa_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_dsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_dsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 structure that holds the DSA parameters +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..25e65ed24a --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_ecc_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_ecc_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_ecc_raw \- API function +.SH SYNOPSIS +.B #include +.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 structure that holds the rsa parameters +.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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a2ad292a1f --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_pkcs8.3 @@ -0,0 +1,63 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_pkcs8" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_pkcs8 \- API function +.SH SYNOPSIS +.B #include +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..cd4a5f09ad --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_rsa_raw.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 structure that holds the rsa parameters +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..98add7ea68 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_export_rsa_raw2.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_export_rsa_raw2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_export_rsa_raw2 \- API function +.SH SYNOPSIS +.B #include +.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 structure that holds the rsa parameters +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_privkey_fix.3 b/doc/manpages/gnutls_x509_privkey_fix.3 new file mode 100644 index 0000000000..38332b31e7 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_fix.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_fix" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_fix \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_privkey_fix(gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +Holds the 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_privkey_generate.3 b/doc/manpages/gnutls_x509_privkey_generate.3 new file mode 100644 index 0000000000..ec70483fac --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_generate.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_generate" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_generate \- API function +.SH SYNOPSIS +.B #include +.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 +should contain a \fBgnutls_x509_privkey_t\fP structure +.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 +unused for now. Must be 0. +.SH " DESCRIPTION" +This function will generate a random private key. Note that this +function must be called on an empty private key. + +Do not set the number of bits directly, use \fBgnutls_sec_param_to_pk_bits()\fP. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..39357edf2b --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_get_key_id.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_get_key_id" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_get_key_id \- API function +.SH SYNOPSIS +.B #include +.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 +Holds the key +.IP "unsigned int flags" 12 +should be 0 for now +.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 the 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 +*@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" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b318444834 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_get_pk_algorithm.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_get_pk_algorithm" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_get_pk_algorithm \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_privkey_import.3 b/doc/manpages/gnutls_x509_privkey_import.3 new file mode 100644 index 0000000000..0596a1b9da --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import \- API function +.SH SYNOPSIS +.B #include +.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 structure 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 of "RSA PRIVATE +KEY", or "DSA PRIVATE KEY". +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..16fd4f4da7 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_dsa_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_dsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_dsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 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 +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1c8340c672 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_ecc_raw.3 @@ -0,0 +1,50 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_ecc_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_ecc_raw \- API function +.SH SYNOPSIS +.B #include +.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 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 +.IP "const gnutls_datum_t * y" 12 +holds the y +.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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..3635b58866 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_pkcs8.3 @@ -0,0 +1,58 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_pkcs8" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_pkcs8 \- API function +.SH SYNOPSIS +.B #include +.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 structure 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. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..8d01714cf9 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_rsa_raw.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_rsa_raw" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_rsa_raw \- API function +.SH SYNOPSIS +.B #include +.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 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 +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..dc107eebf1 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_import_rsa_raw2.3 @@ -0,0 +1,55 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_import_rsa_raw2" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_import_rsa_raw2 \- API function +.SH SYNOPSIS +.B #include +.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 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 +.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 +.IP "const gnutls_datum_t * e1" 12 +holds e1 = d mod (p\-1) +.IP "const gnutls_datum_t * e2" 12 +holds e2 = d mod (q\-1) +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_privkey_init.3 b/doc/manpages/gnutls_x509_privkey_init.3 new file mode 100644 index 0000000000..1267e415c8 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_init.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_init \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_privkey_init(gnutls_x509_privkey_t * " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t * key" 12 +The structure to be initialized +.SH " DESCRIPTION" +This function will initialize an private key structure. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..5f0f51be73 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_sec_param.3 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_sec_param" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_sec_param \- API function +.SH SYNOPSIS +.B #include +.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 structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ffa056f237 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_sign_data.3 @@ -0,0 +1,61 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_sign_data" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_sign_data \- API function +.SH SYNOPSIS +.B #include +.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 +Holds the key +.IP "gnutls_digest_algorithm_t digest" 12 +should be MD5 or SHA1 +.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 +*@signature_size 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 " DEPRECATED" +Use \fBgnutls_privkey_sign_data()\fP. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..6d55f6f051 --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_sign_hash.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_sign_hash" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_sign_hash \- API function +.SH SYNOPSIS +.B #include +.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 +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 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). +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a +negative error value. +.SH " DEPRECATED IN" +2.12.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..ea37d80b9e --- /dev/null +++ b/doc/manpages/gnutls_x509_privkey_verify_params.3 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_privkey_verify_params" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_privkey_verify_params \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_privkey_verify_params(gnutls_x509_privkey_t " key ");" +.SH ARGUMENTS +.IP "gnutls_x509_privkey_t key" 12 +should contain a \fBgnutls_x509_privkey_t\fP structure +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/manpages/gnutls_x509_rdn_get.3 b/doc/manpages/gnutls_x509_rdn_get.3 new file mode 100644 index 0000000000..b0cb11fc5a --- /dev/null +++ b/doc/manpages/gnutls_x509_rdn_get.3 @@ -0,0 +1,46 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_rdn_get" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_rdn_get \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_rdn_get(const gnutls_datum_t * " idn ", char * " buf ", size_t * " sizeof_buf ");" +.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 * sizeof_buf" 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 +RFC2253. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned and *@sizeof_buf is +updated if the provided buffer is not long enough, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..913cda774b --- /dev/null +++ b/doc/manpages/gnutls_x509_rdn_get_by_oid.3 @@ -0,0 +1,53 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_rdn_get_by_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_rdn_get_by_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_rdn_get_by_oid(const gnutls_datum_t * " idn ", const char * " oid ", int " indx ", unsigned int " raw_flag ", void * " buf ", size_t * " sizeof_buf ");" +.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 "int 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 (0) 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 * sizeof_buf" 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 RFC2253. +.SH " RETURNS" +On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or +\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP is returned and *@sizeof_buf is +updated if the provided buffer is not long enough, otherwise a +negative error value. +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..7243910f4b --- /dev/null +++ b/doc/manpages/gnutls_x509_rdn_get_oid.3 @@ -0,0 +1,49 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_rdn_get_oid" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_rdn_get_oid \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_rdn_get_oid(const gnutls_datum_t * " idn ", int " indx ", void * " buf ", size_t * " sizeof_buf ");" +.SH ARGUMENTS +.IP "const gnutls_datum_t * idn" 12 +should contain a DER encoded RDN sequence +.IP "int 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 * sizeof_buf" 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 *@sizeof_buf 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..26b786ab2e --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_add_cas.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_add_cas" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_cas \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_trust_list_add_cas(gnutls_x509_trust_list_t " list ", const gnutls_x509_crt_t * " clist ", int " clist_size ", unsigned int " flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The structure of the list +.IP "const gnutls_x509_crt_t * clist" 12 +A list of CAs +.IP "int clist_size" 12 +The length of the CA list +.IP "unsigned int flags" 12 +should be 0. +.SH " DESCRIPTION" +This function will add the given certificate authorities +to the trusted list. The list of CAs must not be deinitialized +during this structure's lifetime. +.SH " RETURNS" +The number of added elements is returned. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..e586e0e6e8 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_add_crls.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_add_crls" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_crls \- API function +.SH SYNOPSIS +.B #include +.sp +.BI "int gnutls_x509_trust_list_add_crls(gnutls_x509_trust_list_t " list ", const gnutls_x509_crl_t * " crl_list ", int " crl_size ", unsigned int " flags ", unsigned int " verification_flags ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The structure of the list +.IP "const gnutls_x509_crl_t * crl_list" 12 +A list of CRLs +.IP "int crl_size" 12 +The length of the CRL list +.IP "unsigned int flags" 12 +if GNUTLS_TL_VERIFY_CRL is given the CRLs will be verified before being added. +.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 list of CRLs must not be deinitialized +during this structure's lifetime. + +This function must be called after \fBgnutls_x509_trust_list_add_cas()\fP +to allow verifying the CRLs for validity. +.SH " RETURNS" +The number of added elements is returned. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..c8cbb6b4a2 --- /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.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_add_named_crt \- API function +.SH SYNOPSIS +.B #include +.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 structure of 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 only with \fBgnutls_x509_trust_list_verify_named_crt()\fP. + +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 must not be deinitialized during the lifetime +of the trusted list. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..4420aa974f --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_deinit.3 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_deinit" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_deinit \- API function +.SH SYNOPSIS +.B #include +.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 structure to be deinitialized +.IP "unsigned int all" 12 +if non\-(0) it will deinitialize all the certificates and CRLs contained in the structure. +.SH " DESCRIPTION" +This function will deinitialize a trust list. +.SH " SINCE" +3.0.0 +.SH "REPORTING BUGS" +Report bugs to . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..1c7acd0a9d --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_get_issuer.3 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_get_issuer" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_get_issuer \- API function +.SH SYNOPSIS +.B #include +.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 structure of 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. +.IP "unsigned int flags" 12 +Use (0). +.SH " DESCRIPTION" +This function will attempt to find the issuer of the +given certificate. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..fad24d7a5f --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_init.3 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_init" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_init \- API function +.SH SYNOPSIS +.B #include +.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 +The structure 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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..a47b282c24 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_verify_crt.3 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_verify_crt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_verify_crt \- API function +.SH SYNOPSIS +.B #include +.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 * " verify ", gnutls_verify_output_function " func ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The structure of 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 * verify" 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. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. 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 0000000000..b9f6805ad9 --- /dev/null +++ b/doc/manpages/gnutls_x509_trust_list_verify_named_crt.3 @@ -0,0 +1,54 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_x509_trust_list_verify_named_crt" 3 "3.0.8" "gnutls" "gnutls" +.SH NAME +gnutls_x509_trust_list_verify_named_crt \- API function +.SH SYNOPSIS +.B #include +.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 * " verify ", gnutls_verify_output_function " func ");" +.SH ARGUMENTS +.IP "gnutls_x509_trust_list_t list" 12 +The structure of 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 * verify" 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 matching named certificate. If a +match is found the certificate is considered valid. In addition to that +this function will also check CRLs. +.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 . +GnuTLS home page: http://www.gnu.org/software/gnutls/ +General help using GNU software: http://www.gnu.org/gethelp/ +.SH COPYRIGHT +Copyright \(co 2011 Free Software Foundation. +.br +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. +.SH "SEE ALSO" +The full documentation for +.B gnutls +is maintained as a Texinfo manual. If the +.B info +and +.B gnutls +programs are properly installed at your site, the command +.IP +.B info gnutls +.PP +should give you access to the complete manual. diff --git a/doc/scripts/getfuncs.pl b/doc/scripts/getfuncs.pl new file mode 100755 index 0000000000..08518ee17f --- /dev/null +++ b/doc/scripts/getfuncs.pl @@ -0,0 +1,31 @@ +eval '(exit $?0)' && eval 'exec perl -wST "$0" ${1+"$@"}' + & eval 'exec perl -wST "$0" $argv:q' + if 0; + +# given a header file in stdin it will print all functions + +my $line; +my $func; + +while ($line=) { + + if ($line !~ m/typedef/ && $line !~ m/Copyright/) { + $func = ''; + if ($line =~ m/^\s*\w+[\s\*]+([A-Za-z0-9_]+)\s*\(.*/) { + $func = $1; + } + + if ($line =~ m/^\s*\w+\s+\w+[\s\*]+([A-Za-z0-9_]+)\s*\(.*/) { + $func = $1; + } + + if ($line =~ m/^[\s\*]*([A-Za-z0-9_]+)\s*\(.*/) { + $func = $1; + } + + if ($func ne '' && $func =~ m/gnutls_.*/) { + print $func . "\n"; + } + } + +} diff --git a/lib/gnutls_cert.c b/lib/gnutls_cert.c index 802f671672..75638b93f9 100644 --- a/lib/gnutls_cert.c +++ b/lib/gnutls_cert.c @@ -790,7 +790,7 @@ gnutls_certificate_activation_time_peers (gnutls_session_t session) * can be used to store application-specific data needed in the * callback function. See also gnutls_sign_callback_get(). * - * Deprecated: Use the PKCS 11 or #gnutls_privkey_t interfacess instead. + * Deprecated: Use the PKCS 11 or #gnutls_privkey_t interfacess like gnutls_privkey_import_ext() instead. */ void gnutls_sign_callback_set (gnutls_session_t session, diff --git a/lib/gnutls_str.c b/lib/gnutls_str.c index c668b08fe4..f4910df270 100644 --- a/lib/gnutls_str.c +++ b/lib/gnutls_str.c @@ -465,8 +465,8 @@ _gnutls_bin2hex (const void *_old, size_t oldlen, * @hex_data: string with data in hex format * @hex_size: size of hex data * @bin_data: output array with binary data - * @bin_size: when calling *@bin_size should hold size of @bin_data, - * on return will hold actual size of @bin_data. + * @bin_size: when calling should hold maximum size of @bin_data, + * on return will hold actual length of @bin_data. * * Convert a buffer with hex data to binary data. *