[qemu.git] / ui / vnc-auth-sasl.h

/*
 * QEMU VNC display driver: SASL auth protocol
 *
 * Copyright (C) 2009 Red Hat, Inc
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef QEMU_VNC_AUTH_SASL_H
#define QEMU_VNC_AUTH_SASL_H

#include <sasl/sasl.h>

typedef struct VncStateSASL VncStateSASL;
typedef struct VncDisplaySASL VncDisplaySASL;

#include "authz/base.h"

struct VncStateSASL {
    sasl_conn_t *conn;
    /* If we want to negotiate an SSF layer with client */
    bool wantSSF;
    /* If we are now running the SSF layer */
    bool runSSF;
    /*
     * If this is non-zero, then wait for that many bytes
     * to be written plain, before switching to SSF encoding
     * This allows the VNC auth result to finish being
     * written in plain.
     */
    unsigned int waitWriteSSF;

    /*
     * Buffering encoded data to allow more clear data
     * to be stuffed onto the output buffer
     */
    const uint8_t *encoded;
    unsigned int encodedLength;
    unsigned int encodedRawLength;
    unsigned int encodedOffset;
    char *username;
    char *mechlist;
};

struct VncDisplaySASL {
    QAuthZ *authz;
    char *authzid;
};

void vnc_sasl_client_cleanup(VncState *vs);

size_t vnc_client_read_sasl(VncState *vs);
size_t vnc_client_write_sasl(VncState *vs);

void start_auth_sasl(VncState *vs);

#endif /* QEMU_VNC_AUTH_SASL_H */
Commit	Line	Data
2f9606b3 AL	1	/*
	2	* QEMU VNC display driver: SASL auth protocol
	3	*
	4	* Copyright (C) 2009 Red Hat, Inc
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	19	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
	24
2a6a4076 MA	25	#ifndef QEMU_VNC_AUTH_SASL_H
2a6a4076 MA	26	#define QEMU_VNC_AUTH_SASL_H
2f9606b3 AL	27
	28	#include <sasl/sasl.h>
	29
	30	typedef struct VncStateSASL VncStateSASL;
76655d6d AL	31	typedef struct VncDisplaySASL VncDisplaySASL;
76655d6d AL	32
b76806d4	33	#include "authz/base.h"
2f9606b3 AL	34
	35	struct VncStateSASL {
	36	sasl_conn_t *conn;
	37	/* If we want to negotiate an SSF layer with client */
ee032ca1	38	bool wantSSF;
2f9606b3	39	/* If we are now running the SSF layer */
ee032ca1	40	bool runSSF;
2f9606b3 AL	41	/*
	42	* If this is non-zero, then wait for that many bytes
	43	* to be written plain, before switching to SSF encoding
	44	* This allows the VNC auth result to finish being
	45	* written in plain.
	46	*/
	47	unsigned int waitWriteSSF;
	48
	49	/*
	50	* Buffering encoded data to allow more clear data
	51	* to be stuffed onto the output buffer
	52	*/
	53	const uint8_t *encoded;
	54	unsigned int encodedLength;
8f61f1c5	55	unsigned int encodedRawLength;
2f9606b3 AL	56	unsigned int encodedOffset;
	57	char *username;
	58	char *mechlist;
	59	};
	60
76655d6d	61	struct VncDisplaySASL {
b76806d4 DB	62	QAuthZ *authz;
b76806d4 DB	63	char *authzid;
76655d6d AL	64	};
76655d6d AL	65
2f9606b3 AL	66	void vnc_sasl_client_cleanup(VncState *vs);
2f9606b3 AL	67
30b80fd5 DB	68	size_t vnc_client_read_sasl(VncState *vs);
30b80fd5 DB	69	size_t vnc_client_write_sasl(VncState *vs);
2f9606b3 AL	70
	71	void start_auth_sasl(VncState *vs);
	72
2a6a4076	73	#endif /* QEMU_VNC_AUTH_SASL_H */