Mercurial > hg > freeDiameter

changeset 660:a8269458d5b1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated documentation
author Sebastien Decugis <sdecugis@nict.go.jp>
date Fri, 14 Jan 2011 16:25:59 +0900
parents 8556139321b3
children c242cba52833
files INSTALL INSTALL.FreeBSD INSTALL.Ubuntu LICENSE README contrib/OpenWRT/packages/freeDiameter/Makefile contrib/debian/changelog contrib/debian/control contrib/debian/copyright
diffstat 9 files changed, 71 insertions(+), 38 deletions(-) [+]
line wrap: on
line diff
--- a/INSTALL	Fri Jan 14 15:22:22 2011 +0900
+++ b/INSTALL	Fri Jan 14 16:25:59 2011 +0900
@@ -31,7 +31,7 @@
 # cmake -DBUILD_TESTING:BOOL=OFF ../
 # make
 
-When the tests are not disabled, you can run them with:
+When the tests are enabled, you can run them with:
 # make tests
 
 See the INSTALL.* files for additional platform-specific information.
--- a/INSTALL.FreeBSD	Fri Jan 14 15:22:22 2011 +0900
+++ b/INSTALL.FreeBSD	Fri Jan 14 16:25:59 2011 +0900
@@ -25,7 +25,7 @@
     # cd /usr/ports/devel/cmake
     # make install
     
- b) or from package (don't forget to set your PACKAGEROOT appropriately: set PACKAGEROOT=ftp://ftp.jp.freebsd.org):
+ b) or from package (don't forget to set your PACKAGEROOT appropriately. Ex: set PACKAGEROOT=ftp://ftp.jp.freebsd.org):
     # pkg_add -v -r cmake
 	
  
@@ -95,7 +95,7 @@
    TEST_APP_ACCT_CONNINFO:STRING="user=root dbname=root"
    
 4) run the test
-  # freeDiameter/tests/testappacct -d
+  # tests/testappacct -d
   or
   # make test
   
--- a/INSTALL.Ubuntu	Fri Jan 14 15:22:22 2011 +0900
+++ b/INSTALL.Ubuntu	Fri Jan 14 16:25:59 2011 +0900
@@ -72,7 +72,7 @@
 
 freeDiameter has been tested on the following distributions (compiled from source as described bellow):
 Ubuntu Intrepid, Jaunty, Karmic, Lucid, Maverick, Natty. 
