annotate contrib/README @ 1510:a2fb51309cd2

Add 3GPP TS 29.345 V15.1.0 (2019-09) Add AVPs: - App-Layer-User-Id, UTF8String, code 3801, section 6.3.2 - Assistance-info, Grouped, code 3802, section 6.3.3 - Assistance-Info-Validity-Timer, Unsigned32, code 3803, section 6.3.4 - Discovery-Type, Unsigned32, code 3804, section 6.3.5 - Filter-Id, OctetString, code 3805, section 6.3.9 - MAC-Address, UTF8String, code 3806, section 6.3.11 - Match-Report, Grouped, code 3807, section 6.3.12 - Operating-Channel, Unsigned32, code 3808, section 6.3.14 - P2P-Features, Unsigned32, code 3809, section 6.3.15 - ProSe-App-Code, OctetString, code 3810, section 6.3.16 - ProSe-App-Id, UTF8String, code 3811, section 6.3.17 - ProSe-App-Mask, OctetString, code 3812, section 6.3.18 - ProSe-Discovery-Filter, Grouped, code 3813, section 6.3.20 - PRR-Flags, Unsigned32, code 3814, section 6.3.21 - ProSe-Validity-Timer, Unsigned32, code 3815, section 6.3.22 - Requesting-EPUID, UTF8String, code 3816, section 6.3.23 - Targeted-EPUID, UTF8String, code 3817, section 6.3.26 - Time-Window, Unsigned32, code 3818, section 6.3.27 - WiFi-P2P-Assistance-Info, Grouped, code 3819, section 6.3.30 - WLAN-Assistance-Info, Grouped, code 3820, section 6.3.31 - WLAN-Link-Layer-Id, OctetString, code 3821, section 6.3.32 - WLAN-Link-Layer-Id-List, Grouped, code 3822, section 6.3.33 - Location-Update-Trigger, Grouped, code 3823, section 6.3.42 - Location-Update-Event-Type, Unsigned32, code 3824, section 6.3.43 - Change-Of-Area-Type, Grouped, code 3825, section 6.3.44 - Location-Update-Event-Trigger, Unsigned32, code 3826, section 6.3.45 - Report-Cardinality, Enumerated, code 3827, section 6.3.46 - Minimum-Interval-Time, Unsigned32, code 3828, section 6.3.47 - Periodic-Location-Type, Grouped, code 3829, section 6.3.48 - Location-Report-Interval-Time, Unsigned32, code 3830, section 6.3.49 - Total-Number-Of-Reports, Unsigned32, code 3831, section 6.3.50 - Validity-Time-Announce, Unsigned32, code 3832, section 6.3.36 - Validity-Time-Monitor, Unsigned32, code 3833, section 6.3.37 - Validity-Time-Communication, Unsigned32, code 3834, section 6.3.38 - ProSe-App-Code-Info, Grouped, code 3835, section 6.3.39 - MIC, OctetString, code 3836, section 6.3.40 - UTC-based-Counter, Unsigned32, code 3837, section 6.3.41 - ProSe-Match-Refresh-Timer, Unsigned32, code 3838, section 6.3.52 - ProSe-Metadata-Index-Mask, OctetString, code 3839, section 6.3.60 - App-Identifier, Grouped, code 3840, section 6.3.61 - OS-ID, OctetString, code 3841, section 6.3.62 - OS-App-ID, UTF8String, code 3842, section 6.3.63 - Requesting-RPAUID, UTF8String, code 3843, section 6.3.64 - Target-RPAUID, UTF8String, code 3844, section 6.3.65 - Target-PDUID, OctetString, code 3845, section 6.3.66 - ProSe-Restricted-Code, OctetString, code 3846, section 6.3.67 - ProSe-Restricted-Code-Suffix-Range, OctetString, code 3847, section 6.3.68 - Beginning-Suffix, OctetString, code 3848, section 6.3.69 - Ending-Suffix, OctetString, code 3849, section 6.3.70 - Discovery-Entry-ID, Unsigned32, code 3850, section 6.3.59 - Match-Timestamp, Time, code 3851, section 6.3.71 - PMR-Flags, Unsigned32, code 3852, section 6.3.57 - ProSe-Application-Metadata, UTF8String, code 3853, section 6.3.58 - Discovery-Auth-Request, Grouped, code 3854, section 6.3.53 - Discovery-Auth-Response, Grouped, code 3855, section 6.3.54 - Match-Request, Grouped, code 3856, section 6.3.55 - Match-Report-Info, Grouped, code 3857, section 6.3.56 - Banned-RPAUID, UTF8String, code 3858, section 6.3.73 - Banned-PDUID, OctetString, code 3859, section 6.3.74 - Code-Receiving-Security-Material, Grouped, code 3860, section 6.3.75 - Code-Sending-Security-Material, Grouped, code 3861, section 6.3.76 - DUSK, OctetString, code 3862, section 6.3.77 - DUIK, OctetString, code 3863, section 6.3.78 - DUCK, OctetString, code 3864, section 6.3.79 - MIC-Check-indicator, Unsigned32, code 3865, section 6.3.80 - Encrypted-Bitmask, OctetString, code 3866, section 6.3.81 - ProSe-App-Code-Suffix-Range, OctetString, code 3867, section 6.3.82 - PC5-tech, OctetString, code 3868, section 6.3.84 Note: Name conflict with 3GPP TS 29.154 Time-Window (4204). Time-Window (3818) in 3GPP TS 29.345 V12.1.0 (2014-12) predates Time-Window (4204) in 3GPP TS 29.154 V13.1.0 (2016-03).
author Luke Mewburn <luke@mewburn.net>
date Sun, 05 Apr 2020 08:27:37 +1000
parents 55d0867dd8b8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
327
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
1 This file describes the content of the "contrib" directory.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
2 For information about the freeDiameter project, please refer
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
3 to top-level README file.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
4
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
5 - update_copyright.sh : This script will simply update the copyright information
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
6 in all source files in the freeDiameter mercurial repository, based
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
7 on the last modification time. Thought I might share it if other people find
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
8 it useful for their own project...
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
9
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
10
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
11 - debian : This directory contains the packaging information to create native Debian / Ubuntu
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
12 packages. It requires debhelper >= 7.3.9 (support for cmake). To use, simply link the
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
13 debian folder from the main freeDiameter folder, then use your building script as
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
14 usual ('dh binary' or 'pdebuild' or ...).
474
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
15 If you simply intend to use freeDiameter package, the relevant information is located
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
16 at: http://www.freediameter.net/trac/wiki/DebRepository
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
17
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
18
327
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
19 - PKI : This directory contains useful material related to establishing a
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
20 Public Key Infrastructure (PKI) for deploying x509 certificates
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
21 and use these for TLS authentication of the freeDiameter nodes.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
22
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
23 IMPORTANT: Please note that these solutions are NOT suitable
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
24 for use in a production environment! It allows easy deployment of
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
25 certificates for tests, and that is their sole purpose.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
26
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
27 The directory contains:
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
28
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
29 - ca_script: a simple Makefile allowing you to generate a self-signed certificate (root)
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
30 and then issue new certificates and private keys for your users.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
31 Run "make" without argument to get the help.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
32
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
33 - ca_script2: An evolution of the previous Makefile. This one allows you
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
34 to create a hierarchy of CA and certificates.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
35
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
36 - phpki-0.82.patch : This patch is to be applied to PHPki to customize the use for freeDiameter.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
37 PHPki (http://sourceforge.net/projects/phpki/) is a PHP-based web interface
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
38 that provides more or less the same services as ca_script.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
39
328
90294e7e986c Moved the debian dir outside the top level directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 327
diff changeset
40
327
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
41 - OpenWRT : This directory contains the scripts and documentation related to
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
42 the integration of freeDiameter RADIUS/Diameter gateway component in the openWRT
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
43 distribution (http://openwrt.org) -- the goal is to give the access point the
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
44 ability to "talk" Diameter instead of RADIUS.
0f43f42669be Reorganized the contrib/ directory
Sebastien Decugis <sdecugis@nict.go.jp>
parents:
diff changeset
45
474
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
46
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
47 - nightly_tests : This directory contains the scripts and documentation for the nightly
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
48 tests run on freeDiameter. The results are published at the following URL:
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
49 http://www.freediameter.net/CDash/index.php?project=freeDiameter
e8c1ff19705e Updated information
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 328
diff changeset
50
600
e9c0bdedf2eb Initial draft version of dict_legacy_xml, parses XML file but no conversion to fD yet.
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 474
diff changeset
51
e9c0bdedf2eb Initial draft version of dict_legacy_xml, parses XML file but no conversion to fD yet.
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 474
diff changeset
52 - dict_legacy: XML and DTD files for the dict_legacy_xml.fdx extension.
726
c0c0a7781b09 Added new contribution: Wireshark patch to display Diameter over TLS over SCTP
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
53
800
35f3fe884dc9 Updates sent by Konstantin to the dict_dcca files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 726
diff changeset
54 - dict_dcca: partial implementations of the DCCA dictionary
35f3fe884dc9 Updates sent by Konstantin to the dict_dcca files
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 726
diff changeset
55
830
7fd5aed93640 Included contribution from German Barros
Sebastien Decugis <sdecugis@freediameter.net>
parents: 800
diff changeset
56 - dict_gx: untested implementation of the Gx interface.
7fd5aed93640 Included contribution from German Barros
Sebastien Decugis <sdecugis@freediameter.net>
parents: 800
diff changeset
57
1257
55d0867dd8b8 Added a basic Gx implementation in contrib (untested) -- reported working but may need some adaptation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 830
diff changeset
58 - test_Gx: a responder on the Gx interface that always send SUCCESS status.
55d0867dd8b8 Added a basic Gx implementation in contrib (untested) -- reported working but may need some adaptation
Sebastien Decugis <sdecugis@freediameter.net>
parents: 830
diff changeset
59
726
c0c0a7781b09 Added new contribution: Wireshark patch to display Diameter over TLS over SCTP
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
60 - wireshark: This contains some information on how to use Wireshark to monitor Diameter
c0c0a7781b09 Added new contribution: Wireshark patch to display Diameter over TLS over SCTP
Sebastien Decugis <sdecugis@nict.go.jp>
parents: 600
diff changeset
61 exchange protected with TLS. It involves patching the wireshark software.
"Welcome to our mercurial repository"