Changeset 34563 in vbox for trunk/doc

Timestamp:

Dec 1, 2010 11:39:52 AM (14 years ago)

Author:

vboxsync

Message:

VRDPAuth -> VBoxAuth.

Location:

trunk/doc/manual/en_US

Files:

• SDKRef.xml (modified) (1 diff)
• user_AdvancedTopics.xml (modified) (4 diffs)
• user_Frontends.xml (modified) (1 diff)
• user_VBoxManage.xml (modified) (1 diff)

trunk/doc/manual/en_US/SDKRef.xml

@@ -428 +428 @@
 
         <para>By default, after installation, the web service uses the
-        VRDPAuth module that ships with VirtualBox. This module uses PAM on
+        VBoxAuth module that ships with VirtualBox. This module uses PAM on
         Linux hosts to authenticate users. Any valid username/password
         combination is accepted, it does not have to be the username and

trunk/doc/manual/en_US/user_AdvancedTopics.xml

@@ -787 +787 @@
       entry point:</para>
 
-      <screen>#include "VRDPAuth.h"
+      <screen>#include "VBoxAuth.h"
 
 /**
@@ -807 +807 @@
  * Return code:
  *
- *   VRDPAuthAccessDenied    Client access has been denied.
- *   VRDPAuthAccessGranted   Client has the right to use the
- *                           virtual machine.
- *   VRDPAuthDelegateToGuest Guest operating system must
- *                           authenticate the client and the
- *                           library must be called again with
- *                           the result of the guest
- *                           authentication.
+ *   AuthResultAccessDenied    Client access has been denied.
+ *   AuthResultAccessGranted   Client has the right to use the
+ *                             virtual machine.
+ *   AuthResultDelegateToGuest Guest operating system must
+ *                             authenticate the client and the
+ *                             library must be called again with
+ *                             the result of the guest
+ *                             authentication.
  */
-VRDPAuthResult VRDPAUTHCALL VRDPAuth2(
+AuthResult AUTHCALL AuthEntry(
+    const char *szCaller,
     PVRDPAUTHUUID pUuid,
     VRDPAuthGuestJudgement guestJudgement,
@@ -826 +827 @@
 {
     /* process request against your authentication source of choice */
-    return VRDPAuthAccessGranted;
+    return AuthResultAccessGranted;
 }</screen>
 
@@ -853 +854 @@
       <para>The second arguments contains information about the guest
       authentication status. For the first call, it is always set to
-      <computeroutput>VRDPAuthGuestNotAsked</computeroutput>. In case the
+      <computeroutput>AuthGuestNotAsked</computeroutput>. In case the
       function returns
-      <computeroutput>VRDPAuthDelegateToGuest</computeroutput>, a guest
+      <computeroutput>AuthResultDelegateToGuest</computeroutput>, a guest
       authentication will be attempted and another call to the method is made
       with its result. This can be either granted / denied or no judgement

trunk/doc/manual/en_US/user_Frontends.xml

@@ -388 +388 @@
             <computeroutput>VBoxManage setproperty vrdeauthlibrary "VBoxAuthSimple"</computeroutput>.
             To enable the library for a VM, switch authentication to external using
-            <computeroutput>VBoxManage modifyvm "VM name" --vrdpauthtype external</computeroutput>.
+            <computeroutput>VBoxManage modifyvm "VM name" --vrdeauthtype external</computeroutput>.
             Last but not least, you have to configure users and passwords. Here is an example
             for the user "john" with the password "secret":

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -941 +941 @@
 
           <listitem>
-            <para><computeroutput>--vrdpauthtype
+            <para><computeroutput>--vrdeauthtype
             null|external|guest</computeroutput>: This allows you to choose
             whether and how authorization will be performed; see <xref