diff mbox series

[v2,7/7] crypto: Make QCryptoTLSCreds* structures private

Message ID 20210615164751.2192807-8-philmd@redhat.com (mailing list archive)
State New, archived
Headers show
Series crypto: Make QCryptoTLSCreds* structures private | expand

Commit Message

Philippe Mathieu-Daudé June 15, 2021, 4:47 p.m. UTC
Code consuming the "crypto/tlscreds*.h" APIs doesn't need
to access its internals. Move the structure definitions to
the implementations in crypto/. The headers 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         | 15 +++++++++++++++
 include/crypto/tlscreds.h     | 16 ----------------
 include/crypto/tlscredsanon.h | 12 ------------
 include/crypto/tlscredspsk.h  | 12 ------------
 include/crypto/tlscredsx509.h | 10 ----------
 crypto/tlscredsanon.c         | 13 +++++++++++++
 crypto/tlscredspsk.c          | 14 ++++++++++++++
 crypto/tlscredsx509.c         | 16 +++++++++++++---
 8 files changed, 55 insertions(+), 53 deletions(-)

Comments

Daniel P. Berrangé June 15, 2021, 4:52 p.m. UTC | #1
On Tue, Jun 15, 2021 at 06:47:51PM +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 implementations in crypto/. The headers 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         | 15 +++++++++++++++
>  include/crypto/tlscreds.h     | 16 ----------------
>  include/crypto/tlscredsanon.h | 12 ------------
>  include/crypto/tlscredspsk.h  | 12 ------------
>  include/crypto/tlscredsx509.h | 10 ----------
>  crypto/tlscredsanon.c         | 13 +++++++++++++
>  crypto/tlscredspsk.c          | 14 ++++++++++++++
>  crypto/tlscredsx509.c         | 16 +++++++++++++---
>  8 files changed, 55 insertions(+), 53 deletions(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


Regards,
Daniel
Philippe Mathieu-Daudé June 15, 2021, 5:16 p.m. UTC | #2
On 6/15/21 6:52 PM, Daniel P. Berrangé wrote:
> On Tue, Jun 15, 2021 at 06:47:51PM +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 implementations in crypto/. The headers 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         | 15 +++++++++++++++
>>  include/crypto/tlscreds.h     | 16 ----------------
>>  include/crypto/tlscredsanon.h | 12 ------------
>>  include/crypto/tlscredspsk.h  | 12 ------------
>>  include/crypto/tlscredsx509.h | 10 ----------
>>  crypto/tlscredsanon.c         | 13 +++++++++++++
>>  crypto/tlscredspsk.c          | 14 ++++++++++++++
>>  crypto/tlscredsx509.c         | 16 +++++++++++++---
>>  8 files changed, 55 insertions(+), 53 deletions(-)
> 
> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>

Thanks, however I missed something:

crypto/tlssession.c: In function ‘qcrypto_tls_session_new’:
crypto/tlssession.c:163:48: error: invalid use of incomplete typedef
‘QCryptoTLSCredsAnon’
  163 |                                          acreds->data.server);
      |                                                ^~
crypto/tlssession.c:167:48: error: invalid use of incomplete typedef
‘QCryptoTLSCredsAnon’
  167 |                                          acreds->data.client);
      |                                                ^~
crypto/tlssession.c:201:48: error: invalid use of incomplete typedef
‘QCryptoTLSCredsPSK’
  201 |                                          pcreds->data.server);
      |                                                ^~
crypto/tlssession.c:205:48: error: invalid use of incomplete typedef
‘QCryptoTLSCredsPSK’
  205 |                                          pcreds->data.client);
      |                                                ^~
crypto/tlssession.c:228:44: error: invalid use of incomplete typedef
‘QCryptoTLSCredsX509’
  228 |                                      tcreds->data);
      |                                            ^~
