/+---------------------------------------------------------------------------
//
//  Copyright (C) Intel Corporation, 2003 - 2007.
//
//  File:       README 
//
//  Contents:   a short description for developers
//
//----------------------------------------------------------------------------

User Notification Service
=========================

The Intel(R) Active Management Technology (Intel(R) AMT) User Notification Service (UNS) 
runs as a deamon on the host of a platform that also has Intel AMT enabled. 
The UNS receives messages from Intel AMT and write them to the local OS event log for the 
purpose of notifying end users of predefined events such as when critical System Defense 
policies are applied by the ME FW. 

The service is meant to be run as a daemon. Messages from the service will be
sent to the syslog. The UNS messages will be marked with a source of "Intel(R) AMT".

Required libraries/tools:
-------------------------
- gSOAP: Version 2.7.9h or newer
	http://www.cs.fsu.edu/~engelen/soap.html
- libcurl Version: 7.12.1 or newer
	http://curl.haxx.se/	
- OpenSSL: Version: 0.9.7a or newer
- libXML: Version: 2.6.16 or newer
- openwsman 1.1.0 or newer
	http://www.openwsman.org
- Xerces-C: Version 2.7.0 or newer

Building and installing the UNS:
-----------------------------
1. In order to build and install the UNS, you must first build the openwsman library.
   call: './configure --prefix=/usr'
         'make'
         'make install'
	 note: on 64bit systems add '--libdir=/usr/lib64' option to configure command
2. To build UNS call
         './configure'
         'make'
3. To install UNS call 'make install'.
4. To configure UNS to load upon system startup call 'chkconfig --add uns'
5. To start UNS as daemon call 'service uns start'

The UNS may also be built and run manually (not as a daemon), by first
calling 'make', then './uns'. This method doesn't load UNS upon startup,
so it may be better suited for testing purposes.

The service will be built in daemon mode by default, to override this setting invoke
the configure script with --enable-daemon=no option. In order to build the UNS in debug
mode it is required to build gSOAP in debug mode first. Otherwise, the compilation
of the service will fail. To enable the debug mode invoke the configure scipt with 
--enable-debug option.

Uninstalling the UNS:
-----------------------------
1. To stop UNS daemon call 'service uns stop'
2. To configure UNS not to load upon system startup call 'chkconfig --del uns'
3. Call 'make uninstall' to uninstall and remove the UNS.

Usage:
------
Usage: uns [OPTIONS]

Configuration options:
-unsUser Query for Username for local UN realm. See note 1.
-unsPass Query for Password for local UN realm. See note 1.
-eacUser Query for Username for local EAC realm. See note 1.
-eacPass Query for Password for local EAC realm. See note 1.
-cainfo  <file-name>	Full path to the root CA file.
-cert    <file-name>	Full path to the client certificate file.
-key	 <file-name>	Full path tp the client private key file.

Note 1. Some options are set in interactive mode. Please provide option value upon prompt.

Unce the program gets configuration options it will run in "update" mode only,
It will store the new configuration and will use them the next time it runs.

The service will run only if no command line parameters were given.



