Brought up to date the README and TODO files.

2006-10-10 14:47:19 +00:00
parent ac412cb2cd
commit 18e290e209
28 changed files with 567 additions and 64 deletions
--- a/CASA-auth-token/non-java/server/AuthTokenValidate/README
+++ b/CASA-auth-token/non-java/server/AuthTokenValidate/README
@@ -1,3 +1,26 @@
+/***********************************************************************
+ * 
+ *  Copyright (C) 2006 Novell, Inc. All Rights Reserved.
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License as published by the Free Software Foundation; version 2.1
+ *  of the License.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Library Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, Novell, Inc.
+ * 
+ *  To contact Novell about this file by physical or electronic mail, 
+ *  you may find current contact information at www.novell.com.
+ * 
+ *  Author: Juan Carlos Luciani <jluciani@novell.com>
+ *
+ ***********************************************************************/
 /***********************************************************************
 *
 *  README for libcasa_s_authtoken
@@ -16,9 +39,8 @@ module to perform the credential validation. To facilitate this, CASA Authentica
 provides PAM, Apache, and JAAS modules that can be used to validate credentials containing
 CASA Authentication tokens,

-CONFIGURING TRUSTED AUTHENTICATION TOKEN SERVICES
-
-tbd. Add info about the installation of public certificates and trusted certificate authorities.
+libcasa_s_authtoken relies on the CasaAuthtokenValidateD service in order to perform its
+functions. To learn more about CasaAuthtokenValidateD see the Svc folder.

 CONFIGURING ADDITIONAL IDENTITY TOKEN PROVIDER MODULES

@@ -30,7 +52,7 @@ is configured for CASA Authentication. The default identity token type is CasaId
 libcasa_s_authtoken supports different identity token types through an API that allows for the
 configuration of different Identity Token Provider plug-ins. An Identity Token Provider plug-in
 is configured by placing a configuration file for the plug-ins in the
-/etc/opt/CASA/authtoken.d/modules.d folder. The name of the plug-in configuration file is related
+/etc/CASA/authtoken.d/modules.d folder. The name of the plug-in configuration file is related
 to the identity token type in the following manner: IdentityTokenTypeName.conf.

 Identity Token Provider plug-in configuration files must must contain a directive indicating the
--- a/CASA-auth-token/non-java/server/AuthTokenValidate/Svc/README
+++ b/CASA-auth-token/non-java/server/AuthTokenValidate/Svc/README
@@ -0,0 +1,80 @@
+/***********************************************************************
+ * 
+ *  Copyright (C) 2006 Novell, Inc. All Rights Reserved.
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License as published by the Free Software Foundation; version 2.1
+ *  of the License.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Library Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, Novell, Inc.
+ * 
+ *  To contact Novell about this file by physical or electronic mail, 
+ *  you may find current contact information at www.novell.com.
+ * 
+ *  Author: Juan Carlos Luciani <jluciani@novell.com>
+ *
+ ***********************************************************************/
+/***********************************************************************
+ *
+ *  README for CasaAuthtokenValidateD
+ *
+ ***********************************************************************/
+
+INTRODUCTION
+
+CasaAuthtokenValidateD provides a service that is utilized by libcasa_s_authtoken
+for the validation of CASA Authentication Tokens.
+
+Processes executing libcasa_s_authtoken communicate with CasaAuthTokenValidateD via
+domain sockets. CasaAuthTokenValidateD validates authentication tokens by invoking
+the appropriate CASA Authentication Token Java classes.
+
+COMMAND LINE PARAMETERS
+
+CasaAuthtokenValidateD has the following command line parameters:
+
+   -b BeginThreads
+
+      Optional parameter that specifies the initial number of threads utilized by the
+      service to process requests.
+
+   -g GrowThreads
+
+      Optional parameter that specifies the number of threads by which the service can
+      grow its thread pool utilized for processing requests.
+
+   -m MaxThreads
+
+      Optional parameter that specifies the maximum number of threads that the service
+      can have in its thread pool for processing requests.
+
+   -D DebugLevel
+
+      Optional parameter that specifies the level used for logging debugging information.
+      0 being the lowest debug level.
+
+   -d
+      Optional parameter that specifies that the service must be run as a daemon.
+
+SECURITY CONSIDERATIONS
+
+Appropriate rights need to be set on the folder used by CasaAuthtokenValidateD to
+create its listeing socket to keep other services from hijacking it and taking on
+the validation of CASA authentication sockets. CasaAuthtokenValidateD creates its
+listen socket in the /var/lib/CASA/authtoken/validate/ folder.
+
+
+
+                
+
+
+
+
+
--- a/CASA-auth-token/non-java/server/AuthTokenValidate/Svc/TODO
+++ b/CASA-auth-token/non-java/server/AuthTokenValidate/Svc/TODO
@@ -0,0 +1,13 @@
+/***********************************************************************
+ *
+ *  TODO for CasaAuthtokenValidateD
+ *
+ ***********************************************************************/
+
+INTRODUCTION
+
+This file contains a list of the items still outstanding for CasaAuthtokenValidateD.
+
+OUTSTANDING ITEMS
+
+None.
--- a/CASA-auth-token/non-java/server/AuthTokenValidate/TODO
+++ b/CASA-auth-token/non-java/server/AuthTokenValidate/TODO
@@ -10,6 +10,4 @@ This file contains a list of the items still outstanding for libcasa_s_authtoken

 OUTSTANDING ITEMS

- Change AuthTokens to be SOAP messages secured with WS-Security and WS-Trust.
- Implement CheckAuthToken().
- Finish README documentation.
+None.
--- a/CASA-auth-token/non-java/server/AuthTokenValidate/idenTokenProviders/casa/README
+++ b/CASA-auth-token/non-java/server/AuthTokenValidate/idenTokenProviders/casa/README
@@ -1,3 +1,26 @@
+/***********************************************************************
+ * 
+ *  Copyright (C) 2006 Novell, Inc. All Rights Reserved.
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License as published by the Free Software Foundation; version 2.1
+ *  of the License.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Library Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, Novell, Inc.
+ * 
+ *  To contact Novell about this file by physical or electronic mail, 
+ *  you may find current contact information at www.novell.com.
+ * 
+ *  Author: Juan Carlos Luciani <jluciani@novell.com>
+ *
+ ***********************************************************************/
 /***********************************************************************
 *
 *  README for casa_identoken