Module: kamailio
Branch: master
Commit: 6e53e4f20df3ab21368eeb8ae9eeaedc96ddd9c6
URL:
https://github.com/kamailio/kamailio/commit/6e53e4f20df3ab21368eeb8ae9eeaed…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2017-02-01T16:01:13+01:00
modules: readme files regenerated - auth_ephemeral ...
---
Modified: src/modules/auth_ephemeral/README
---
Diff:
https://github.com/kamailio/kamailio/commit/6e53e4f20df3ab21368eeb8ae9eeaed…
Patch:
https://github.com/kamailio/kamailio/commit/6e53e4f20df3ab21368eeb8ae9eeaed…
---
diff --git a/src/modules/auth_ephemeral/README b/src/modules/auth_ephemeral/README
index 535bd8d..88a4af9 100644
--- a/src/modules/auth_ephemeral/README
+++ b/src/modules/auth_ephemeral/README
@@ -5,7 +5,14 @@ Peter Dunkley
Crocodile RCS Ltd
<peter.dunkley(a)crocodile-rcs.com>
+Carsten Bock
+
+ ng-voice GmbH
+ <carsten(a)ng-voice.com>
+
Copyright © 2013 Crocodile RCS Ltd
+
+ Copyright © 2017 ng-voice GmbH
__________________________________________________________________
Table of Contents
@@ -28,6 +35,7 @@ Peter Dunkley
3.1. secret (string)
3.2. username_format (integer)
+ 3.3. sha_algorithm (integer)
4. Functions
@@ -51,13 +59,14 @@ Peter Dunkley
1.2. Response example
1.3. secret parameter usage
1.4. username_format parameter usage
- 1.5. autheph_proxy usage
- 1.6. autheph_www usage
- 1.7. autheph_check usage
- 1.8. autheph_authenticate usage
- 1.9. autheph_check_from usage
- 1.10. autheph_check_to usage
- 1.11. autheph_check_timestamp usage
+ 1.5. sha_algorithm parameter usage
+ 1.6. autheph_proxy usage
+ 1.7. autheph_www usage
+ 1.8. autheph_check usage
+ 1.9. autheph_authenticate usage
+ 1.10. autheph_check_from usage
+ 1.11. autheph_check_to usage
+ 1.12. autheph_check_timestamp usage
Chapter 1. Admin Guide
@@ -79,6 +88,7 @@ Chapter 1. Admin Guide
3.1. secret (string)
3.2. username_format (integer)
+ 3.3. sha_algorithm (integer)
4. Functions
@@ -184,6 +194,7 @@ POST /?service=sip&username=foo(a)bar.com
3.1. secret (string)
3.2. username_format (integer)
+ 3.3. sha_algorithm (integer)
3.1. secret (string)
@@ -211,6 +222,19 @@ modparam("auth_ephemeral", "secret",
"kamailio_rules")
modparam("auth_ephemeral", "username_format", 0)
...
+3.3. sha_algorithm (integer)
+
+ The SHA algorhithm to be used for the Hash.
+
+ * 0 - SHA1 (default, as per IETF/RFC)
+ * 1 - SHA256
+ * 2 - SHA512
+
+ Example 1.5. sha_algorithm parameter usage
+...
+modparam("auth_ephemeral", "sha_algorithm", 2)
+...
+
4. Functions
4.1. autheph_proxy(realm)
@@ -241,7 +265,7 @@ Note
This function can be used from REQUEST_ROUTE.
- Example 1.5. autheph_proxy usage
+ Example 1.6. autheph_proxy usage
...
if (!autheph_proxy("$fd")) {
auth_challenge("$fd", "1");
@@ -272,7 +296,7 @@ Note
This function can be used from REQUEST_ROUTE.
- Example 1.6. autheph_www usage
+ Example 1.7. autheph_www usage
...
if (!autheph_www("$fd")) {
auth_challenge("$fd", "1");
@@ -302,7 +326,7 @@ Note
This function can be used from REQUEST_ROUTE.
- Example 1.7. autheph_check usage
+ Example 1.8. autheph_check usage
...
if (!autheph_check("$fd")) {
auth_challenge("$fd", "1");
@@ -329,7 +353,7 @@ Note
This function can be used from REQUEST_ROUTE.
- Example 1.8. autheph_authenticate usage
+ Example 1.9. autheph_authenticate usage
...
if (!autheph_authenticate("$var(username)", "$var(password)")) {
sl_send_reply("403", "Forbidden");
@@ -363,7 +387,7 @@ Note
This function can be used from REQUEST_ROUTE.
- Example 1.9. autheph_check_from usage
+ Example 1.10. autheph_check_from usage
...
if (!autheph_check_from()) {
sl_send_reply("403", "Forbidden");
@@ -397,7 +421,7 @@ Note
This function can be used from REQUEST_ROUTE.
- Example 1.10. autheph_check_to usage
+ Example 1.11. autheph_check_to usage
...
if (!autheph_check_to()) {
sl_send_reply("403", "Forbidden");
@@ -426,7 +450,7 @@ Note
This function can be used from REQUEST_ROUTE.
- Example 1.11. autheph_check_timestamp usage
+ Example 1.12. autheph_check_timestamp usage
...
if (!autheph_check_timestamp("$var(username)")) {
sl_send_reply("403", "Forbidden");