2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2012 IPFire Network Development Team #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
22 # Set this to true if localhost should be added as the first DNS server.
23 DNS_USE_LOCAL_RESOLVER
=true
24 NETWORK_CONFIG_FILE_PARAMS
="${NETWORK_CONFIG_FILE_PARAMS} DNS_USE_LOCAL_RESOLVER"
26 # Set this option to true if the DNS servers should be queried in a random order.
27 # This is useful to load balance between multiple servers.
29 NETWORK_CONFIG_FILE_PARAMS
="${NETWORK_CONFIG_FILE_PARAMS} DNS_RANDOMIZE"
32 NETWORK_CONFIG_FILE_PARAMS
="${NETWORK_CONFIG_FILE_PARAMS} DNS_SEARCH_DOMAINS"
34 # Set this option to true if the DNS servers should be advertised by
36 DNS_ADVERTISE_SERVERS
="true"
38 DNS_SERVER_CONFIG_FILE
="${NETWORK_CONFIG_DIR}/dns-servers"
39 NETWORK_CONFIG_DNS_SERVER_PARAMS
="server priority"
41 # Set the default priority for DNS servers.
42 DNS_SERVER_DEFAULT_PRIORITY
="100"
43 DNS_SERVER_DYNAMIC_PRIORITY
="10"
45 # Path to the configuration file of the DNS resolver.
46 RESOLV_CONF
="/etc/resolv.conf"
48 function dns_get_hostname
() {
54 eval $
(ipcalc
-h ${address} 2>/dev
/null
)
59 function dns_server_list
() {
60 [ -r "${DNS_SERVER_CONFIG_FILE}" ] ||
return ${EXIT_OK}
63 local ${NETWORK_CONFIG_DNS_SERVER_PARAMS}
65 local format
="%-20s %-8s"
66 print
"${format}" "SERVER" "PRIORITY"
68 while read -r line
; do
69 dns_server_parse_line
${line} ||
continue
71 print
"${format}" "${server}" "${priority}"
72 done < ${DNS_SERVER_CONFIG_FILE}
77 function dns_server_list_sorted
() {
78 [ -r "${DNS_SERVER_CONFIG_FILE}" ] ||
return ${EXIT_OK}
81 # First get all servers from the configuration file.
82 while read -r line
; do
83 dns_server_parse_line
${line} ||
continue
85 print
"%d %s" "${priority}" "${server}"
86 done < ${DNS_SERVER_CONFIG_FILE}
88 # Then get all dynamically assigned DNS servers.
89 dns_server_get_zone_name_servers
92 # Nothing to do if we have got no DNS servers.
93 isset servers ||
return ${EXIT_OK}
95 # Sort everything we have got.
96 servers
=$
(sort -g -k1 <<< "${servers}")
98 # Remove the priority bit.
99 local server server_list
100 while read -r priority server
; do
101 list_append server_list
"${server}"
102 done <<< "${servers}"
104 # Return the list but remove duplicate entries, keeping
105 # the first and removing all others.
106 list_unique
${server_list}
111 function dns_server_add
() {
116 if ! isset priority
; then
117 priority
="${DNS_SERVER_DEFAULT_PRIORITY}"
119 assert isinteger priority
121 # Add a new line to the configuration file.
122 print
"server=\"%s\" priority=\"%d\"" "${server}" "${priority}" \
123 >> ${DNS_SERVER_CONFIG_FILE}
128 function dns_server_exists
() {
132 [ -r "${DNS_SERVER_CONFIG_FILE}" ] ||
return ${EXIT_FALSE}
134 local line
${NETWORK_CONFIG_DNS_SERVER_PARAMS}
135 while read -r line
; do
136 dns_server_parse_line
${line} ||
continue
138 [ "${entry}" = "${server}" ] && return ${EXIT_TRUE}
139 done < ${DNS_SERVER_CONFIG_FILE}
144 function dns_server_remove() {
148 # Check if the DNS server configuration file exists.
149 [ -r "${DNS_SERVER_CONFIG_FILE}" ] || return ${EXIT_ERROR}
152 local tempfile=$(mktemp)
154 local line ${NETWORK_CONFIG_DNS_SERVER_PARAMS}
155 while read -r line; do
156 dns_server_parse_line ${line} || continue
158 # Skip the line with the server we are searching for.
159 [ "${entry}" = "${server}" ] && continue
161 # Re-add the old line.
163 done < ${DNS_SERVER_CONFIG_FILE} > ${tempfile}
165 # Overwrite the old content without the entry that has just been removed.
166 fread "${tempfile}" > ${DNS_SERVER_CONFIG_FILE}
168 # Remove the temporary file.
174 function dns_server_flush() {
175 : > ${DNS_SERVER_CONFIG_FILE}
178 function dns_server_parse_line() {
181 for arg in ${NETWORK_CONFIG_DNS_SERVER_PARAMS}; do
185 while read -r arg; do
188 server=$(cli_get_val ${arg})
191 priority=$(cli_get_val ${arg})
194 done <<< "$
(args $@
)"
196 # The server address must be set.
197 isset server || return ${EXIT_ERROR}
199 # The server address must also be a valid IP address.
200 ip_is_valid ${server} || return ${EXIT_ERROR}
202 # If priority is set, it must be an integer number.
203 if isset priority; then
204 isinteger priority || return ${EXIT_ERROR}
206 # Otherwise assign the default priority.
208 priority=${DNS_SERVER_DEFAULT_PRIORITY}
214 # Update resolv.conf(5) when initializing the network.
215 init_register dns_generate_resolvconf
217 function dns_generate_resolvconf() {
218 local file=${RESOLV_CONF}
220 log INFO "Updating resolver configuration...
"
222 config_header "resolver configutation
file" > ${file}
224 if enabled DNS_RANDOMIZE; then
225 print "option rotate
\n" >> ${file}
228 # Write search domains to file.
229 print "# Search domains" >> ${file}
232 for domain
in $
(dns_get_search_domains
); do
233 print
"search ${domain}"
236 print
"\n# Nameservers" >> ${file}
238 # Add the local resolver as the first DNS server if enabled.
239 if enabled DNS_USE_LOCAL_RESOLVER
; then
240 print
"nameserver ::1" >> ${file}
243 # Dump all DNS servers.
244 for server
in $
(dns_server_list_sorted
); do
245 print
"nameserver ${server}"
249 function dns_get_search_domains
() {
250 # Add search domains.
251 local search_domains
="$(unquote ${DNS_SEARCH_DOMAINS})"
253 # Get search domains from DHCP clients, etc.
254 local domain proto zone
256 for zone
in $
(zones_get_all
); do
257 for proto
in ${IP_SUPPORTED_PROTOCOLS}; do
258 domain
=$
(routing_db_get
${zone} ${proto} domain-name
)
259 isset domain ||
continue
261 list_append search_domains
"${domainname}"
265 # Sort out duplicate entries.
266 list_unique
${search_domains}
269 function dns_server_get_zone_name_servers
() {
270 local priority proto server servers zone
272 for zone
in $
(zones_get_all
); do
273 for proto
in ${IP_SUPPORTED_PROTOCOLS}; do
274 priority
=$
(routing_db_get
${zone} ${proto} domain-name-servers-priority
)
275 isset priority || priority
="${DNS_SERVER_DYNAMIC_PRIORITY}"
277 servers
=$
(routing_db_get
${zone} ${proto} domain-name-servers
)
278 for server
in ${servers}; do
279 print
"${priority} ${server}"