diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog index 9198e545f..40b6a56f8 100644 --- a/winsup/doc/ChangeLog +++ b/winsup/doc/ChangeLog @@ -1,3 +1,10 @@ +2014-08-14 Corinna Vinschen + + * cygwin-api.xml: Move chapter tags from path.xml back here. + Include logon-funcs.xml. + * logon-funcs.xml: Moved from ../cygwin here and converted to XML. + * path.xml: Drop chapter tags. Create subsections. + 2014-08-14 Corinna Vinschen * Makefile.in: Throughout use parenthesis instead of braces where diff --git a/winsup/doc/cygwin-api.xml b/winsup/doc/cygwin-api.xml index a3b9fe102..498594792 100644 --- a/winsup/doc/cygwin-api.xml +++ b/winsup/doc/cygwin-api.xml @@ -13,6 +13,13 @@ - + + + Cygwin Functions + + + + + diff --git a/winsup/doc/logon-funcs.xml b/winsup/doc/logon-funcs.xml new file mode 100644 index 000000000..9e32ad626 --- /dev/null +++ b/winsup/doc/logon-funcs.xml @@ -0,0 +1,56 @@ + + + + +Helper functions to change user context + + +cygwin_logon_user + + +extern "C" HANDLE +cygwin_logon_user +const struct passwd *passwd_entry +const char *password + + +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 cygwin_set_impersonation_token +to impersonate that user. This function can only be called from a process +which has the required NT user rights to perform a logon. + +See also the chapter +Switching the user context +in the Cygwin User's guide. + +See also cygwin_set_impersonation_token + + + + +cygwin_set_impersonation_token + + +extern "C" void +cygwin_set_impersonation_token +const HANDLE token + + +Use this function to enable the token given as parameter as +impersonation token for the next call to setuid or +seteuid. Use +cygwin_set_impersonation_token together with +cygwin_logon_user to impersonate users using +password authentication. + +See also the chapter +Switching the user context +in the Cygwin User's guide. + +See also cygwin_logon_user + + + + diff --git a/winsup/doc/path.xml b/winsup/doc/path.xml index b8cfb920b..06a252bb0 100644 --- a/winsup/doc/path.xml +++ b/winsup/doc/path.xml @@ -1,14 +1,14 @@ - - -Cygwin Functions + +Path conversion functions These functions are specific to Cygwin itself, and probably won't be found anywhere else. - + cygwin_conv_path @@ -84,9 +84,9 @@ else - + - + cygwin_conv_path_list @@ -111,9 +111,9 @@ convert it to the equivalent POSIX $PATH-style string (i.e. /foo:/bar). See also cygwin_conv_path - + - + cygwin_create_path @@ -140,9 +140,9 @@ errno can be set to the below value. See also cygwin_conv_path - + - + cygwin_posix_path_list_p @@ -159,9 +159,9 @@ true if the path is a POSIX path. Note that "_p" means "predicate", a lisp term meaning that the function tells you something about the parameter. - + - + cygwin_split_path @@ -185,6 +185,6 @@ cygwin_split_path("c:/foo/bar.c", dir, file); printf("dir=%s, file=%s\n", dir, file); - + - +