 678bcc3c2c
			
		
	
	
		678bcc3c2c
		
	
	
	
	
		
			
			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.
Note, tlscreds.c and 3 of the 5 modified source files already
include "tlscredspriv.h", so only add it to tls-cipher-suites.c
and tlssession.c.
Removing the internals from the public header solves a bug
introduced by commit 7de2e856533 ("yank: Unregister function
when using TLS migration") which made migration/qemu-file-channel.c
include "io/channel-tls.h", itself sometime depends on GNUTLS,
leading to a 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>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
		
	
			
		
			
				
	
	
		
			96 lines
		
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			96 lines
		
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  * QEMU crypto TLS Pre-Shared Key (PSK) support
 | |
|  *
 | |
|  * Copyright (c) 2018 Red Hat, Inc.
 | |
|  *
 | |
|  * This library is free software; you can redistribute it and/or
 | |
|  * modify it under the terms of the GNU Lesser General Public
 | |
|  * License as published by the Free Software Foundation; either
 | |
|  * version 2.1 of the License, or (at your option) any later version.
 | |
|  *
 | |
|  * This library 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
 | |
|  * Lesser General Public License for more details.
 | |
|  *
 | |
|  * You should have received a copy of the GNU Lesser General Public
 | |
|  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
 | |
|  *
 | |
|  */
 | |
| 
 | |
| #ifndef QCRYPTO_TLSCREDSPSK_H
 | |
| #define QCRYPTO_TLSCREDSPSK_H
 | |
| 
 | |
| #include "crypto/tlscreds.h"
 | |
| #include "qom/object.h"
 | |
| 
 | |
| #define TYPE_QCRYPTO_TLS_CREDS_PSK "tls-creds-psk"
 | |
| typedef struct QCryptoTLSCredsPSK QCryptoTLSCredsPSK;
 | |
| DECLARE_INSTANCE_CHECKER(QCryptoTLSCredsPSK, QCRYPTO_TLS_CREDS_PSK,
 | |
|                          TYPE_QCRYPTO_TLS_CREDS_PSK)
 | |
| 
 | |
| typedef struct QCryptoTLSCredsPSKClass QCryptoTLSCredsPSKClass;
 | |
| 
 | |
| #define QCRYPTO_TLS_CREDS_PSKFILE "keys.psk"
 | |
| 
 | |
| /**
 | |
|  * QCryptoTLSCredsPSK:
 | |
|  *
 | |
|  * The QCryptoTLSCredsPSK object provides a representation
 | |
|  * of the Pre-Shared Key credential used to perform a TLS handshake.
 | |
|  *
 | |
|  * This is a user creatable object, which can be instantiated
 | |
|  * via object_new_propv():
 | |
|  *
 | |
|  * <example>
 | |
|  *   <title>Creating TLS-PSK credential objects in code</title>
 | |
|  *   <programlisting>
 | |
|  *   Object *obj;
 | |
|  *   Error *err = NULL;
 | |
|  *   obj = object_new_propv(TYPE_QCRYPTO_TLS_CREDS_PSK,
 | |
|  *                          "tlscreds0",
 | |
|  *                          &err,
 | |
|  *                          "dir", "/path/to/dir",
 | |
|  *                          "endpoint", "client",
 | |
|  *                          NULL);
 | |
|  *   </programlisting>
 | |
|  * </example>
 | |
|  *
 | |
|  * Or via QMP:
 | |
|  *
 | |
|  * <example>
 | |
|  *   <title>Creating TLS-PSK credential objects via QMP</title>
 | |
|  *   <programlisting>
 | |
|  *    {
 | |
|  *       "execute": "object-add", "arguments": {
 | |
|  *          "id": "tlscreds0",
 | |
|  *          "qom-type": "tls-creds-psk",
 | |
|  *          "props": {
 | |
|  *             "dir": "/path/to/dir",
 | |
|  *             "endpoint": "client"
 | |
|  *          }
 | |
|  *       }
 | |
|  *    }
 | |
|  *   </programlisting>
 | |
|  * </example>
 | |
|  *
 | |
|  * Or via the CLI:
 | |
|  *
 | |
|  * <example>
 | |
|  *   <title>Creating TLS-PSK credential objects via CLI</title>
 | |
|  *   <programlisting>
 | |
|  *  qemu-system-x86_64 --object tls-creds-psk,id=tlscreds0,\
 | |
|  *          endpoint=client,dir=/path/to/dir[,username=qemu]
 | |
|  *   </programlisting>
 | |
|  * </example>
 | |
|  *
 | |
|  * The PSK file can be created and managed using psktool.
 | |
|  */
 | |
| 
 | |
| struct QCryptoTLSCredsPSKClass {
 | |
|     QCryptoTLSCredsClass parent_class;
 | |
| };
 | |
| 
 | |
| 
 | |
| #endif /* QCRYPTO_TLSCREDSPSK_H */
 |