| Message ID | 20210616162225.2517463-8-philmd@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | crypto: Make QCryptoTLSCreds* structures private | expand |
On Wed, Jun 16, 2021 at 06:22:25PM +0200, Philippe Mathieu-Daudé wrote: > Code consuming the "crypto/tlscreds*.h" APIs doesn't need > to access its internals. Move the structure definitions to > the "tlscredspriv.h" private header (only accessible by > implementations). The public headers (in include/) still > forward-declare the structures typedef. > > This solves a bug introduced by commit 7de2e856533 which made > migration/qemu-file-channel.c include "io/channel-tls.h", > itself sometime depends on GNUTLS, leading to build failure > on OSX: > > [2/35] Compiling C object libmigration.fa.p/migration_qemu-file-channel.c.o > FAILED: libmigration.fa.p/migration_qemu-file-channel.c.o > cc -Ilibmigration.fa.p -I. -I.. -Iqapi [ ... ] -o libmigration.fa.p/migration_qemu-file-channel.c.o -c ../migration/qemu-file-channel.c > In file included from ../migration/qemu-file-channel.c:29: > In file included from include/io/channel-tls.h:26: > In file included from include/crypto/tlssession.h:24: > include/crypto/tlscreds.h:28:10: fatal error: 'gnutls/gnutls.h' file not found > #include <gnutls/gnutls.h> > ^~~~~~~~~~~~~~~~~ > 1 error generated. > > Reported-by: Stefan Weil <sw@weilnetz.de> > Suggested-by: Daniel P. Berrangé <berrange@redhat.com> > Resolves: https://gitlab.com/qemu-project/qemu/-/issues/407 > Fixes: 7de2e856533 ("yank: Unregister function when using TLS migration") > Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> > --- > crypto/tlscredspriv.h | 45 ++++++++++++++++++++++++++++++ > include/crypto/tls-cipher-suites.h | 6 ---- > include/crypto/tlscreds.h | 16 ----------- > include/crypto/tlscredsanon.h | 12 -------- > include/crypto/tlscredspsk.h | 12 -------- > include/crypto/tlscredsx509.h | 10 ------- > crypto/tls-cipher-suites.c | 7 +++++ > crypto/tlscredsanon.c | 2 ++ > crypto/tlscredspsk.c | 2 ++ > crypto/tlscredsx509.c | 1 + > crypto/tlssession.c | 1 + > 11 files changed, 58 insertions(+), 56 deletions(-) > > diff --git a/crypto/tlscredsanon.c b/crypto/tlscredsanon.c > index bea5f76c55d..6fb83639ecd 100644 > --- a/crypto/tlscredsanon.c > +++ b/crypto/tlscredsanon.c > @@ -29,6 +29,8 @@ > > #ifdef CONFIG_GNUTLS > > +#include <gnutls/gnutls.h> > + > > static int > qcrypto_tls_creds_anon_load(QCryptoTLSCredsAnon *creds, > diff --git a/crypto/tlscredspsk.c b/crypto/tlscredspsk.c > index f5a31108d15..752f2d92bee 100644 > --- a/crypto/tlscredspsk.c > +++ b/crypto/tlscredspsk.c > @@ -29,6 +29,8 @@ > > #ifdef CONFIG_GNUTLS > > +#include <gnutls/gnutls.h> > + > static int > lookup_key(const char *pskfile, const char *username, gnutls_datum_t *key, > Error **errp) > diff --git a/crypto/tlscredsx509.c b/crypto/tlscredsx509.c > index d9d6f4421e5..32948a6bdc4 100644 > --- a/crypto/tlscredsx509.c > +++ b/crypto/tlscredsx509.c > @@ -30,6 +30,7 @@ > > #ifdef CONFIG_GNUTLS > > +#include <gnutls/gnutls.h> > #include <gnutls/x509.h> > > I was expecting all these files, and tlscreds.c to include tlscredspriv.h, otherwise how do they see the struct definition they need ? Regards, Daniel
On 6/17/21 11:35 AM, Daniel P. Berrangé wrote: > On Wed, Jun 16, 2021 at 06:22:25PM +0200, Philippe Mathieu-Daudé wrote: >> Code consuming the "crypto/tlscreds*.h" APIs doesn't need >> to access its internals. Move the structure definitions to >> the "tlscredspriv.h" private header (only accessible by >> implementations). The public headers (in include/) still >> forward-declare the structures typedef. >> >> This solves a bug introduced by commit 7de2e856533 which made >> migration/qemu-file-channel.c include "io/channel-tls.h", >> itself sometime depends on GNUTLS, leading to build failure >> on OSX: >> >> [2/35] Compiling C object libmigration.fa.p/migration_qemu-file-channel.c.o >> FAILED: libmigration.fa.p/migration_qemu-file-channel.c.o >> cc -Ilibmigration.fa.p -I. -I.. -Iqapi [ ... ] -o libmigration.fa.p/migration_qemu-file-channel.c.o -c ../migration/qemu-file-channel.c >> In file included from ../migration/qemu-file-channel.c:29: >> In file included from include/io/channel-tls.h:26: >> In file included from include/crypto/tlssession.h:24: >> include/crypto/tlscreds.h:28:10: fatal error: 'gnutls/gnutls.h' file not found >> #include <gnutls/gnutls.h> >> ^~~~~~~~~~~~~~~~~ >> 1 error generated. >> >> Reported-by: Stefan Weil <sw@weilnetz.de> >> Suggested-by: Daniel P. Berrangé <berrange@redhat.com> >> Resolves: https://gitlab.com/qemu-project/qemu/-/issues/407 >> Fixes: 7de2e856533 ("yank: Unregister function when using TLS migration") >> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> >> --- >> crypto/tlscredspriv.h | 45 ++++++++++++++++++++++++++++++ >> include/crypto/tls-cipher-suites.h | 6 ---- >> include/crypto/tlscreds.h | 16 ----------- >> include/crypto/tlscredsanon.h | 12 -------- >> include/crypto/tlscredspsk.h | 12 -------- >> include/crypto/tlscredsx509.h | 10 ------- >> crypto/tls-cipher-suites.c | 7 +++++ >> crypto/tlscredsanon.c | 2 ++ >> crypto/tlscredspsk.c | 2 ++ >> crypto/tlscredsx509.c | 1 + >> crypto/tlssession.c | 1 + >> 11 files changed, 58 insertions(+), 56 deletions(-) > I was expecting all these files, and tlscreds.c to include > tlscredspriv.h, otherwise how do they see the struct > definition they need ? They already include it: $ git grep tlscredspriv.h origin/master origin/master:crypto/tlscreds.c:24:#include "tlscredspriv.h" origin/master:crypto/tlscredsanon.c:23:#include "tlscredspriv.h" origin/master:crypto/tlscredspsk.c:23:#include "tlscredspriv.h" origin/master:crypto/tlscredsx509.c:23:#include "tlscredspriv.h" This is why in this patch I only added it to tls-cipher-suites.c and tlssession.c. I'll add a comment about it. Regards, Phil.
On Thu, Jun 17, 2021 at 02:08:17PM +0200, Philippe Mathieu-Daudé wrote: > On 6/17/21 11:35 AM, Daniel P. Berrangé wrote: > > On Wed, Jun 16, 2021 at 06:22:25PM +0200, Philippe Mathieu-Daudé wrote: > >> Code consuming the "crypto/tlscreds*.h" APIs doesn't need > >> to access its internals. Move the structure definitions to > >> the "tlscredspriv.h" private header (only accessible by > >> implementations). The public headers (in include/) still > >> forward-declare the structures typedef. > >> > >> This solves a bug introduced by commit 7de2e856533 which made > >> migration/qemu-file-channel.c include "io/channel-tls.h", > >> itself sometime depends on GNUTLS, leading to build failure > >> on OSX: > >> > >> [2/35] Compiling C object libmigration.fa.p/migration_qemu-file-channel.c.o > >> FAILED: libmigration.fa.p/migration_qemu-file-channel.c.o > >> cc -Ilibmigration.fa.p -I. -I.. -Iqapi [ ... ] -o libmigration.fa.p/migration_qemu-file-channel.c.o -c ../migration/qemu-file-channel.c > >> In file included from ../migration/qemu-file-channel.c:29: > >> In file included from include/io/channel-tls.h:26: > >> In file included from include/crypto/tlssession.h:24: > >> include/crypto/tlscreds.h:28:10: fatal error: 'gnutls/gnutls.h' file not found > >> #include <gnutls/gnutls.h> > >> ^~~~~~~~~~~~~~~~~ > >> 1 error generated. > >> > >> Reported-by: Stefan Weil <sw@weilnetz.de> > >> Suggested-by: Daniel P. Berrangé <berrange@redhat.com> > >> Resolves: https://gitlab.com/qemu-project/qemu/-/issues/407 > >> Fixes: 7de2e856533 ("yank: Unregister function when using TLS migration") > >> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> > >> --- > >> crypto/tlscredspriv.h | 45 ++++++++++++++++++++++++++++++ > >> include/crypto/tls-cipher-suites.h | 6 ---- > >> include/crypto/tlscreds.h | 16 ----------- > >> include/crypto/tlscredsanon.h | 12 -------- > >> include/crypto/tlscredspsk.h | 12 -------- > >> include/crypto/tlscredsx509.h | 10 ------- > >> crypto/tls-cipher-suites.c | 7 +++++ > >> crypto/tlscredsanon.c | 2 ++ > >> crypto/tlscredspsk.c | 2 ++ > >> crypto/tlscredsx509.c | 1 + > >> crypto/tlssession.c | 1 + > >> 11 files changed, 58 insertions(+), 56 deletions(-) > > > I was expecting all these files, and tlscreds.c to include > > tlscredspriv.h, otherwise how do they see the struct > > definition they need ? > > They already include it: > > $ git grep tlscredspriv.h origin/master > origin/master:crypto/tlscreds.c:24:#include "tlscredspriv.h" > origin/master:crypto/tlscredsanon.c:23:#include "tlscredspriv.h" > origin/master:crypto/tlscredspsk.c:23:#include "tlscredspriv.h" > origin/master:crypto/tlscredsx509.c:23:#include "tlscredspriv.h" > > This is why in this patch I only added it to tls-cipher-suites.c > and tlssession.c. > > I'll add a comment about it. No matter, I'm just being dumb and not remembering my own code. I thought tlscredspriv.h was a new header in your patch, but its just adding to an existing header. Regards, Daniel
diff --git a/crypto/tlscredspriv.h b/crypto/tlscredspriv.h index 39f1a91c413..df9815a2863 100644 --- a/crypto/tlscredspriv.h +++ b/crypto/tlscredspriv.h @@ -23,6 +23,51 @@ #include "crypto/tlscreds.h" +#ifdef CONFIG_GNUTLS +#include <gnutls/gnutls.h> +#endif + +struct QCryptoTLSCreds { + Object parent_obj; + char *dir; + QCryptoTLSCredsEndpoint endpoint; +#ifdef CONFIG_GNUTLS + gnutls_dh_params_t dh_params; +#endif + bool verifyPeer; + char *priority; +}; + +struct QCryptoTLSCredsAnon { + QCryptoTLSCreds parent_obj; +#ifdef CONFIG_GNUTLS + union { + gnutls_anon_server_credentials_t server; + gnutls_anon_client_credentials_t client; + } data; +#endif +}; + +struct QCryptoTLSCredsPSK { + QCryptoTLSCreds parent_obj; + char *username; +#ifdef CONFIG_GNUTLS + union { + gnutls_psk_server_credentials_t server; + gnutls_psk_client_credentials_t client; + } data; +#endif +}; + +struct QCryptoTLSCredsX509 { + QCryptoTLSCreds parent_obj; +#ifdef CONFIG_GNUTLS + gnutls_certificate_credentials_t data; +#endif + bool sanityCheck; + char *passwordid; +}; + #ifdef CONFIG_GNUTLS int qcrypto_tls_creds_get_path(QCryptoTLSCreds *creds, diff --git a/include/crypto/tls-cipher-suites.h b/include/crypto/tls-cipher-suites.h index bb9ee53e03a..7eb1b76122d 100644 --- a/include/crypto/tls-cipher-suites.h +++ b/include/crypto/tls-cipher-suites.h @@ -19,12 +19,6 @@ typedef struct QCryptoTLSCipherSuites QCryptoTLSCipherSuites; DECLARE_INSTANCE_CHECKER(QCryptoTLSCipherSuites, QCRYPTO_TLS_CIPHER_SUITES, TYPE_QCRYPTO_TLS_CIPHER_SUITES) -struct QCryptoTLSCipherSuites { - /* <private> */ - QCryptoTLSCreds parent_obj; - /* <public> */ -}; - /** * qcrypto_tls_cipher_suites_get_data: * @obj: pointer to a TLS cipher suites object diff --git a/include/crypto/tlscreds.h b/include/crypto/tlscreds.h index a14e44fac15..2a8a8570109 100644 --- a/include/crypto/tlscreds.h +++ b/include/crypto/tlscreds.h @@ -24,10 +24,6 @@ #include "qapi/qapi-types-crypto.h" #include "qom/object.h" -#ifdef CONFIG_GNUTLS -#include <gnutls/gnutls.h> -#endif - #define TYPE_QCRYPTO_TLS_CREDS "tls-creds" typedef struct QCryptoTLSCreds QCryptoTLSCreds; typedef struct QCryptoTLSCredsClass QCryptoTLSCredsClass; @@ -48,18 +44,6 @@ typedef bool (*CryptoTLSCredsReload)(QCryptoTLSCreds *, Error **); * certificate credentials. */ -struct QCryptoTLSCreds { - Object parent_obj; - char *dir; - QCryptoTLSCredsEndpoint endpoint; -#ifdef CONFIG_GNUTLS - gnutls_dh_params_t dh_params; -#endif - bool verifyPeer; - char *priority; -}; - - struct QCryptoTLSCredsClass { ObjectClass parent_class; CryptoTLSCredsReload reload; diff --git a/include/crypto/tlscredsanon.h b/include/crypto/tlscredsanon.h index 3f464a38095..bd3023f9ea7 100644 --- a/include/crypto/tlscredsanon.h +++ b/include/crypto/tlscredsanon.h @@ -92,18 +92,6 @@ typedef struct QCryptoTLSCredsAnonClass QCryptoTLSCredsAnonClass; * */ - -struct QCryptoTLSCredsAnon { - QCryptoTLSCreds parent_obj; -#ifdef CONFIG_GNUTLS - union { - gnutls_anon_server_credentials_t server; - gnutls_anon_client_credentials_t client; - } data; -#endif -}; - - struct QCryptoTLSCredsAnonClass { QCryptoTLSCredsClass parent_class; }; diff --git a/include/crypto/tlscredspsk.h b/include/crypto/tlscredspsk.h index d7e6bdb5edf..bcd07dc4f62 100644 --- a/include/crypto/tlscredspsk.h +++ b/include/crypto/tlscredspsk.h @@ -87,18 +87,6 @@ typedef struct QCryptoTLSCredsPSKClass QCryptoTLSCredsPSKClass; * The PSK file can be created and managed using psktool. */ -struct QCryptoTLSCredsPSK { - QCryptoTLSCreds parent_obj; - char *username; -#ifdef CONFIG_GNUTLS - union { - gnutls_psk_server_credentials_t server; - gnutls_psk_client_credentials_t client; - } data; -#endif -}; - - struct QCryptoTLSCredsPSKClass { QCryptoTLSCredsClass parent_class; }; diff --git a/include/crypto/tlscredsx509.h b/include/crypto/tlscredsx509.h index c6d89b78819..c4daba21a6b 100644 --- a/include/crypto/tlscredsx509.h +++ b/include/crypto/tlscredsx509.h @@ -96,16 +96,6 @@ typedef struct QCryptoTLSCredsX509Class QCryptoTLSCredsX509Class; * */ -struct QCryptoTLSCredsX509 { - QCryptoTLSCreds parent_obj; -#ifdef CONFIG_GNUTLS - gnutls_certificate_credentials_t data; -#endif - bool sanityCheck; - char *passwordid; -}; - - struct QCryptoTLSCredsX509Class { QCryptoTLSCredsClass parent_class; }; diff --git a/crypto/tls-cipher-suites.c b/crypto/tls-cipher-suites.c index 55fb5f7c19d..5e4f5974645 100644 --- a/crypto/tls-cipher-suites.c +++ b/crypto/tls-cipher-suites.c @@ -14,8 +14,15 @@ #include "crypto/tlscreds.h" #include "crypto/tls-cipher-suites.h" #include "hw/nvram/fw_cfg.h" +#include "tlscredspriv.h" #include "trace.h" +struct QCryptoTLSCipherSuites { + /* <private> */ + QCryptoTLSCreds parent_obj; + /* <public> */ +}; + /* * IANA registered TLS ciphers: * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4 diff --git a/crypto/tlscredsanon.c b/crypto/tlscredsanon.c index bea5f76c55d..6fb83639ecd 100644 --- a/crypto/tlscredsanon.c +++ b/crypto/tlscredsanon.c @@ -29,6 +29,8 @@ #ifdef CONFIG_GNUTLS +#include <gnutls/gnutls.h> + static int qcrypto_tls_creds_anon_load(QCryptoTLSCredsAnon *creds, diff --git a/crypto/tlscredspsk.c b/crypto/tlscredspsk.c index f5a31108d15..752f2d92bee 100644 --- a/crypto/tlscredspsk.c +++ b/crypto/tlscredspsk.c @@ -29,6 +29,8 @@ #ifdef CONFIG_GNUTLS +#include <gnutls/gnutls.h> + static int lookup_key(const char *pskfile, const char *username, gnutls_datum_t *key, Error **errp) diff --git a/crypto/tlscredsx509.c b/crypto/tlscredsx509.c index d9d6f4421e5..32948a6bdc4 100644 --- a/crypto/tlscredsx509.c +++ b/crypto/tlscredsx509.c @@ -30,6 +30,7 @@ #ifdef CONFIG_GNUTLS +#include <gnutls/gnutls.h> #include <gnutls/x509.h> diff --git a/crypto/tlssession.c b/crypto/tlssession.c index 4e614b73a28..e5d5675ef30 100644 --- a/crypto/tlssession.c +++ b/crypto/tlssession.c @@ -25,6 +25,7 @@ #include "crypto/tlscredsx509.h" #include "qapi/error.h" #include "authz/base.h" +#include "tlscredspriv.h" #include "trace.h" #ifdef CONFIG_GNUTLS
Code consuming the "crypto/tlscreds*.h" APIs doesn't need to access its internals. Move the structure definitions to the "tlscredspriv.h" private header (only accessible by implementations). The public headers (in include/) still forward-declare the structures typedef. This solves a bug introduced by commit 7de2e856533 which made migration/qemu-file-channel.c include "io/channel-tls.h", itself sometime depends on GNUTLS, leading to build failure on OSX: [2/35] Compiling C object libmigration.fa.p/migration_qemu-file-channel.c.o FAILED: libmigration.fa.p/migration_qemu-file-channel.c.o cc -Ilibmigration.fa.p -I. -I.. -Iqapi [ ... ] -o libmigration.fa.p/migration_qemu-file-channel.c.o -c ../migration/qemu-file-channel.c In file included from ../migration/qemu-file-channel.c:29: In file included from include/io/channel-tls.h:26: In file included from include/crypto/tlssession.h:24: include/crypto/tlscreds.h:28:10: fatal error: 'gnutls/gnutls.h' file not found #include <gnutls/gnutls.h> ^~~~~~~~~~~~~~~~~ 1 error generated. Reported-by: Stefan Weil <sw@weilnetz.de> Suggested-by: Daniel P. Berrangé <berrange@redhat.com> Resolves: https://gitlab.com/qemu-project/qemu/-/issues/407 Fixes: 7de2e856533 ("yank: Unregister function when using TLS migration") Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> --- crypto/tlscredspriv.h | 45 ++++++++++++++++++++++++++++++ include/crypto/tls-cipher-suites.h | 6 ---- include/crypto/tlscreds.h | 16 ----------- include/crypto/tlscredsanon.h | 12 -------- include/crypto/tlscredspsk.h | 12 -------- include/crypto/tlscredsx509.h | 10 ------- crypto/tls-cipher-suites.c | 7 +++++ crypto/tlscredsanon.c | 2 ++ crypto/tlscredspsk.c | 2 ++ crypto/tlscredsx509.c | 1 + crypto/tlssession.c | 1 + 11 files changed, 58 insertions(+), 56 deletions(-)