annotate README @ 1562:6219359a36a9 default tip

Merge latest changes from proposed branch
author Sebastien Decugis <sdecugis@freediameter.net>
date Mon, 21 Jun 2021 19:08:18 +0800
parents ce3cacbbccc9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 325
diff changeset
1 freeDiameter is an implementation of the Diameter protocol.
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
2
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
3 Diameter is a protocol designed to carry Authentication, Authorization and
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
4 Accounting (AAA) payload. It is an evolution of the RADIUS protocol (as the
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
5 name suggests).
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
6
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
7 Diameter is an extensible protocol. RFC3588 (currently under revision) defines the
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
8 Base Protocol that all Diameter nodes must support, while other documents define
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
9 the additional protocol support for specific applications. Such applications include
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
10 for example Network Access Servers (RFC4005), EAP (RFC4072), ...
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
11
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
12
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
13 The implementation consists in several components:
660
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
14 - libfdproto : this shared library provides the functions to manipulate Diameter
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
15 messages and dictionary. This library is meant to be re-used by other projects
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
16 that would require parsing or manipulating Diameter messages.
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
17
660
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
18 - libfdcore : this shared library contains the core of the framework. It establishes
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
19 the network connections with other Diameter peers and performs the tasks described
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
20 in Diameter Base Protocol, such as watchdogs, basic routing, ... It also handles
972
ce3cacbbccc9 Fix some typos.
Thomas Klausner <tk@giga.or.at>
parents: 660
diff changeset
21 the loading of extensions (see below).
660
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
22
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
23 - freeDiameterd : this simple daemon parses the command line and initializes the
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
24 freeDiameter framework. Use it for your Diameter server & agent components.
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
25 In case of Diameter clients, you probably will prefer linking the libfdcore
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
26 directly with your client application that must be made Diameter-aware.
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
27
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
28 - extensions : the extensions provide the mean to augment the features of the
660
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
29 freeDiameterd framework. Extensions can provide the handling of a Diameter
a8269458d5b1 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 335
diff changeset
30 server application, but also advanced routing features, peer management, etc.
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
31
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
32
335
603791d2dcc4 Updated website information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
33 See http://www.freediameter.net/ for more information on the project.
325
5133b45e3305 Updated documentation
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 74
diff changeset
34
1
bafb831ba688 Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 0
diff changeset
35 freeDiameter was previously known as the "waaad" project (WIDE AAA Daemon)
0
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
36
1
bafb831ba688 Fix names to proper case for freeDiameter
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 0
diff changeset
37 This project is not related to the "freediameter" project from Sun on sourceforge.
0
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
38
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
39 Author: Sebastien Decugis.
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
40
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
41 See LICENSE file for legal information on this software.
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
42
13530e1f02e3 Initial files imported
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
43 See INSTALL for information on building and using this software.
"Welcome to our mercurial repository"