Imported Upstream version 2.5.2p1

[debian/amanda] / docs / security-api.txt

diff --git a/docs/security-api.txt b/docs/security-api.txt
index 8184b9799ccaed09866e52db1b90c2494c1624a3..e0c4a839ed3904e5dd0a1f9f642ee2e0051db53d 100644 (file)
--- a/docs/security-api.txt
+++ b/docs/security-api.txt
@@ -1,10 +1,10 @@
 
-      Chapter 24. AMANDA Security API
+      Chapter 26. Amanda Security API
 Prev  Part V. Technical Background  Next
 
 -------------------------------------------------------------------------------
 
-Chapter 24. AMANDA Security API
+Chapter 26. Amanda Security API
 
 
 Mike Grupenhoff
@@ -82,34 +82,29 @@ Table of Contents
 
 
 
-Note
-
-Refer to http://www.amanda.org/docs/security-api.html for the current version
-of this document.
-
  Introduction
 
 This is a document of the API for defining and utilizing multiple security and
-transport mechanisms for the AMANDA network protocol.
+transport mechanisms for the Amanda network protocol.
 The goal of this API is to allow several different forms of communication and
-authentication to exist between the AMANDA server and its clients.
+authentication to exist between the Amanda server and its clients.
 
  The Problem
 
 There exist many potential ways that a user might wish to grant access to the
-AMANDA daemon. The two currently supported are BSD (reserved port) and Kerberos
+Amanda daemon. The two currently supported are BSD (reserved port) and Kerberos
 IV security. The current implementation of these two methods is not very
 general, and adding additional methods requires a large amount of code to be
 modified.
 Additionally, the current methods require the protocol and dump transport to be
-transmitted across the network using a pre-defined method. The AMANDA protocol
+transmitted across the network using a pre-defined method. The Amanda protocol
 currently must be sent using udp datagrams to a well-known port, and the dumps
 are transported using tcp connections between ports negotiated via the
 protocol.
 
  The API
 
-The security API was designed to be a layer in between the core logic of AMANDA
+The security API was designed to be a layer in between the core logic of Amanda
 and the transport and authentication of the protocol and dumps.
 The component server and client programs now deal with abstract concepts
 instead of concrete udp and tcp handles.
@@ -136,7 +131,7 @@ Given a security driver, and a hostname, calls back with a security_handle_t
 (section 4.2) that can be used to communicate with that host. The status arg to
 the callback is reflects the success of the request. Error messages can be had
 via security_geterror().
-This is expected to be the AMANDA server's interface for setting up connections
+This is expected to be the Amanda server's interface for setting up connections
 to clients.
 conf_fn is used to determine configuration information. If NULL, no
 configuration information is available.
@@ -149,8 +144,8 @@ Given a security driver, an input file descriptor, and an output file
 descriptor, and a callback, when new connections are detected on the given file
 descriptors, the function is called with a newly created security handle and
 the initial packet received.
-This is expected to be the AMANDA daemon's interface for setting up incoming
-connections from the AMANDA server. The file descriptors are typically 0 and 1
+This is expected to be the Amanda daemon's interface for setting up incoming
+connections from the Amanda server. The file descriptors are typically 0 and 1
 (stdin/stdout).
 This function uses the event interface, and only works properly when event_loop
 () is called later in the program.
@@ -440,8 +435,13 @@ Implementation of security_stream_read.
 
 void (*stream_read_cancel)(void *stream);
 Implementation of security_stream_read_cancel.
+
+Note
+
+Refer to http://www.amanda.org/docs/security-api.html for the current version
+of this document.
 -------------------------------------------------------------------------------
 
 Prev                           Up                           Next
-Chapter 23. AMANDA Event API  Home  Chapter 25. Virtual Tape API
+Chapter 25. Amanda Event API  Home  Chapter 27. Virtual Tape API