cf1c6cd395
Convert cygwin-api from using a sect2 element to using a refentry element for each function. This makes it possible to generate manpage-style output for those elements. Note that the chunked html now generates a page for each function, rather than one containing all functions. Also: Remove pointless and incorrect date Move introductory paragraph from the first section to the start of the chapter Add a funcsynopsisinfo element with the header file to be included to each function prototype Remove extern "C" which doesn't process into all formats successfully 2015-06-17 Jon Turney <jon.turney@dronecode.org.uk> * cygwin-api.xml: Move introductory paragraph here. * logon-funcs.xml: Convert from using a sect2 element to using a refentry element for each function. * misc-funcs.xml: Ditto. * path.xml: Ditto. Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
96 lines
3.0 KiB
XML
96 lines
3.0 KiB
XML
<?xml version="1.0" encoding='UTF-8'?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
|
|
|
|
<sect1 id="func-cygwin-login">
|
|
<title>Helper functions to change user context</title>
|
|
|
|
<refentry id="func-cygwin-logon_user">
|
|
<refmeta>
|
|
<refentrytitle>cygwin_logon_user</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="manual">Cygwin API Reference</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>cygwin_logon_user</refname>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <sys/cygwin.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>HANDLE
|
|
<function>cygwin_logon_user</function></funcdef>
|
|
<paramdef>const struct passwd *<parameter>passwd_entry</parameter></paramdef>
|
|
<paramdef>const char *<parameter>password</parameter></paramdef>
|
|
</funcprototype></funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>Given a pointer to a passwd entry of a user and a cleartext password,
|
|
returns a HANDLE to an impersonation token for this user which can be used
|
|
in a subsequent call to <function>cygwin_set_impersonation_token</function>
|
|
to impersonate that user. This function can only be called from a process
|
|
which has the required NT user rights to perform a logon.</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>See also</title>
|
|
<para>See also the chapter
|
|
<ulink url="../cygwin-ug-net/ntsec.html#ntsec-setuid-overview">Switching the user context</ulink>
|
|
in the Cygwin User's guide.</para>
|
|
|
|
<para>See also <link linkend="func-cygwin-set-impersonation-token">cygwin_set_impersonation_token</link></para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="func-cygwin-set-impersonation-token">
|
|
<refmeta>
|
|
<refentrytitle>cygwin_set_impersonation_token</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="manual">Cygwin API Reference</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>cygwin_set_impersonation_token</refname>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <sys/cygwin.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>void
|
|
<function>cygwin_set_impersonation_token</function></funcdef>
|
|
<paramdef>const HANDLE <parameter>token</parameter></paramdef>
|
|
</funcprototype></funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>Use this function to enable the token given as parameter as
|
|
impersonation token for the next call to <function>setuid</function> or
|
|
<function>seteuid</function>. Use
|
|
<function>cygwin_set_impersonation_token</function> together with
|
|
<function>cygwin_logon_user</function> to impersonate users using
|
|
password authentication.</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>See also</title>
|
|
<para>See also the chapter
|
|
<ulink url="../cygwin-ug-net/ntsec.html#ntsec-setuid-overview">Switching the user context</ulink>
|
|
in the Cygwin User's guide.</para>
|
|
|
|
<para>See also <link linkend="func-cygwin-logon_user">cygwin_logon_user</link></para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
</sect1>
|