xrdp/sesman/libscp/libscp_v0.h

/**
 * xrdp: A Remote Desktop Protocol server.
 *
 * Copyright (C) Jay Sorg 2004-2012
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 *
 * @file libscp_v0.h
 * @brief libscp version 0 declarations
 * @author Simone Fedele
 *
 */

#ifndef LIBSCP_V0_H
#define LIBSCP_V0_H

#include "libscp.h"
#include "guid.h"

/* client API */

struct scp_v0_reply_type
{
    /**
     * True if this is a reply to a gateway authentication request
     */
    int is_gw_auth_response;

    /**
     * Authentication result. PAM code for gateway request, boolean otherwise
     */
    int auth_result;

    /**
     * Display number for successful non-gateway requests
     */
    int display;

    /**
     * GUID for successful non-gateway requests
     */
    struct guid guid;
};

enum SCP_CLIENT_STATES_E
scp_v0c_gateway_request(struct trans *atrans,
                        const char *username,
                        const char *password);

/*
 * Note client bpp is ignored by the sesman for Xorg sessions
 */
enum SCP_CLIENT_STATES_E
scp_v0c_create_session_request(struct trans *atrans,
                               const char *username,
                               const char *password,
                               unsigned short code,
                               unsigned short width,
                               unsigned short height,
                               unsigned short bpp,
                               const char *domain,
                               const char *shell,
                               const char *directory,
                               const char *client_ip);

int
scp_v0c_reply_available(struct trans *atrans);

enum SCP_CLIENT_STATES_E
scp_v0c_get_reply(struct trans *atrans, struct scp_v0_reply_type *reply);

/* server API */
/**
 *
 * @brief processes the stream using scp version 0
 * @param atrans connection trans
 * @param s session descriptor
 *
 */
enum SCP_SERVER_STATES_E
scp_v0s_accept(struct trans *atrans, struct SCP_SESSION *s);

/**
 *
 * @brief allows the connection to TS, returning the display port
 * @param atrans connection trans
 *
 */
enum SCP_SERVER_STATES_E
scp_v0s_allow_connection(struct trans *atrans, SCP_DISPLAY d,
                         const struct guid *guid);

/**
 *
 * @brief denies the connection to TS
 * @param atrans connection trans
 *
 */
enum SCP_SERVER_STATES_E
scp_v0s_deny_connection(struct trans *atrans);

/**
 * @brief send reply to an authentication request
 * @param atrans connection trans
 * @param value the reply code 0 means ok
 * @return
 */
enum SCP_SERVER_STATES_E
scp_v0s_replyauthentication(struct trans *atrans, unsigned short int value);

#endif