Daniel P. Berrangé June 15, 2021, 5:21 p.m. UTC | #3
On Tue, Jun 15, 2021 at 07:16:17PM +0200, Philippe Mathieu-Daudé wrote:
> On 6/15/21 6:52 PM, Daniel P. Berrangé wrote:
> > On Tue, Jun 15, 2021 at 06:47:51PM +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 implementations in crypto/. The headers 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         | 15 +++++++++++++++
> >>  include/crypto/tlscreds.h     | 16 ----------------
> >>  include/crypto/tlscredsanon.h | 12 ------------
> >>  include/crypto/tlscredspsk.h  | 12 ------------
> >>  include/crypto/tlscredsx509.h | 10 ----------
> >>  crypto/tlscredsanon.c         | 13 +++++++++++++
> >>  crypto/tlscredspsk.c          | 14 ++++++++++++++
> >>  crypto/tlscredsx509.c         | 16 +++++++++++++---
> >>  8 files changed, 55 insertions(+), 53 deletions(-)
> > 
> > Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
> 
> Thanks, however I missed something:
> 
> crypto/tlssession.c: In function ‘qcrypto_tls_session_new’:
> crypto/tlssession.c:163:48: error: invalid use of incomplete typedef
> ‘QCryptoTLSCredsAnon’
>   163 |                                          acreds->data.server);
>       |                                                ^~
> crypto/tlssession.c:167:48: error: invalid use of incomplete typedef
> ‘QCryptoTLSCredsAnon’
>   167 |                                          acreds->data.client);
>       |                                                ^~
> crypto/tlssession.c:201:48: error: invalid use of incomplete typedef
> ‘QCryptoTLSCredsPSK’
>   201 |                                          pcreds->data.server);
>       |                                                ^~
> crypto/tlssession.c:205:48: error: invalid use of incomplete typedef
> ‘QCryptoTLSCredsPSK’
>   205 |                                          pcreds->data.client);
>       |                                                ^~
> crypto/tlssession.c:228:44: error: invalid use of incomplete typedef
> ‘QCryptoTLSCredsX509’
>   228 |                                      tcreds->data);
>       |                                            ^~

Ah, yes, the tls session code needs to peer at the tlscred data.

We could have a 'crypto/tlscredspriv.h' header that declares
some accessors for getting this data from tls session.

Regards,
Daniel
diff mbox series

Patch

diff --git a/crypto/tlscredspriv.h b/crypto/tlscredspriv.h
index 39f1a91c413..67e76c24539 100644
--- a/crypto/tlscredspriv.h
+++ b/crypto/tlscredspriv.h
@@ -23,6 +23,21 @@ 
 
 #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;
+};
+
 #ifdef CONFIG_GNUTLS
 
 int qcrypto_tls_creds_get_path(QCryptoTLSCreds *creds,
diff --git a/include/crypto/tlscreds.h b/include/crypto/tlscreds.h
index eb9d5e75a84..bb3f2e4f303 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/tlscredsanon.c b/crypto/tlscredsanon.c
index bea5f76c55d..e7f74061ae2 100644
--- a/crypto/tlscredsanon.c
+++ b/crypto/tlscredsanon.c
@@ -26,6 +26,19 @@ 
 #include "qom/object_interfaces.h"
 #include "trace.h"
 
+#ifdef CONFIG_GNUTLS
+#include <gnutls/gnutls.h>
+#endif
+
+struct QCryptoTLSCredsAnon {
+    QCryptoTLSCreds parent_obj;
+#ifdef CONFIG_GNUTLS
+    union {
+        gnutls_anon_server_credentials_t server;
+        gnutls_anon_client_credentials_t client;
+    } data;
+#endif
+};
 
 #ifdef CONFIG_GNUTLS
 
diff --git a/crypto/tlscredspsk.c b/crypto/tlscredspsk.c
index f5a31108d15..b4053741b3b 100644
--- a/crypto/tlscredspsk.c
+++ b/crypto/tlscredspsk.c
@@ -26,6 +26,20 @@ 
 #include "qom/object_interfaces.h"
 #include "trace.h"
 
+#ifdef CONFIG_GNUTLS
+#include <gnutls/gnutls.h>
+#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
+};
 
 #ifdef CONFIG_GNUTLS
 
diff --git a/crypto/tlscredsx509.c b/crypto/tlscredsx509.c
index d9d6f4421e5..0a8284f930b 100644
--- a/crypto/tlscredsx509.c
+++ b/crypto/tlscredsx509.c
@@ -27,12 +27,22 @@ 
 #include "qom/object_interfaces.h"
 #include "trace.h"
 
+#ifdef CONFIG_GNUTLS
+#include <gnutls/gnutls.h>
+#include <gnutls/x509.h>
+#endif
+
+struct QCryptoTLSCredsX509 {
+    QCryptoTLSCreds parent_obj;
+#ifdef CONFIG_GNUTLS
+    gnutls_certificate_credentials_t data;
+#endif
+    bool sanityCheck;
+    char *passwordid;
+};
 
 #ifdef CONFIG_GNUTLS
 
-#include <gnutls/x509.h>
-
-
 static int
 qcrypto_tls_creds_check_cert_times(gnutls_x509_crt_t cert,
                                    const char *certFile,