summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/grammar
diff options
context:
space:
mode:
authorAndrei Pavel <andrei@isc.org>2024-08-26 16:00:03 +0200
committerAndrei Pavel <andrei@isc.org>2024-08-26 16:00:03 +0200
commitba861d871ed983d4edb732a723a084215c22855e (patch)
treee0fb665af89581fb2cd0c742dd9c81e57c8082cd /doc/sphinx/grammar
parent[#3550] AC_PROG_LN_S and ChangeLog entry (diff)
downloadkea-ba861d871ed983d4edb732a723a084215c22855e.tar.xz
kea-ba861d871ed983d4edb732a723a084215c22855e.zip
[#3556] release changesKea-2.7.2
Diffstat (limited to 'doc/sphinx/grammar')
-rw-r--r--doc/sphinx/grammar/grammar-d2-parser.rst90
-rw-r--r--doc/sphinx/grammar/grammar-dhcp4-parser.rst80
-rw-r--r--doc/sphinx/grammar/grammar-dhcp6-parser.rst86
3 files changed, 250 insertions, 6 deletions
diff --git a/doc/sphinx/grammar/grammar-d2-parser.rst b/doc/sphinx/grammar/grammar-d2-parser.rst
index 920d973a59..6aed9925c5 100644
--- a/doc/sphinx/grammar/grammar-d2-parser.rst
+++ b/doc/sphinx/grammar/grammar-d2-parser.rst
@@ -81,6 +81,7 @@ This grammar is generated from ``d2_parser.yy``. See :ref:`dhcp-ddns-server` for
| reverse_ddns
| tsig_keys
| control_socket
+ | control_sockets
| hooks_libraries
| loggers
| user_context
@@ -218,20 +219,107 @@ This grammar is generated from ``d2_parser.yy``. See :ref:`dhcp-ddns-server` for
control_socket ::= "control-socket" ":" "{" control_socket_params "}"
+ control_sockets ::= "control-sockets" ":" "[" control_socket_list "]"
+
+ control_socket_list ::=
+ | not_empty_control_socket_list
+
+ not_empty_control_socket_list ::= control_socket_entry
+ | not_empty_control_socket_list "," control_socket_entry
+ | not_empty_control_socket_list ","
+
+ control_socket_entry ::= "{" control_socket_params "}"
+
control_socket_params ::= control_socket_param
| control_socket_params "," control_socket_param
| control_socket_params ","
control_socket_param ::= control_socket_type
| control_socket_name
+ | control_socket_address
+ | control_socket_port
+ | authentication
+ | trust_anchor
+ | cert_file
+ | key_file
+ | cert_required
| user_context
| comment
| unknown_map_entry
- control_socket_type ::= "socket-type" ":" STRING
+ control_socket_type ::= "socket-type" ":" control_socket_type_value
+
+ control_socket_type_value ::= "unix"
+ | "http"
+ | "https"
control_socket_name ::= "socket-name" ":" STRING
+ control_socket_address ::= "socket-address" ":" STRING
+
+ control_socket_port ::= "socket-port" ":" INTEGER
+
+ trust_anchor ::= "trust-anchor" ":" STRING
+
+ cert_file ::= "cert-file" ":" STRING
+
+ key_file ::= "key-file" ":" STRING
+
+ cert_required ::= "cert-required" ":" BOOLEAN
+
+ authentication ::= "authentication" ":" "{" auth_params "}"
+
+ auth_params ::= auth_param
+ | auth_params "," auth_param
+ | auth_params ","
+
+ auth_param ::= auth_type
+ | realm
+ | directory
+ | clients
+ | comment
+ | user_context
+ | unknown_map_entry
+
+ auth_type ::= "type" ":" auth_type_value
+
+ auth_type_value ::= "basic"
+
+ realm ::= "realm" ":" STRING
+
+ directory ::= "directory" ":" STRING
+
+ clients ::= "clients" ":" "[" clients_list "]"
+
+ clients_list ::=
+ | not_empty_clients_list
+
+ not_empty_clients_list ::= basic_auth
+ | not_empty_clients_list "," basic_auth
+ | not_empty_clients_list ","
+
+ basic_auth ::= "{" clients_params "}"
+
+ clients_params ::= clients_param
+ | clients_params "," clients_param
+ | clients_params ","
+
+ clients_param ::= user
+ | user_file
+ | password
+ | password_file
+ | user_context
+ | comment
+ | unknown_map_entry
+
+ user ::= "user" ":" STRING
+
+ user_file ::= "user-file" ":" STRING
+
+ password ::= "password" ":" STRING
+
+ password_file ::= "password-file" ":" STRING
+
hooks_libraries ::= "hooks-libraries" ":" "[" hooks_libraries_list "]"
hooks_libraries_list ::=
diff --git a/doc/sphinx/grammar/grammar-dhcp4-parser.rst b/doc/sphinx/grammar/grammar-dhcp4-parser.rst
index c6dda8de6f..f2c7a45923 100644
--- a/doc/sphinx/grammar/grammar-dhcp4-parser.rst
+++ b/doc/sphinx/grammar/grammar-dhcp4-parser.rst
@@ -107,6 +107,7 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
| expired_leases_processing
| dhcp4o6_port
| control_socket
+ | control_sockets
| dhcp_queue_control
| dhcp_ddns
| echo_client_id
@@ -864,20 +865,97 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
control_socket ::= "control-socket" ":" "{" control_socket_params "}"
+ control_sockets ::= "control-sockets" ":" "[" control_socket_list "]"
+
+ control_socket_list ::=
+ | not_empty_control_socket_list
+
+ not_empty_control_socket_list ::= control_socket_entry
+ | not_empty_control_socket_list "," control_socket_entry
+ | not_empty_control_socket_list ","
+
+ control_socket_entry ::= "{" control_socket_params "}"
+
control_socket_params ::= control_socket_param
| control_socket_params "," control_socket_param
| control_socket_params ","
control_socket_param ::= control_socket_type
| control_socket_name
+ | control_socket_address
+ | control_socket_port
+ | authentication
+ | trust_anchor
+ | cert_file
+ | key_file
+ | cert_required
| user_context
| comment
| unknown_map_entry
- control_socket_type ::= "socket-type" ":" STRING
+ control_socket_type ::= "socket-type" ":" control_socket_type_value
+
+ control_socket_type_value ::= "unix"
+ | "http"
+ | "https"
control_socket_name ::= "socket-name" ":" STRING
+ control_socket_address ::= "socket-address" ":" STRING
+
+ control_socket_port ::= "socket-port" ":" INTEGER
+
+ cert_required ::= "cert-required" ":" BOOLEAN
+
+ authentication ::= "authentication" ":" "{" auth_params "}"
+
+ auth_params ::= auth_param
+ | auth_params "," auth_param
+ | auth_params ","
+
+ auth_param ::= auth_type
+ | realm
+ | directory
+ | clients
+ | comment
+ | user_context
+ | unknown_map_entry
+
+ auth_type ::= "type" ":" auth_type_value
+
+ auth_type_value ::= "basic"
+
+ realm ::= "realm" ":" STRING
+
+ directory ::= "directory" ":" STRING
+
+ clients ::= "clients" ":" "[" clients_list "]"
+
+ clients_list ::=
+ | not_empty_clients_list
+
+ not_empty_clients_list ::= basic_auth
+ | not_empty_clients_list "," basic_auth
+ | not_empty_clients_list ","
+
+ basic_auth ::= "{" clients_params "}"
+
+ clients_params ::= clients_param
+ | clients_params "," clients_param
+ | clients_params ","
+
+ clients_param ::= user
+ | user_file
+ | password
+ | password_file
+ | user_context
+ | comment
+ | unknown_map_entry
+
+ user_file ::= "user-file" ":" STRING
+
+ password_file ::= "password-file" ":" STRING
+
dhcp_queue_control ::= "dhcp-queue-control" ":" "{" queue_control_params "}"
queue_control_params ::= queue_control_param
diff --git a/doc/sphinx/grammar/grammar-dhcp6-parser.rst b/doc/sphinx/grammar/grammar-dhcp6-parser.rst
index 98d7e6aa26..b8ca9b9e3b 100644
--- a/doc/sphinx/grammar/grammar-dhcp6-parser.rst
+++ b/doc/sphinx/grammar/grammar-dhcp6-parser.rst
@@ -116,6 +116,7 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
| server_id
| dhcp4o6_port
| control_socket
+ | control_sockets
| dhcp_queue_control
| dhcp_ddns
| user_context
@@ -911,19 +912,96 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
control_socket ::= "control-socket" ":" "{" control_socket_params "}"
+ control_sockets ::= "control-sockets" ":" "[" control_socket_list "]"
+
+ control_socket_list ::=
+ | not_empty_control_socket_list
+
+ not_empty_control_socket_list ::= control_socket_entry
+ | not_empty_control_socket_list "," control_socket_entry
+ | not_empty_control_socket_list ","
+
+ control_socket_entry ::= "{" control_socket_params "}"
+
control_socket_params ::= control_socket_param
| control_socket_params "," control_socket_param
| control_socket_params ","
- control_socket_param ::= socket_type
- | socket_name
+ control_socket_param ::= control_socket_type
+ | control_socket_name
+ | control_socket_address
+ | control_socket_port
+ | authentication
+ | trust_anchor
+ | cert_file
+ | key_file
+ | cert_required
| user_context
| comment
| unknown_map_entry
- socket_type ::= "socket-type" ":" STRING
+ control_socket_type ::= "socket-type" ":" control_socket_type_value
+
+ control_socket_type_value ::= "unix"
+ | "http"
+ | "https"
+
+ control_socket_name ::= "socket-name" ":" STRING
+
+ control_socket_address ::= "socket-address" ":" STRING
+
+ control_socket_port ::= "socket-port" ":" INTEGER
+
+ cert_required ::= "cert-required" ":" BOOLEAN
+
+ authentication ::= "authentication" ":" "{" auth_params "}"
+
+ auth_params ::= auth_param
+ | auth_params "," auth_param
+ | auth_params ","
+
+ auth_param ::= auth_type
+ | realm
+ | directory
+ | clients
+ | comment
+ | user_context
+ | unknown_map_entry
+
+ auth_type ::= "type" ":" auth_type_value
+
+ auth_type_value ::= "basic"
+
+ realm ::= "realm" ":" STRING
+
+ directory ::= "directory" ":" STRING
+
+ clients ::= "clients" ":" "[" clients_list "]"
+
+ clients_list ::=
+ | not_empty_clients_list
+
+ not_empty_clients_list ::= basic_auth
+ | not_empty_clients_list "," basic_auth
+ | not_empty_clients_list ","
+
+ basic_auth ::= "{" clients_params "}"
+
+ clients_params ::= clients_param
+ | clients_params "," clients_param
+ | clients_params ","
+
+ clients_param ::= user
+ | user_file
+ | password
+ | password_file
+ | user_context
+ | comment
+ | unknown_map_entry
+
+ user_file ::= "user-file" ":" STRING
- socket_name ::= "socket-name" ":" STRING
+ password_file ::= "password-file" ":" STRING
dhcp_queue_control ::= "dhcp-queue-control" ":" "{" queue_control_params "}"