Blame include/freerdp/client/sshagent.h

Packit Service fa4841
/**
Packit Service fa4841
 * FreeRDP: A Remote Desktop Protocol Implementation
Packit Service fa4841
 * SSH Agent Virtual Channel Extension
Packit Service fa4841
 *
Packit Service fa4841
 * Copyright 2017 Ben Cohen
Packit Service fa4841
 *
Packit Service fa4841
 * Licensed under the Apache License, Version 2.0 (the "License");
Packit Service fa4841
 * you may not use this file except in compliance with the License.
Packit Service fa4841
 * You may obtain a copy of the License at
Packit Service fa4841
 *
Packit Service fa4841
 *     http://www.apache.org/licenses/LICENSE-2.0
Packit Service fa4841
 *
Packit Service fa4841
 * Unless required by applicable law or agreed to in writing, software
Packit Service fa4841
 * distributed under the License is distributed on an "AS IS" BASIS,
Packit Service fa4841
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit Service fa4841
 * See the License for the specific language governing permissions and
Packit Service fa4841
 * limitations under the License.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
#ifndef FREERDP_CHANNEL_CLIENT_SSHAGENT_H
Packit Service fa4841
#define FREERDP_CHANNEL_CLIENT_SSHAGENT_H
Packit Service fa4841
Packit Service fa4841
#include <freerdp/types.h>
Packit Service fa4841
Packit Service fa4841
#include <freerdp/message.h>
Packit Service fa4841
#include <freerdp/channels/cliprdr.h>
Packit Service fa4841
#include <freerdp/freerdp.h>
Packit Service fa4841
Packit Service fa4841
typedef struct _sshagent_client_context
Packit Service fa4841
{
Packit Service fa4841
	int ProtocolVersion;
Packit Service fa4841
	int MaxConnections;
Packit Service fa4841
} SSHAgentClientContext;
Packit Service fa4841
Packit Service fa4841
/*
Packit Service fa4841
 * The channel is defined by the sshagent channel in xrdp as follows.
Packit Service fa4841
 *
Packit Service fa4841
 * Server to client commands
Packit Service fa4841
 * -------------------------
Packit Service fa4841
 *
Packit Service fa4841
 * Capabilities (at start of channel stream):
Packit Service fa4841
 *
Packit Service fa4841
 *    INT32  SA_TAG_CAPABILITY
Packit Service fa4841
 *    INT32  SSHAGENT_CHAN_PROT_VERSION := 1
Packit Service fa4841
 *    INT32  SSHAGENT_MAX_CONNECTIONS
Packit Service fa4841
 *
Packit Service fa4841
 * Open connection:
Packit Service fa4841
 *
Packit Service fa4841
 *    INT32  SA_TAG_OPEN
Packit Service fa4841
 *    INT32  Connection id (0, ..., SSHAGENT_MAX_CONNECTIONS - 1)
Packit Service fa4841
 *
Packit Service fa4841
 * Send data:
Packit Service fa4841
 *
Packit Service fa4841
 *    INT32  SA_TAG_WRITE
Packit Service fa4841
 *    INT32  Connection id (0, ..., SSHAGENT_MAX_CONNECTIONS - 1)
Packit Service fa4841
 *    INT32  Data length
Packit Service fa4841
 *    DATA   ...
Packit Service fa4841
 *
Packit Service fa4841
 * Close connection:
Packit Service fa4841
 *
Packit Service fa4841
 *    INT32  SA_TAG_CLOSE
Packit Service fa4841
 *    INT32  Connection id (0, ..., SSHAGENT_MAX_CONNECTIONS - 1)
Packit Service fa4841
 *
Packit Service fa4841
 * Client to server commands
Packit Service fa4841
 * -------------------------
Packit Service fa4841
 *
Packit Service fa4841
 * Capabilities (in reply to server capabilities):
Packit Service fa4841
 *
Packit Service fa4841
 *    INT32  SA_TAG_CAPABILITY
Packit Service fa4841
 *    INT32  SSHAGENT_CHAN_PROT_VERSION := 1
Packit Service fa4841
 *    INT32  SSHAGENT_MAX_CONNECTIONS
Packit Service fa4841
 *
Packit Service fa4841
 * Send data:
Packit Service fa4841
 *
Packit Service fa4841
 *    INT32  SA_TAG_WRITE
Packit Service fa4841
 *    INT32  Connection id (0, ..., SSHAGENT_MAX_CONNECTIONS - 1)
Packit Service fa4841
 *    INT32  Data length
Packit Service fa4841
 *    DATA   ...
Packit Service fa4841
 *
Packit Service fa4841
 * Close connection (abnormal):
Packit Service fa4841
 *
Packit Service fa4841
 *    INT32  SA_TAG_CLOSE
Packit Service fa4841
 *    INT32  Connection id (0, ..., SSHAGENT_MAX_CONNECTIONS - 1)
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
#endif /* FREERDP_CHANNEL_CLIENT_SSHAGENT_H */