-Debian Lenny.
+Debian Lenny (with small patch, see ticket #24).
 
 Ubuntu Hardy support is known to be broken.
 
--- a/LICENSE	Fri Jan 14 15:22:22 2011 +0900
+++ b/LICENSE	Fri Jan 14 16:25:59 2011 +0900
@@ -2,7 +2,7 @@
 
 Software License Agreement (BSD License)
 
-Copyright (c) 2009, WIDE Project and NICT
+Copyright (c) 2008-2011, WIDE Project and NICT
 All rights reserved.
 
 Redistribution and use of this software in source and binary forms, with or without modification, are 
@@ -34,11 +34,18 @@
 
 
 
-The following files have been contributed by Alexandre Westfahl, see source files for copyright information:
+The following authors have contributed the following files. See source files for copyright information.
+
+ * Alexandre Westfahl:
   extensions/dict_sip/*
   extensions/app_sip/*
   extensions/app_radgw/rgwx_sip.c
 
-The following files have been contributed by Souheil Ben Ayed, see source files for copyright information:
-   extensions/app_diameap/*
+ * Souheil Ben Ayed:
+  extensions/app_diameap/*
 
+ * Francois Bard:
+  extensions/dict_mip6a/*
+  extensions/dict_mip6i/*
+  extensions/dict_nas_mipv6/*
+  extensions/dict_rfc5777/*
--- a/README	Fri Jan 14 15:22:22 2011 +0900
+++ b/README	Fri Jan 14 16:25:59 2011 +0900
@@ -11,17 +11,23 @@
 
 
 The implementation consists in several components:
- - libfreeDiameter : the shared library provides the functions to manipulate Diameter
-      messages and dictionary. This library is meant to be re-used for other projects
+ - libfdproto : this shared library provides the functions to manipulate Diameter
+      messages and dictionary. This library is meant to be re-used by other projects
       that would require parsing or manipulating Diameter messages.
       
- - freeDiameterd : the daemon establishes the network connections with other Diameter
-      peers and performs the tasks described in Diameter Base Protocol, such as
-      watchdogs, basic routing, ...
+ - libfdcore : this shared library contains the core of the framework. It establishes 
+      the network connections with other Diameter peers and performs the tasks described 
+      in Diameter Base Protocol, such as watchdogs, basic routing, ... It also handles 
+      the loading of extensions (see bellow).
+      
+ - freeDiameterd : this simple daemon parses the command line and initializes the
+      freeDiameter framework. Use it for your Diameter server & agent components.
+      In case of Diameter clients, you probably will prefer linking the libfdcore 
+      directly with your client application that must be made Diameter-aware.
       
  - extensions : the extensions provide the mean to augment the features of the
-      freeDiameterd daemon. Extensions can provide the handling of a Diameter 
-      application, but also advanced routing features, peer management, etc.
+      freeDiameterd framework. Extensions can provide the handling of a Diameter 
+      server application, but also advanced routing features, peer management, etc.
 
 
 See http://www.freediameter.net/ for more information on the project.
--- a/contrib/OpenWRT/packages/freeDiameter/Makefile	Fri Jan 14 15:22:22 2011 +0900
+++ b/contrib/OpenWRT/packages/freeDiameter/Makefile	Fri Jan 14 16:25:59 2011 +0900
@@ -10,7 +10,7 @@
 include $(TOPDIR)/rules.mk
 
 PKG_NAME:=freeDiameter
-PKG_REV:=578
+PKG_REV:=660
 PKG_VERSION:=r$(PKG_REV)
 PKG_RELEASE:=1
 
--- a/contrib/debian/changelog	Fri Jan 14 15:22:22 2011 +0900
+++ b/contrib/debian/changelog	Fri Jan 14 16:25:59 2011 +0900
@@ -1,3 +1,15 @@
+freediameter (1.1.0) UNRELEASED; urgency=low
+
+  * Source package restructured. Most of the 
+    framework now contained in the libfdcore library.
+    libfreeDiameter renamed as libfdproto.
+    This closes #15.
+  * API version bumped to version 4 accordingly.
+  * Improved fd_dict_new() when the same object already exists.
+  * Improvements to dict_legacy_xml extension.
+
+ -- Sebastien Decugis <sdecugis@nict.go.jp>  Fri, 14 Jan 2011 16:04:41 +0900
+
 freediameter (1.0.4) UNRELEASED; urgency=low
 
   * Added new API to specify timeout on receiving answer (#10) 
--- a/contrib/debian/control	Fri Jan 14 15:22:22 2011 +0900
+++ b/contrib/debian/control	Fri Jan 14 16:25:59 2011 +0900
@@ -13,16 +13,24 @@
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: The freeDiameter libraries.
- This package contains the libraries required by all freeDiameter components.
+ This package contains the freeDiameter framework core libraries, 
+ required by all freeDiameter components.
  It may also be useful for other projects which need to 
  perform operations on Diameter messages. 
  .
+ The freeDiameter framework provides support for the Diameter
+ Base Protocol. Without any extension, the framework can only
+ be used as a Diameter routing agent. You probably want to 
+ install some freeDiameter extension(s) to extend its 
+ features, and also the freediameter-daemon package that
+ will initialize the framework for you.
+ .
  See 'freeDiameter-dev' package to retrieve the API for the library.
 
 Package: freediameter-dev
 Architecture: any
 Section: contrib/devel
-Depends: freediameter-daemon (= ${binary:Version}), libsctp-dev, libgnutls-dev, libgcrypt-dev
+Depends: freediameter-common (= ${binary:Version}), libsctp-dev, libgnutls-dev, libgcrypt-dev
 Description: This package provides the development files for freeDiameter.
 
 Package: freediameter-daemon
@@ -31,20 +39,15 @@
 Suggests: ssl-cert, freediameter-dictionary-rfc4005, freediameter-dictionary-rfc4072, freediameter-dictionary-rfc4740,
   freediameter-dictionary-mip6, freediameter-dictionary-legacy
 Description: The freeDiameter daemon. 
- The freeDiameter daemon provides support for the Diameter
- Base Protocol. Without any extension, the daemon can only
- be used as a Diameter routing agent. You probably want to 
- install some freeDiameter extension(s) to extend its 
- features.
- .
- The daemon is shipped with a small set of extensions, for
+ This daemon is a simple loader for the freeDiameter framework.
+ It is shipped with a small set of extensions, for
  example to configure the routing behavior. See the 
- examples for more details.
+ examples in /usr/share/freediameter* for more details.
 
 Package: freediameter-debug-tools
 Architecture: any
 Section: contrib/debug
-Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version})
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
 Suggests: python, libmysqlclient16
 Description: freeDiameter debug tools.
  This package provides useful tools to help tracking 
@@ -54,7 +57,7 @@
 
 Package: freediameter-dictionary-rfc4005
 Architecture: any
-Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version})
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
 Description: RFC4005 (NASREQ) dictionary support.
  This freeDiameter extension provides the dictionary support
  for commands and AVP defined in RFC4005 (NASREQ).
@@ -67,7 +70,7 @@
 
 Package: freediameter-dictionary-rfc4072
 Architecture: any
-Depends: ${misc:Depends}, freediameter-dictionary-rfc4005 (= ${binary:Version})
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), freediameter-dictionary-rfc4005 (= ${binary:Version})
 Description: RFC4072 (Diameter EAP) dictionary support.
  This freeDiameter extension provides the dictionary support
  for commands and AVP defined in RFC4072 (Diameter EAP).
@@ -80,7 +83,7 @@
 
 Package: freediameter-dictionary-rfc4740
 Architecture: any
-Depends: ${misc:Depends}
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
 Description: RFC4740 (Diameter SIP) dictionary support.
  This freeDiameter extension provides the dictionary support
  for commands and AVP defined in RFC4740 (Diameter SIP).
@@ -93,7 +96,7 @@
 
 Package: freediameter-dictionary-mip6
 Architecture: any
-Depends: ${misc:Depends}
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
 Description: Diameter Mobile IPv6 application dictionary support.
  This package contains a set of extensions to provide the support
  for commands and AVP defined in several RFCs related to
@@ -108,7 +111,7 @@
 
 Package: freediameter-dictionary-legacy
 Architecture: any
-Depends: ${misc:Depends}, libxml2
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), libxml2
 Description: Legacy XML dictionary files support.
  This freeDiameter extension allows the use of XML dictionary
  files with the freeDiameter framework. Please note that
@@ -125,7 +128,8 @@
 
 Package: freediameter-radius-gateway
 Architecture: any
-Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version}), freediameter-dictionary-rfc4072 (= ${binary:Version}), freediameter-dictionary-rfc4740 (= ${binary:Version})
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version})
+Suggests: freediameter-dictionary-rfc4072 (= ${binary:Version}), freediameter-dictionary-rfc4740 (= ${binary:Version})
 Description: RADIUS/Diameter extensible gateway.
  This freeDiameter extension implements a RADIUS to Diameter
  gateway. It allows a RADIUS client to connect to a Diameter
@@ -140,10 +144,13 @@
   - auth.rgwx : Convert Access-Request to Diameter AAR or DER.
                 Requests For Comments: RADIUS: 2865, 3162, 2868,
 		2869, 3579; Diameter: 4005, 4072.
+		Requires freediameter-dictionary-rfc4072.
   - sip.rgwx  : Convert Access-Request to Diameter SIP messages.
                 Requests For Comments: Diameter: 4740.
+		Requires freediameter-dictionary-rfc4740.
   - acct.rgwx : Converts Accounting-Request (2866) to Diameter 
                 ACR (3588).
+		Requires freediameter-dictionary-rfc4072.
  .
  In order to use this extension, your main freeDiameter 
  configuration file must contain a LoadExtension directive. 
@@ -154,7 +161,7 @@
 
 Package: freediameter-accounting-server
 Architecture: any
-Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version}), libpq5
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), libpq5
 Suggests: freediameter-dictionary-rfc4072
 Description: freeDiameter simple Accounting server.
  This freeDiameter extension implements the Diameter Base 
@@ -174,7 +181,7 @@
 
 Package: freediameter-eap-server
 Architecture: any
-Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version}), libmysqlclient16, freediameter-dictionary-rfc4072 (= ${binary:Version})
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), libmysqlclient16, freediameter-dictionary-rfc4072 (= ${binary:Version})
 Description: freeDiameter Diameter EAP server implementation.
  This freeDiameter extension implements a Diameter EAP server. 
  It supports EAP-MD5 and EAP-TLS methods currently.
@@ -189,9 +196,10 @@
 
 Package: freediameter-sip-server
 Architecture: any
-Depends: ${misc:Depends}, freediameter-daemon (= ${binary:Version}), libmysqlclient16, freediameter-dictionary-rfc4740 (= ${binary:Version})
+Depends: ${misc:Depends}, freediameter-common (= ${binary:Version}), libmysqlclient16, freediameter-dictionary-rfc4740 (= ${binary:Version})
 Description: freeDiameter Diameter SIP server implementation.
- This freeDiameter extension implements a Diameter SIP server.
+ This freeDiameter extension implements a prototype 
+ Diameter SIP server.
  See http://www.freediameter.net/trac/wiki/app_sip.fdx for
  status information.
  .
--- a/contrib/debian/copyright	Fri Jan 14 15:22:22 2011 +0900
+++ b/contrib/debian/copyright	Fri Jan 14 16:25:59 2011 +0900
@@ -4,7 +4,7 @@
 Source: http://www.freediameter.net
 
 Files: *
-Copyright: 2008-2010, WIDE Project and NICT.
+Copyright: 2008-2011, WIDE Project and NICT.
 License: BSD
  Redistribution and use of this software in source and binary forms, with or without modification, are
  permitted provided that the following conditions are met:
"Welcome to our mercurial repository"