uLab
/
xrdp-proprietary
mirror of https://mirror.git.trinitydesktop.org/gitea/uLab/xrdp-proprietary
0
0
Fork 0
Code Issues Releases Wiki Activity

updated code documentation

Browse Source
ulab-original
ilsimo 19 years ago
parent bff658c96b
commit 013ab3c61f
21 changed files with 417 additions and 111 deletions
Show Stats Download Patch File Download Diff File

222
sesman/Doxyfile
Unescape View File

@ -0,0 +1,222 @@
# Doxyfile 1.4.4
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = xrdp/sesman
PROJECT_NUMBER = 0.2.0
OUTPUT_DIRECTORY = ../docs/sesman
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = NO
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = NO
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
DISTRIBUTE_GROUP_DOC = NO
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
SUBGROUPING = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = NO
EXTRACT_LOCAL_METHODS = NO
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = YES
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT =
FILE_PATTERNS =
RECURSIVE = NO
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = NO
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = NO
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 1024
MAX_DOT_GRAPH_HEIGHT = 1024
MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO

10
sesman/access.c
Unescape View File

@ -15,9 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
authenticate user
/**
*
* @file access.c
* @brief User access control code
* @author Simone Fedele
*
*/
#include "sesman.h"
@ -25,7 +30,6 @@
extern struct config_sesman g_cfg;
/******************************************************************************/
/* returns non zero if allowed */
int DEFAULT_CC
access_login_allowed(char* user)
{

12
sesman/access.h
Unescape View File

@ -15,8 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
session manager - access control header
/**
*
* @file access.h
* @brief User access control definitions
* @author Simone Fedele
*
*/
#ifndef ACCESS_H
@ -24,7 +30,9 @@
/**
*
*
* @brief Checks if the user is allowed to access the terminal server
* @param user the user to check
* @return 0 if access is denied, !=0 if allowed
*
*/
int DEFAULT_CC

41
sesman/auth.h
Unescape View File

@ -15,19 +15,58 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
session manager - main header
/**
*
* @file auth.h
* @brief User authentication definitions
* @author Jay Sorg
*
*/
#ifndef AUTH_H
#define AUTH_H
/**
*
* @brief Validates user's password
* @param user user's login name
* @param pass user's password
* @return 0 on success, 1 on failure
*
*/
long DEFAULT_CC
auth_userpass(char* user, char* pass);
/**
*
* @brief FIXME
* @param in_val
* @param in_display
* @return 0 on success, 1 on failure
*
*/
int DEFAULT_CC
auth_start_session(long in_val, int in_display);
/**
*
* @brief FIXME
* @param in_val
* @return 0 on success, 1 on failure
*
*/
int DEFAULT_CC
auth_end(long in_val);
/**
*
* @brief FIXME
* @param in_val
* @return 0 on success, 1 on failure
*
*/
int DEFAULT_CC
auth_set_env(long in_val);

16
sesman/config.c
Unescape View File

@ -15,8 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
session manager - read config file
/**
*
* @file config.c
* @brief User authentication code
* @author Simone Fedele @< simo [at] esseemme [dot] org @>
*
*/
#include "arch.h"
@ -25,6 +31,13 @@
#include "sesman.h"
/******************************************************************************/
/**
*
* @brief Reads sesman configuration
* @param s translates the strings "1", "true" and "yes" in 1 (true) and other strings in 0
* @return 0 on success, 1 on failure
*
*/
static int APP_CC
text2bool(char* s)
{
@ -38,7 +51,6 @@ text2bool(char* s)
}
/******************************************************************************/
/* returns error */
int DEFAULT_CC
config_read(struct config_sesman* cfg)
{

56
sesman/config.h
Unescape View File

@ -15,8 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
session manager - read config file
/**
*
* @file config.h
* @brief User authentication definitions
* @author Simone Fedele @< simo [at] esseemme [dot] org @>
*
*/
#ifndef CONFIG_H
@ -63,7 +69,7 @@
/**
*
* @struct config_security
* @brief \t struct that contains \t sesman access control configuration
* @brief struct that contains sesman access control configuration
*
*/
struct config_security
@ -90,7 +96,7 @@ struct config_security
/**
*
* @struct config_sessions
* @brief \t struct that contains \t sesman session handling configuration
* @brief struct that contains sesman session handling configuration
*
*/
struct config_sessions
@ -120,11 +126,11 @@ struct config_sessions
/**
*
* @struct config_sesman
* @brief \t struct that contains \t sesman configuration
* @brief struct that contains sesman configuration
*
* This \t struct contains all of \t sesman configuration parameters\n
* Every parameter in \t [globals] is a member of this struct, other
* sections options are embedded in this \t struct as member structures
* This struct contains all of sesman configuration parameters\n
* Every parameter in [globals] is a member of this struct, other
* sections options are embedded in this struct as member structures
*
*/
struct config_sesman
@ -151,17 +157,17 @@ struct config_sesman
char user_wm[32];
/**
* @var log
* @brief Log configuration \t struct
* @brief Log configuration struct
*/
struct log_config log;
/**
* @var sec
* @brief Security configuration options \t struct
* @brief Security configuration options struct
*/
struct config_security sec;
/**
* @var sess
* @brief Session configuration options \t struct
* @brief Session configuration options struct
*/
struct config_sessions sess;
};
@ -169,9 +175,7 @@ struct config_sesman
/**
*
* @brief Reads sesman configuration
*
* @param cfg pointer to configuration object to be replaced
*
* @return 0 on success, 1 on failure
*
*/
@ -181,9 +185,10 @@ config_read(struct config_sesman* cfg);
/**
*
* @brief Reads sesman [global] configuration section
*
* @param cfg pointer to configuration object to be replaced
*
* @param file configuration file descriptor
* @param cf pointer to a config struct
* @param param_n parameter name list
* @param param_v parameter value list
* @return 0 on success, 1 on failure
*
*/
@ -194,9 +199,10 @@ config_read_globals(int file, struct config_sesman* cf,
/**
*
* @brief Reads sesman [logging] configuration section
*
* @param cfg pointer to configuration object to be replaced
*
* @param file configuration file descriptor
* @param lc pointer to a log_config struct
* @param param_n parameter name list
* @param param_v parameter value list
* @return 0 on success, 1 on failure
*
*/
@ -207,9 +213,10 @@ config_read_logging(int file, struct log_config* lc, struct list* param_n,
/**
*
* @brief Reads sesman [Security] configuration section
*
* @param cfg pointer to configuration object to be replaced
*
* @param file configuration file descriptor
* @param sc pointer to a config_security struct
* @param param_n parameter name list
* @param param_v parameter value list
* @return 0 on success, 1 on failure
*
*/
@ -220,9 +227,10 @@ config_read_security(int file, struct config_security* sc,
/**
*
* @brief Reads sesman [Sessions] configuration section
*
* @param cfg pointer to configuration object to be replaced
*
* @param file configuration file descriptor
* @param ss pointer to a config_sessions struct
* @param param_n parameter name list
* @param param_v parameter value list
* @return 0 on success, 1 on failure
*
*/

3
sesman/env.c
Unescape View File

@ -15,9 +15,6 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
session manager
linux only
*/
/**

7
sesman/env.h
Unescape View File

@ -15,9 +15,6 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
session manager
linux only
*/
/**
@ -34,10 +31,8 @@
/**
*
* @brief Creates vnc password file
*
* @param filename VNC password file name
* @param password The password to be encrypte
*
* @return 0 on success, 1 on error
*
*/
@ -47,11 +42,9 @@ env_check_password_file(char* filename, char* password);
/**
*
* @brief Sets user environment ($PATH, $HOME, $UID, and others)
*
* @param username Username
* @param passwd_file VNC password file
* @param display The session display
*
* @return 0 on success, g_getuser_info() error codes on error
*
*/

16
sesman/sesman.c
Unescape View File

@ -15,10 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
session manager
linux only
/**
*
* @file sesman.c
* @brief Main program file
* @author Jay Sorg
*
*/
#include "sesman.h"
@ -35,8 +39,7 @@ struct config_sesman g_cfg; /* config.h */
/**
*
* trigger when a child process (a session) dies
*
* @brief triggered when a child process (a session) dies
* @param s received signal
*
*/
@ -70,9 +73,10 @@ cterm(int s)
}
}
/******************************************************************************/
/**
*
* Starts sesman main loop
* @brief Starts sesman main loop
*
*/
static void DEFAULT_CC

8
sesman/sesman.h
Unescape View File

@ -15,8 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
session manager - main header
/**
*
* @file sesman.h
* @brief Main include file
* @author Jay Sorg
*
*/
#ifndef SESMAN_H

10
sesman/sesrun.c
Unescape View File

@ -15,10 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
session manager
linux only
/**
*
* @file sesrun.c
* @brief An utility to start a session
* @author Jay Sorg, Simone Fedele
*
*/
#include "sesman.h"

19
sesman/session.c
Unescape View File

@ -15,10 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
session manager
linux only
/**
*
* @file session.c
* @brief Session management code
* @author Jay Sorg, Simone Fedele
*
*/
#include "sesman.h"
@ -75,7 +79,13 @@ session_get_bydata(char* name, int width, int height, int bpp)
}
/******************************************************************************/
/* returns non zero if there is an xserver running on this display */
/**
*
* @brief checks if there's a server running on a display
* @param display the display to check
* @return 0 if there isn't a display running, nonzero otherwise
*
*/
static int DEFAULT_CC
x_server_running(int display)
{
@ -115,7 +125,6 @@ x_server_running(int display)
}
/******************************************************************************/
/* returns 0 if error else the display number the session was started on */
int DEFAULT_CC
session_start(int width, int height, int bpp, char* username, char* password,
long data, unsigned char type)

27
sesman/session.h
Unescape View File

@ -15,12 +15,17 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
session manager
linux only
/**
*
* @file session.h
* @brief Session management definitions
* @author Jay Sorg, Simone Fedele
*
*/
#ifndef SESSION_H
#define SESSION_H
@ -66,8 +71,7 @@ struct session_chain
/**
*
* finds a session matching the supplied parameters
*
* @brief finds a session matching the supplied parameters
* @return session data or 0
*
*/
@ -79,8 +83,7 @@ session_get_bydata(char* name, int width, int height, int bpp);
/**
*
* starts a session
*
* @brief starts a session
* @return 0 on error, display number if success
*
*/
@ -90,10 +93,8 @@ session_start(int width, int height, int bpp, char* username, char* password,
/**
*
* kills a session
*
* @param the id of the session to be killed
*
* @brief kills a session
* @param pid the pid of the session to be killed
* @return
*
*/
@ -102,10 +103,8 @@ session_kill(int pid);
/**
*
* retrieves a session's descriptor
*
* @brief retrieves a session's descriptor
* @param pid the session pid
*
* @return a pointer to the session descriptor on success, NULL otherwise
*
*/

4
sesman/sig.c
Unescape View File

@ -15,9 +15,6 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
session manager
linux only
*/
/**
@ -76,4 +73,3 @@ sig_sesman_reload_cfg(int sig)
log_message(LOG_LEVEL_INFO, "configuration reloaded");
}

5
sesman/sig.h
Unescape View File

@ -15,9 +15,6 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
session manager
linux only
*/
/**
@ -34,7 +31,6 @@
/**
*
* @brief Shutdown signal code
*
* @param sig The received signal
*
*/
@ -44,7 +40,6 @@ sig_sesman_shutdown(int sig);
/**
*
* @brief SIGHUP handling code
*
* @param sig The received signal
*
*/

3
sesman/tcp.c
Unescape View File

@ -15,9 +15,6 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
session manager
linux only
*/
/**

7
sesman/tcp.h
Unescape View File

@ -15,9 +15,6 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
session manager
linux only
*/
/**
@ -34,11 +31,9 @@
/**
*
* @brief Force receiving data from tcp stream
*
* @param sck The socket to read from
* @param data Data buffer
* @param len Data buffer size
*
* @return 0 on success, 1 on error
*
*/
@ -48,11 +43,9 @@ tcp_force_recv(int sck, char* data, int len);
/**
*
* @brief Force sending data to tcp stream
*
* @param sck the socket to write to
* @param data Data buffer
* @param len Data buffer size
*
* @return 0 on success, 1 on error
*
*/

9
sesman/verify_user.c
Unescape View File

@ -15,9 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
authenticate user
/**
*
* @file verify_user.c
* @brief Authenticate user using standard unix passwd/shadow system
* @author Jay Sorg
*
*/
#include "sesman.h"

9
sesman/verify_user_kerberos.c
Unescape View File

@ -15,9 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
authenticate user using kerberos
/**
*
* @file verify_user_kerberos.c
* @brief Authenticate user using kerberos
* @author Jay Sorg
*
*/
#include "arch.h"

9
sesman/verify_user_pam.c
Unescape View File

@ -15,9 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
authenticate user
/**
*
* @file verify_user_pam.c
* @brief Authenticate user using pam
* @author Jay Sorg
*
*/
#include "arch.h"

9
sesman/verify_user_pam_userpass.c
Unescape View File

@ -15,9 +15,14 @@
xrdp: A Remote Desktop Protocol server.
Copyright (C) Jay Sorg 2005-2006
*/
authenticate user
/**
*
* @file verify_user_pam_userpass.c
* @brief Authenticate user using pam_userpass module
* @author Jay Sorg
*
*/
#include "arch.h"

Write Preview
Loading…
Cancel
Save