ui/vnc-auth-sasl.h

   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
  25 #ifndef QEMU_VNC_AUTH_SASL_H
  26 #define QEMU_VNC_AUTH_SASL_H
  27
  28 #include <sasl/sasl.h>
  29
  30 typedef struct VncStateSASL VncStateSASL;
  31 typedef struct VncDisplaySASL VncDisplaySASL;
  32
  33 #include "authz/base.h"
  34
  35 struct VncStateSASL {
  36     sasl_conn_t *conn;
  37     /* If we want to negotiate an SSF layer with client */
  38     bool wantSSF;
  39     /* If we are now running the SSF layer */
  40     bool runSSF;
  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;
  55     unsigned int encodedRawLength;
  56     unsigned int encodedOffset;
  57     char *username;
  58     char *mechlist;
  59 };
  60
  61 struct VncDisplaySASL {
  62     QAuthZ *authz;
  63     char *authzid;
  64 };
  65
  66 bool vnc_sasl_server_init(Error **errp);
  67 void vnc_sasl_client_cleanup(VncState *vs);
  68
  69 size_t vnc_client_read_sasl(VncState *vs);
  70 size_t vnc_client_write_sasl(VncState *vs);
  71
  72 void start_auth_sasl(VncState *vs);
  73
  74 #endif /* QEMU_VNC_AUTH_SASL_H */