From 69b2acc470da85d0364effd9584b4ceea18e8f2d Mon Sep 17 00:00:00 2001 From: Nikos Mavrogiannopoulos Date: Tue, 25 Sep 2018 14:12:26 +0200 Subject: tests: removed unused file Signed-off-by: Nikos Mavrogiannopoulos --- tests/mini-x509-default-prio.c | 273 ----------------------------------------- 1 file changed, 273 deletions(-) delete mode 100644 tests/mini-x509-default-prio.c diff --git a/tests/mini-x509-default-prio.c b/tests/mini-x509-default-prio.c deleted file mode 100644 index 81f2611c8b..0000000000 --- a/tests/mini-x509-default-prio.c +++ /dev/null @@ -1,273 +0,0 @@ -/* - * Copyright (C) 2008-2012 Free Software Foundation, Inc. - * - * Author: Simon Josefsson - * - * This file is part of GnuTLS. - * - * GnuTLS is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 3 of the License, or - * (at your option) any later version. - * - * GnuTLS is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with GnuTLS; if not, write to the Free Software Foundation, - * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - */ - -#ifdef HAVE_CONFIG_H -#include -#endif - -#include -#include -#include -#include -#include -#include "utils.h" -#include "eagain-common.h" - -const char *side; - -static void tls_log_func(int level, const char *str) -{ - fprintf(stderr, "%s|<%d>| %s", side, level, str); -} - -static unsigned char ca_cert_pem[] = -"-----BEGIN CERTIFICATE-----\n" -"MIIC4DCCAcigAwIBAgIBADANBgkqhkiG9w0BAQsFADAPMQ0wCwYDVQQDEwRDQS0w\n" -"MCIYDzIwMTQwNDA0MTk1OTA1WhgPOTk5OTEyMzEyMzU5NTlaMA8xDTALBgNVBAMT\n" -"BENBLTAwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQD46JAPKrTsNTHl\n" -"zD06eIYBF/8Z+TR0wukp9Cdh8Sw77dODLjy/QrVKiDgDZZdyUc8Agsdr86i95O0p\n" -"w19Np3a0wja0VC9uwppZrpuHsrWukwxIBXoViyBc20Y6Ce8j0scCbR10SP565qXC\n" -"i8vr86S4xmQMRZMtwohP/GWQzt45jqkHPYHjdKzwo2b2XI7joDq0dvbr3MSONkGs\n" -"z7A/1Bl3iH5keDTWjqpJRWqXE79IhGOhELy+gG4VLJDGHWCr2mq24b9Kirp+TTxl\n" -"lUwJRbchqUqerlFdt1NgDoGaJyd73Sh0qcZzmEiOI2hGvBtG86tdQ6veC9dl05et\n" -"pM+6RMABAgMBAAGjQzBBMA8GA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAwcE\n" -"ADAdBgNVHQ4EFgQUGD0RYr2H7kfjQUcBMxSTCDQnhu0wDQYJKoZIhvcNAQELBQAD\n" -"ggEBALnHMubZ6WJ/XOFyDuo0imwg2onrPas3MuKT4+y0aHY943BgAOEc3jKitRjc\n" -"qhb0IUD+NS7itRwNtCgI3v5Ym5nnQoVk+aOD/D724TjJ9XaPQJzOnuGaZX99VN2F\n" -"sgwAtDXedlDQ+I6KLzLd6VW+UyWTG4qiRjOGDnG2kM1wAEOM27TzHV/YWleGjhtA\n" -"bRHxkioOni5goNlTzazxF4v9VD2uinWrIFyZmF6vQuMm6rKFgq6higAU8uesFo7+\n" -"3qpeRjNrPC4fNJUBvv+PC0WnP0PLnD/rY/ZcTYjLb/vJp1fiMJ5fU7jJklBhX2TE\n" -"tstcP7FUV5HA/s9BxgAh0Z2wyyY=\n" -"-----END CERTIFICATE-----\n"; - -const gnutls_datum_t ca_cert = { ca_cert_pem, - sizeof(ca_cert_pem) -}; - -static unsigned char server_cert_pem[] = -"-----BEGIN CERTIFICATE-----\n" -"MIIDIzCCAgugAwIBAgIMUz8PCR2sdRK56V6OMA0GCSqGSIb3DQEBCwUAMA8xDTAL\n" -"BgNVBAMTBENBLTEwIhgPMjAxNDA0MDQxOTU5MDVaGA85OTk5MTIzMTIzNTk1OVow\n" -"EzERMA8GA1UEAxMIc2VydmVyLTIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK\n" -"AoIBAQDZ3dCzh9gOTOiOb2dtrPu91fYYgC/ey0ACYjQxaru7FZwnuXPhQK9KHsIV\n" -"YRIyo49wjKZddkHet2sbpFAAeETZh8UUWLRb/mupyaSJMycaYCNjLZCUJTztvXxJ\n" -"CCNfbtgvKC+Vu1mu94KBPatslgvnsamH7AiL5wmwRRqdH/Z93XaEvuRG6Zk0Sh9q\n" -"ZMdCboGfjtmGEJ1V+z5CR+IyH4sckzd8WJW6wBSEwgliGaXnc75xKtFWBZV2njNr\n" -"8V1TOYOdLEbiF4wduVExL5TKq2ywNkRpUfK2I1BcWS5D9Te/QT7aSdE08rL6ztmZ\n" -"IhILSrMOfoLnJ4lzXspz3XLlEuhnAgMBAAGjdzB1MAwGA1UdEwEB/wQCMAAwFAYD\n" -"VR0RBA0wC4IJbG9jYWxob3N0MA8GA1UdDwEB/wQFAwMHoAAwHQYDVR0OBBYEFJXR\n" -"raRS5MVhEqaRE42A3S2BIj7UMB8GA1UdIwQYMBaAFP6S7AyMRO2RfkANgo8YsCl8\n" -"JfJkMA0GCSqGSIb3DQEBCwUAA4IBAQCQ62+skMVZYrGbpab8RI9IG6xH8kEndvFj\n" -"J7wBBZCOlcjOj+HQ7a2buF5zGKRwAOSznKcmvZ7l5DPdsd0t5/VT9LKSbQ6+CfGr\n" -"Xs5qPaDJnRhZkOILCvXJ9qyO+79WNMsg9pWnxkTK7aWR5OYE+1Qw1jG681HMkWTm\n" -"nt7et9bdiNNpvA+L55569XKbdtJLs3hn5gEQFgS7EaEj59aC4vzSTFcidowCoa43\n" -"7JmfSfC9YaAIFH2vriyU0QNf2y7cG5Hpkge+U7uMzQrsT77Q3SDB9WkyPAFNSB4Q\n" -"B/r+OtZXOnQhLlMV7h4XGlWruFEaOBVjFHSdMGUh+DtaLvd1bVXI\n" -"-----END CERTIFICATE-----\n" -"-----BEGIN CERTIFICATE-----\n" -"MIIDATCCAemgAwIBAgIBATANBgkqhkiG9w0BAQsFADAPMQ0wCwYDVQQDEwRDQS0w\n" -"MCIYDzIwMTQwNDA0MTk1OTA1WhgPOTk5OTEyMzEyMzU5NTlaMA8xDTALBgNVBAMT\n" -"BENBLTEwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDvhyQfsUm3T0xK\n" -"jiBXO3H6Y27b7lmCRYZQCmXCl2sUsGDL7V9biavTt3+sorWtH542/cTGDh5n8591\n" -"7rVxAB/VASmN55O3fjZyFGrjusjhXBla0Yxe5rZ/7/Pjrq84T7gc/IXiX9Sums/c\n" -"o9AeoykfhsjV2ubhh4h+8uPsHDTcAFTxq3mQaoldwnW2nmjDFzaKLtQdnyFf41o6\n" -"nsJCK/J9PtpdCID5Zb+eQfu5Yhk1iUHe8a9TOstCHtgBq61YzufDHUQk3zsT+VZM\n" -"20lDvSBnHdWLjxoea587JbkvtH8xRR8ThwABSb98qPnhJ8+A7mpO89QO1wxZM85A\n" -"xEweQlMHAgMBAAGjZDBiMA8GA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAwcE\n" -"ADAdBgNVHQ4EFgQU/pLsDIxE7ZF+QA2CjxiwKXwl8mQwHwYDVR0jBBgwFoAUGD0R\n" -"Yr2H7kfjQUcBMxSTCDQnhu0wDQYJKoZIhvcNAQELBQADggEBANEXLUV+Z1PGTn7M\n" -"3rPT/m/EamcrZJ3vFWrnfN91ws5llyRUKNhx6222HECh3xRSxH9YJONsbv2zY6sd\n" -"ztY7lvckL4xOgWAjoCVTx3hqbZjDxpLRsvraw1PlqBHlRQVWLKlEQ55+tId2zgMX\n" -"Z+wxM7FlU/6yWVPODIxrqYQd2KqaEp4aLIklw6Hi4HD6DnQJikjsJ6Noe0qyX1Tx\n" -"uZ8mgP/G47Fe2d2H29kJ1iJ6hp1XOqyWrVIh/jONcnTvWS8aMqS3MU0EJH2Pb1Qa\n" -"KGIvbd/3H9LykFTP/b7Imdv2fZxXIK8jC+jbF1w6rdBCVNA0p30X/jonoC3vynEK\n" -"5cK0cgs=\n" -"-----END CERTIFICATE-----\n"; - -const gnutls_datum_t server_cert = { server_cert_pem, - sizeof(server_cert_pem) -}; - -static unsigned char server_key_pem[] = -"-----BEGIN RSA PRIVATE KEY-----\n" -"MIIEpQIBAAKCAQEA2d3Qs4fYDkzojm9nbaz7vdX2GIAv3stAAmI0MWq7uxWcJ7lz\n" -"4UCvSh7CFWESMqOPcIymXXZB3rdrG6RQAHhE2YfFFFi0W/5rqcmkiTMnGmAjYy2Q\n" -"lCU87b18SQgjX27YLygvlbtZrveCgT2rbJYL57Gph+wIi+cJsEUanR/2fd12hL7k\n" -"RumZNEofamTHQm6Bn47ZhhCdVfs+QkfiMh+LHJM3fFiVusAUhMIJYhml53O+cSrR\n" -"VgWVdp4za/FdUzmDnSxG4heMHblRMS+UyqtssDZEaVHytiNQXFkuQ/U3v0E+2knR\n" -"NPKy+s7ZmSISC0qzDn6C5yeJc17Kc91y5RLoZwIDAQABAoIBAQCRXAu5HPOsZufq\n" -"0K2DYZz9BdqSckR+M8HbVUZZiksDAeIUJwoHyi6qF2eK+B86JiK4Bz+gsBw2ys3t\n" -"vW2bQqM9N/boIl8D2fZfbCgZWkXGtUonC+mgzk+el4Rq/cEMFVqr6/YDwuKNeJpc\n" -"PJc5dcsvpTvlcjgpj9bJAvJEz2SYiIUpvtG4WNMGGapVZZPDvWn4/isY+75T5oDf\n" -"1X5jG0lN9uoUjcuGuThN7gxjwlRkcvEOPHjXc6rxfrWIDdiz/91V46PwpqVDpRrg\n" -"ig6U7+ckS0Oy2v32x0DaDhwAfDJ2RNc9az6Z+11lmY3LPkjG/p8Klcmgvt4/lwkD\n" -"OYRC5QGRAoGBAPFdud6nmVt9h1DL0o4R6snm6P3K81Ds765VWVmpzJkK3+bwe4PQ\n" -"GQQ0I0zN4hXkDMwHETS+EVWllqkK/d4dsE3volYtyTti8zthIATlgSEJ81x/ChAQ\n" -"vvXxgx+zPUnb1mUwy+X+6urTHe4bxN2ypg6ROIUmT+Hx1ITG40LRRiPTAoGBAOcT\n" -"WR8DTrj42xbxAUpz9vxJ15ZMwuIpk3ShE6+CWqvaXHF22Ju4WFwRNlW2zVLH6UMt\n" -"nNfOzyDoryoiu0+0mg0wSmgdJbtCSHoI2GeiAnjGn5i8flQlPQ8bdwwmU6g6I/EU\n" -"QRbGK/2XLmlrGN52gVy9UX0NsAA5fEOsAJiFj1CdAoGBAN9i3nbq6O2bNVSa/8mL\n" -"XaD1vGe/oQgh8gaIaYSpuXlfbjCAG+C4BZ81XgJkfj3CbfGbDNqimsqI0fKsAJ/F\n" -"HHpVMgrOn3L+Np2bW5YMj0Fzwy+1SCvsQ8C+gJwjOLMV6syGp/+6udMSB55rRv3k\n" -"rPnIf+YDumUke4tTw9wAcgkPAoGASHMkiji7QfuklbjSsslRMyDj21gN8mMevH6U\n" -"cX7pduBsA5dDqu9NpPAwnQdHsSDE3i868d8BykuqQAfLut3hPylY6vPYlLHfj4Oe\n" -"dj+xjrSX7YeMBE34qvfth32s1R4FjtzO25keyc/Q2XSew4FcZftlxVO5Txi3AXC4\n" -"bxnRKXECgYEAva+og7/rK+ZjboJVNxhFrwHp9bXhz4tzrUaWNvJD2vKJ5ZcThHcX\n" -"zCig8W7eXHLPLDhi9aWZ3kUZ1RLhrFc/6dujtVtU9z2w1tmn1I+4Zi6D6L4DzKdg\n" -"nMRLFoXufs/qoaJTqa8sQvKa+ceJAF04+gGtw617cuaZdZ3SYRLR2dk=\n" -"-----END RSA PRIVATE KEY-----\n"; - -const gnutls_datum_t server_key = { server_key_pem, - sizeof(server_key_pem) -}; - -void doit(void) -{ - int ret; - /* Server stuff. */ - gnutls_certificate_credentials_t serverx509cred; - gnutls_session_t server; - int sret = GNUTLS_E_AGAIN; - /* Client stuff. */ - gnutls_certificate_credentials_t clientx509cred; - gnutls_session_t client; - int cret = GNUTLS_E_AGAIN; - - /* General init. */ - global_init(); - gnutls_global_set_log_function(tls_log_func); - if (debug) - gnutls_global_set_log_level(6); - - /* Init server */ - gnutls_certificate_allocate_credentials(&serverx509cred); - gnutls_certificate_set_x509_key_mem(serverx509cred, - &server_cert, &server_key, - GNUTLS_X509_FMT_PEM); - - gnutls_init(&server, GNUTLS_SERVER); - gnutls_credentials_set(server, GNUTLS_CRD_CERTIFICATE, - serverx509cred); - ret = gnutls_set_default_priority(server); - if (ret < 0) - exit(1); - - gnutls_transport_set_push_function(server, server_push); - gnutls_transport_set_pull_function(server, server_pull); - gnutls_transport_set_ptr(server, server); - - /* Init client */ - ret = gnutls_certificate_allocate_credentials(&clientx509cred); - if (ret < 0) - exit(1); - - ret = gnutls_certificate_set_x509_trust_mem(clientx509cred, &ca_cert, GNUTLS_X509_FMT_PEM); - if (ret < 0) - exit(1); - - ret = gnutls_init(&client, GNUTLS_CLIENT); - if (ret < 0) - exit(1); - - ret = gnutls_credentials_set(client, GNUTLS_CRD_CERTIFICATE, - clientx509cred); - if (ret < 0) - exit(1); - - ret = gnutls_set_default_priority(client); - if (ret < 0) - exit(1); - - gnutls_transport_set_push_function(client, client_push); - gnutls_transport_set_pull_function(client, client_pull); - gnutls_transport_set_ptr(client, client); - - HANDSHAKE(client, server); - - /* check gnutls_certificate_get_ours() - client side */ - { - const gnutls_datum_t *mcert; - - mcert = gnutls_certificate_get_ours(client); - if (mcert != NULL) { - fail("gnutls_certificate_get_ours(): failed\n"); - exit(1); - } - } - - /* check the number of certificates received */ - { - unsigned cert_list_size = 0; - gnutls_typed_vdata_st data[2]; - unsigned status; - - memset(data, 0, sizeof(data)); - - data[0].type = GNUTLS_DT_DNS_HOSTNAME; - data[0].data = (void*)"localhost1"; - - data[1].type = GNUTLS_DT_KEY_PURPOSE_OID; - data[1].data = (void*)GNUTLS_KP_TLS_WWW_SERVER; - - gnutls_certificate_get_peers(client, &cert_list_size); - if (cert_list_size < 2) { - fprintf(stderr, "received a certificate list of %d!\n", cert_list_size); - exit(1); - } - - ret = gnutls_certificate_verify_peers(client, data, 2, &status); - if (ret < 0) { - fprintf(stderr, "could not verify certificate: %s\n", gnutls_strerror(ret)); - exit(1); - } - - if (status == 0) { - fprintf(stderr, "should not have accepted!\n"); - exit(1); - } - - data[0].type = GNUTLS_DT_DNS_HOSTNAME; - data[0].data = (void*)"localhost"; - - ret = gnutls_certificate_verify_peers(client, data, 2, &status); - if (ret < 0) { - fprintf(stderr, "could not verify certificate: %s\n", gnutls_strerror(ret)); - exit(1); - } - - if (status != 0) { - fprintf(stderr, "could not verify certificate: %.4x\n", status); - exit(1); - } - } - - gnutls_bye(client, GNUTLS_SHUT_RDWR); - gnutls_bye(server, GNUTLS_SHUT_RDWR); - - gnutls_deinit(client); - gnutls_deinit(server); - - gnutls_certificate_free_credentials(serverx509cred); - gnutls_certificate_free_credentials(clientx509cred); - - gnutls_global_deinit(); -} -- cgit v1.2.1 From 7a2f81e178ee9b29090a9cac286f38e9996a389d Mon Sep 17 00:00:00 2001 From: Nikos Mavrogiannopoulos Date: Tue, 25 Sep 2018 12:07:10 +0200 Subject: doc: fixed missing function and enumeration parameters Signed-off-by: Nikos Mavrogiannopoulos --- lib/includes/gnutls/gnutls.h.in | 5 +++++ lib/includes/gnutls/x509.h | 2 +- lib/openpgp_compat.c | 2 ++ lib/privkey_raw.c | 2 ++ lib/x509/privkey.c | 5 +++-- lib/x509/x509.c | 3 ++- 6 files changed, 15 insertions(+), 4 deletions(-) diff --git a/lib/includes/gnutls/gnutls.h.in b/lib/includes/gnutls/gnutls.h.in index 49990b5f50..ec8d6f4efc 100644 --- a/lib/includes/gnutls/gnutls.h.in +++ b/lib/includes/gnutls/gnutls.h.in @@ -269,6 +269,10 @@ typedef enum { * @GNUTLS_MAC_AEAD: MAC implicit through AEAD cipher. * @GNUTLS_MAC_UMAC_96: The UMAC-96 MAC algorithm. * @GNUTLS_MAC_UMAC_128: The UMAC-128 MAC algorithm. + * @GNUTLS_MAC_SHA3_224: Reserved; unimplemented. + * @GNUTLS_MAC_SHA3_256: Reserved; unimplemented. + * @GNUTLS_MAC_SHA3_384: Reserved; unimplemented. + * @GNUTLS_MAC_SHA3_512: Reserved; unimplemented. * * Enumeration of different Message Authentication Code (MAC) * algorithms. @@ -559,6 +563,7 @@ typedef enum { * @GNUTLS_HANDSHAKE_SUPPLEMENTAL: Supplemental. * @GNUTLS_HANDSHAKE_CHANGE_CIPHER_SPEC: Change Cipher Spec. * @GNUTLS_HANDSHAKE_CLIENT_HELLO_V2: SSLv2 Client Hello. + * @GNUTLS_HANDSHAKE_ENCRYPTED_EXTENSIONS: Encrypted extensions message. * * Enumeration of different TLS handshake packets. */ diff --git a/lib/includes/gnutls/x509.h b/lib/includes/gnutls/x509.h index 1573577d96..13b642a840 100644 --- a/lib/includes/gnutls/x509.h +++ b/lib/includes/gnutls/x509.h @@ -1097,7 +1097,7 @@ unsigned gnutls_x509_crt_check_key_purpose(gnutls_x509_crt_t cert, * @GNUTLS_PKCS_PBES2_AES_192: PBES2 AES-192. * @GNUTLS_PKCS_PBES2_AES_256: PBES2 AES-256. * @GNUTLS_PKCS_PBES2_DES: PBES2 single DES. - * @GNUTLS_PKCS_PBES2_DES_MD5: PBES1 with single DES; for compatibility with openssl only. + * @GNUTLS_PKCS_PBES1_DES_MD5: PBES1 with single DES; for compatibility with openssl only. * @GNUTLS_PKCS_PBES2_GOST_TC26Z: PBES2 GOST 28147-89 CFB with TC26-Z S-box. * @GNUTLS_PKCS_PBES2_GOST_CPA: PBES2 GOST 28147-89 CFB with CryptoPro-A S-box. * @GNUTLS_PKCS_PBES2_GOST_CPB: PBES2 GOST 28147-89 CFB with CryptoPro-B S-box. diff --git a/lib/openpgp_compat.c b/lib/openpgp_compat.c index ff43403a7b..2a4679890b 100644 --- a/lib/openpgp_compat.c +++ b/lib/openpgp_compat.c @@ -653,6 +653,7 @@ int gnutls_pubkey_import_openpgp_raw(gnutls_pubkey_t pkey, * @output_data: will contain the key ID * @output_data_size: holds the size of output_data (and will be * replaced by the actual size of parameters) + * @subkey: ignored * * This function is no-op. * @@ -793,6 +794,7 @@ int gnutls_pcert_export_openpgp(gnutls_pcert_st * pcert, /** * gnutls_openpgp_privkey_sign_hash: * @session: is a gnutls session + * @status: is ignored * * This function is no-op. * diff --git a/lib/privkey_raw.c b/lib/privkey_raw.c index 4db22d84b4..6272964128 100644 --- a/lib/privkey_raw.c +++ b/lib/privkey_raw.c @@ -270,6 +270,7 @@ int ret; * @key: Holds the public key * @curve: will hold the curve * @digest: will hold the digest + * @paramset: will hold the GOST parameter set ID * @x: will hold the x coordinate * @y: will hold the y coordinate * @k: will hold the private key @@ -482,6 +483,7 @@ error: * @key: The key * @curve: holds the curve * @digest: holds the digest + * @paramset: holds the GOST parameter set ID * @x: holds the x * @y: holds the y * @k: holds the k diff --git a/lib/x509/privkey.c b/lib/x509/privkey.c index 562ad418d0..db1279e842 100644 --- a/lib/x509/privkey.c +++ b/lib/x509/privkey.c @@ -1186,7 +1186,8 @@ gnutls_x509_privkey_import_ecc_raw(gnutls_x509_privkey_t key, * gnutls_x509_privkey_import_gost_raw: * @key: The data to store the parsed key * @curve: holds the curve - * @paramset: holds the parameters id + * @digest: will hold the digest + * @paramset: will hold the GOST parameter set ID * @x: holds the x * @y: holds the y * @k: holds the k @@ -1559,7 +1560,7 @@ int gnutls_x509_privkey_export_ecc_raw(gnutls_x509_privkey_t key, * @key: a key * @curve: will hold the curve * @digest: will hold the digest - * @paramset: will hold the parameters id + * @paramset: will hold the GOST parameter set ID * @x: will hold the x coordinate * @y: will hold the y coordinate * @k: will hold the private key diff --git a/lib/x509/x509.c b/lib/x509/x509.c index 4aff55eba9..1880f6acc3 100644 --- a/lib/x509/x509.c +++ b/lib/x509/x509.c @@ -3526,7 +3526,8 @@ gnutls_x509_crt_get_pk_ecc_raw(gnutls_x509_crt_t crt, * gnutls_x509_crt_get_pk_gost_raw: * @crt: Holds the certificate * @curve: will hold the curve - * @paramset: will hold paramset + * @digest: will hold the digest + * @paramset: will hold the GOST parameter set ID * @x: will hold x * @y: will hold y * -- cgit v1.2.1 From b52735336857be24206e062b0a00501b1f0c597d Mon Sep 17 00:00:00 2001 From: Nikos Mavrogiannopoulos Date: Tue, 25 Sep 2018 13:06:57 +0200 Subject: manpage generation: cleanup Recognize parameters of the form unsigned char name[8], and do not print obscure warnings. Furthermore gdoc will fail when a function parameter is not described or when no function is found. This addresses the generation of undetected errors in generated manpages. Signed-off-by: Nikos Mavrogiannopoulos --- .gitlab-ci.yml | 2 +- doc/Makefile.am | 26 +++++++++++++------------- doc/doc.mk | 2 +- doc/manpages/Makefile.am | 34 +++++++++++++++++----------------- doc/scripts/gdoc | 22 +++++++++++++++++----- 5 files changed, 49 insertions(+), 37 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5c8a297ead..561fcbf349 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -43,7 +43,7 @@ doc-dist.Fedora: script: - SUBMODULE_NOFETCH=1 ./bootstrap - CFLAGS="-std=c99 -O2 -g" dash ./configure --disable-gcc-warnings --cache-file cache/config.cache --prefix=/usr --libdir=/usr/lib64 --disable-cxx --disable-non-suiteb-curves --enable-gtk-doc --disable-maintainer-mode - - make -C doc stamp-vti && make -C doc stamp-1 && make -j$(nproc) + - make -C doc stamp-vti && make -C doc stamp-1 && make -C doc stamp_enums && make -j$(nproc) - make -C doc gnutls.html - PATH="$PATH:/usr/share/sgml/docbook/xsl-stylesheets-1.79.1/epub/bin/" make -C doc gnutls.epub && make -C doc/latex gnutls.pdf diff --git a/doc/Makefile.am b/doc/Makefile.am index 782b3cf55f..1e72f63adb 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -225,7 +225,7 @@ gnutls-api.texi: $(top_srcdir)/lib/includes/gnutls/gnutls.h.in echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -236,7 +236,7 @@ socket-api.texi: $(top_srcdir)/lib/includes/gnutls/socket.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -247,7 +247,7 @@ dane-api.texi: $(top_srcdir)/libdane/includes/gnutls/dane.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -259,7 +259,7 @@ x509-api.texi: $(top_srcdir)/lib/includes/gnutls/x509.h $(top_srcdir)/lib/includ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done rm -f $@-tmp2 @@ -271,7 +271,7 @@ pkcs12-api.texi: $(top_srcdir)/lib/includes/gnutls/pkcs12.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_X509_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_X509_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -282,7 +282,7 @@ pkcs11-api.texi: $(top_srcdir)/lib/includes/gnutls/pkcs11.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -293,7 +293,7 @@ pkcs7-api.texi: $(top_srcdir)/lib/includes/gnutls/pkcs7.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_X509_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_X509_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -304,7 +304,7 @@ tpm-api.texi: $(top_srcdir)/lib/includes/gnutls/tpm.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -316,7 +316,7 @@ abstract-api.texi: $(top_srcdir)/lib/includes/gnutls/abstract.h $(top_srcdir)/li echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done rm -f $@-headers-tmp @@ -328,7 +328,7 @@ compat-api.texi: $(top_srcdir)/lib/includes/gnutls/compat.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -339,7 +339,7 @@ dtls-api.texi: $(top_srcdir)/lib/includes/gnutls/dtls.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -350,7 +350,7 @@ crypto-api.texi: $(top_srcdir)/lib/includes/gnutls/crypto.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ @@ -361,7 +361,7 @@ ocsp-api.texi: $(top_srcdir)/lib/includes/gnutls/ocsp.h echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ - $(C_X509_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + $(C_X509_SOURCE_FILES) >> $@-tmp && \ echo "ok"; \ done mv -f $@-tmp $@ diff --git a/doc/doc.mk b/doc/doc.mk index 89a643c6c6..21636f6951 100644 --- a/doc/doc.mk +++ b/doc/doc.mk @@ -29,4 +29,4 @@ HEADER_FILES = $(top_srcdir)/lib/includes/gnutls/gnutls.h.in \ $(top_srcdir)/lib/includes/gnutls/pkcs7.h $(top_srcdir)/lib/includes/gnutls/socket.h C_SOURCE_FILES = $(top_srcdir)/lib/*/*.c $(top_srcdir)/lib/*.c $(top_srcdir)/libdane/*.c -C_X509_SOURCE_FILES = $(top_srcdir)/lib/x509/*.c $(top_srcdir)/lib/*.c $(top_srcdir)/lib/system/cert.c +C_X509_SOURCE_FILES = $(top_srcdir)/lib/x509/*.c $(top_srcdir)/lib/*.c $(top_srcdir)/lib/system/certs.c diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am index 241d9870af..76a73ae057 100644 --- a/doc/manpages/Makefile.am +++ b/doc/manpages/Makefile.am @@ -1235,7 +1235,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1249,7 +1249,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1263,7 +1263,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1277,7 +1277,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1291,7 +1291,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_X509_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_X509_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1305,7 +1305,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_X509_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_X509_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1319,7 +1319,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_X509_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_X509_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1333,7 +1333,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_X509_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_X509_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1347,7 +1347,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1361,7 +1361,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_X509_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_X509_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1375,7 +1375,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1389,7 +1389,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1403,7 +1403,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1417,7 +1417,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1431,7 +1431,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1445,7 +1445,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2014-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" @@ -1459,7 +1459,7 @@ stamp_mans: $(HEADER_FILES) -seeinfo $(PACKAGE) -verbatimcopying \ -copyright "2014-$(YEAR) Free Software Foundation, Inc., and others" \ -function $$i \ - $(C_SOURCE_FILES) > $$i.3 2>/dev/null && \ + $(C_SOURCE_FILES) > $$i.3 && \ echo $(ECHO_N) "."; \ done @echo "" diff --git a/doc/scripts/gdoc b/doc/scripts/gdoc index 224b83e22a..25aa1beebb 100755 --- a/doc/scripts/gdoc +++ b/doc/scripts/gdoc @@ -196,6 +196,8 @@ $blankline_man = ""; $blankline_text = ""; my $lineprefix = ""; +my $function_found = 0; + sub usage { print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -tex | -texinfo -listfunc ]\n"; print " [ -sourceversion verno ] [ -include file | -includefuncprefix ]\n"; @@ -797,6 +799,10 @@ sub dump_function { $function_name = $2; $args = $3; + if ($return_type eq 'typedef') { + return; + } + # print STDERR "ARGS = '$args'\n"; foreach $arg (split ',', $args) { @@ -813,7 +819,7 @@ sub dump_function { $param = $2; push @args, $1; } - if ($param =~ m/^(.*)(\[\])$/) { + if ($param =~ m/^(.*)(\[[0-9]*\])$/) { $param = $1; push @args, $2; } @@ -822,7 +828,8 @@ sub dump_function { if ((!defined($parameters{$param}) || $parameters{$param} eq "") && $param ne "void") { $parameters{$param} = "-- undescribed --"; - print STDERR "warning: $lineno: Function parameter '$param' not described in '$function_name'\n"; + print STDERR "error: $lineno: Function parameter '$param' not described in '$function_name'\n"; + exit 1; } push @parameterlist, $param; @@ -831,11 +838,12 @@ sub dump_function { # print STDERR "param = '$param', type = '$type'\n"; } } else { - print STDERR "warning: $lineno: Cannot understand prototype: '$prototype'\n"; - return; + print STDERR "error: $lineno: Cannot understand prototype: '$prototype'\n"; + exit 1; } if ($function_only==0 || defined($function_table{$function_name})) { + $function_found=1; output_function({'function' => $function_name, 'module' => $modulename, 'sourceversion' => $sourceversion, @@ -1008,7 +1016,7 @@ foreach $file (@ARGV) { } } else { # i dont know - bad line? ignore. - print STDERR "warning: $lineno: Bad line: $_"; + #print STDERR "warning: $lineno: Bad line: $_"; } } elsif ($state == 3) { # scanning for function { (end of prototype) if ($line =~ /([a-zA-Z\s]+)enum(.*)$/) { @@ -1066,5 +1074,9 @@ foreach $file (@ARGV) { } } +} +if ($function_only != 0 && $function_found == 0) { + print STDERR "error: could not find the expected function\n"; + exit 1; } -- cgit v1.2.1 From 0d0e0bd8b93506247d52d83b0a54c7d4063c5c41 Mon Sep 17 00:00:00 2001 From: Nikos Mavrogiannopoulos Date: Tue, 25 Sep 2018 13:52:25 +0200 Subject: manpages: do not generate any manpages for openpgp.h This API is no longer functional and is only available as stubs for backwards binary compatibility. Signed-off-by: Nikos Mavrogiannopoulos --- doc/manpages/Makefile.am | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am index 76a73ae057..5e8d4d7c96 100644 --- a/doc/manpages/Makefile.am +++ b/doc/manpages/Makefile.am @@ -1393,20 +1393,6 @@ stamp_mans: $(HEADER_FILES) echo $(ECHO_N) "."; \ done @echo "" - @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-site "http://www.gnutls.org" \ - -include "gnutls/openpgp.h" \ - -seeinfo $(PACKAGE) -verbatimcopying \ - -copyright "2001-$(YEAR) Free Software Foundation, Inc., and others" \ - -function $$i \ - $(C_SOURCE_FILES) > $$i.3 && \ - echo $(ECHO_N) "."; \ - done - @echo "" @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 \ -- cgit v1.2.1