Skip to content

Commit

Permalink
Documentation updated with routing information.
Browse files Browse the repository at this point in the history
  • Loading branch information
tomaszmrugalski committed Nov 10, 2011
1 parent d1164e3 commit 9233ee2
Show file tree
Hide file tree
Showing 11 changed files with 428 additions and 259 deletions.
3 changes: 3 additions & 0 deletions AUTHORS
Expand Up @@ -71,5 +71,8 @@
- Harro Haan <hrhaan(at)gmail(dot)com>
2011-10: fix alignment errors (ARMv5)

- Mateusz Ozga <matozga(at)gmail(dot)com>
2011-11: Routing configuration

Dibbler uses poslib library to communicate with DNS servers (DNS Update mechanism).
Poslib is written by Meilof Veeningen <meilof@users.sourceforge.net>
3 changes: 2 additions & 1 deletion CHANGELOG
Expand Up @@ -2,7 +2,7 @@
Dibbler changelog
-------------------

0.8.1 [not-released-yet]
0.8.1RC1 [2011-11-11]
- Fixed socket binding problem on server that may affect relay scenarios
- Fixed segmentation fault when interface-id was not defined on relay interface.
- Makefiles reworked
Expand All @@ -27,6 +27,7 @@
- It is now possible to specify IAID for PD
- Doc: Rather large User's Guide update
- Support for RFC6334 (DS-Lite tunnels) added
- Support for routing configuration added (draft-ietf-mif-dhcpv6-route-option-03)

0.8.0 [2011-05-11]
- Fixed compilation problems
Expand Down
13 changes: 5 additions & 8 deletions doc/Makefile.am
Expand Up @@ -48,21 +48,18 @@ user: dibbler-user.tex dibbler-user-config-client.tex \
$(LATEX) $(LATEXOPTS) dibbler-user.tex >dibbler-user-2nd_pass.log; \
echo "[LATEX ] $(SUBDIR)/$@"; \
$(LATEX) $(LATEXOPTS) dibbler-user.tex >dibbler-user-3rd_pass.log; \
-grep "undefined" dibbler-user-3rd_pass.log;\
fi
if grep "undefined" dibbler-user-1st_pass.log; then \
echo "There are undefined references";\
fi
-grep "undefined" dibbler-user-3rd_pass.log;
-grep "undefined" dibbler-user-1st_pass.log;

devel: $(DOXYGEN)
doxygen doxygen.cfg > doxygen.log 2>doxygen-error.log
cp logo* html/

version.tex:
@echo "[GREP ] $(SUBDIR)/$@"
@../scripts/xtract_version > $@
@echo "[PERL ] $(SUBDIR)/$@"
perl -i -pe 's/_/\\_/g' version.tex
perl -i -pe 's/^/\\newcommand{\\version}{/' version.tex
perl -i -pe 's/$$/ }/' version.tex
../scripts/xtract_version > version.tex

clean:
@echo "[CLEAN ] $(SUBDIR)"
Expand Down
13 changes: 5 additions & 8 deletions doc/Makefile.in
Expand Up @@ -521,21 +521,18 @@ user: dibbler-user.tex dibbler-user-config-client.tex \
$(LATEX) $(LATEXOPTS) dibbler-user.tex >dibbler-user-2nd_pass.log; \
echo "[LATEX ] $(SUBDIR)/$@"; \
$(LATEX) $(LATEXOPTS) dibbler-user.tex >dibbler-user-3rd_pass.log; \
-grep "undefined" dibbler-user-3rd_pass.log;\
fi
if grep "undefined" dibbler-user-1st_pass.log; then \
echo "There are undefined references";\
fi
-grep "undefined" dibbler-user-3rd_pass.log;
-grep "undefined" dibbler-user-1st_pass.log;

devel: $(DOXYGEN)
doxygen doxygen.cfg > doxygen.log 2>doxygen-error.log
cp logo* html/

version.tex:
@echo "[GREP ] $(SUBDIR)/$@"
@../scripts/xtract_version > $@
@echo "[PERL ] $(SUBDIR)/$@"
perl -i -pe 's/_/\\_/g' version.tex
perl -i -pe 's/^/\\newcommand{\\version}{/' version.tex
perl -i -pe 's/$$/ }/' version.tex
../scripts/xtract_version > version.tex

clean:
@echo "[CLEAN ] $(SUBDIR)"
Expand Down
27 changes: 13 additions & 14 deletions doc/dibbler-user-bibliography.tex
Expand Up @@ -30,9 +30,11 @@

\bibitem{rfc3736} R. Droms, ``Stateless Dynamic Host Configuration
Protocol (DHCP) Service for IPv6'', \rfc{3736}, IETF, April 2004.

\bibitem{rfc3898} V. Kalusivalingam ``Network Information Service
(NIS) Configuration Options for Dynamic Host Configuration Protocol
for IPv6 (DHCPv6)'', \rfc{3898}, IETF, October 2004.

\bibitem{rfc4033} R. Arends, R. Austein, M. Larson, D. Massey and S. Rose
``DNS Security Introduction and Requirements'',
\rfc{4033}, IETF, March 2005
Expand Down Expand Up @@ -66,19 +68,10 @@
Configuration Protocol for IPv6 (DHCPv6) Options for Dual-Stack
Lite'', \rfc{6334}, IETF, Aug. 2011

\bibitem{draft-timezone} A.K. Vijayabhaskar ``Time Configuration Options
for DHCPv6'', work in progress, IETF, October 2003,
draft-ietf-dhc-dhcpv6-opt-timeconfig-03.txt.

\bibitem{draft-aaa} Vishnu Ram, Saumya Upadhyaya, Nitin Jain
``Authentication, Authorization and key management for DHCPv6'',
work in progress, IETF, August 2006,
draft-ram-dhc-dhcpv6-aakey-01.txt.

\bibitem{draft-route} W.Dec, T.Mrugalski, T.Sun, B.Sarikaya,
``Authentication, Authorization and key management for DHCPv6'',
work in progress, IETF, September 2011,
draft-ietf-mif-dhcpv6-route-option-03.
``Authentication, Authorization and key management for
DHCPv6'', work in progress (expired),
draft-ram-dhc-dhcpv6-aakey-01, IETF, August 2006

\bibitem{phd} T. Mrugalski, ``Optimization of the autoconfiguration
mechanisms of the mobile stations supporting IPv6 protocol in the IEEE
Expand All @@ -95,10 +88,16 @@
Networks and Applications Conference, Auckland, New Zealand, Nov. 2010

\bibitem{draft-route-option} W.Dec, T.Mrugalski, T.Sun, B. Sarikaya,
``DHCPv6 Route Options'', MIF WG, work-in-progress, IETF, Sep. 2011
``DHCPv6 Route Options'', MIF WG, work in progress,
draft-ietf-mif-dhcpv6-route-option-03, IETF, Sep. 2011
.

\bibitem{draft-remote-autoconf} T.Mrugalski, ``Remote DHCPv6
Autoconfiguration'', work-in-progress, IETF, July 2010
Autoconfiguration'', work-in-progress (expired), IETF, July 2010

\bibitem{draft-timezone} A.K. Vijayabhaskar ``Time Configuration Options
for DHCPv6'', work in progress (expired),
draft-ietf-dhc-dhcpv6-opt-timeconfig-03, IETF, October 2003

\end{thebibliography}
\addcontentsline{toc}{section}{Bibliography}%\hfill \thepage\\}
6 changes: 5 additions & 1 deletion doc/dibbler-user-config-client.tex
Expand Up @@ -321,7 +321,7 @@ \subsection{Client Reference}
client configures address, it also configures routing, so every host
is able to communicate with other hosts, which have obtained address
from the same server. If you don't like this behavior, you might
want to use this option. Note that draft \cite{draft-route} was
want to use this option. Note that draft \cite{draft-route-option} was
introduced to solve this DHCPv6 protocol limitation. It is expected
to be supported in the next Dibbler release.

Expand Down Expand Up @@ -646,6 +646,10 @@ \subsection{Client Reference}
\texttt{digest\_hmac\_sha256}, \texttt{digest\_hmac\_sha384},
and \texttt{digest\_hmac\_sha512}.

\item[route] -- (scope: interface). Takes one boolean parameter that
defines if routing information should requested or not. The default
value is false. See Section \ref{feature-routing}.

\end{description}

After receiving options values from a server, client stores values of
Expand Down
62 changes: 62 additions & 0 deletions doc/dibbler-user-config-server.tex
Expand Up @@ -76,6 +76,49 @@ \subsubsection{Address class scope}
pool address/prefix
\end{lstlisting}

\subsubsection{Prefix class scope}
\label{server-pd-class-scope}
That is an equivalent of address class for a prefix delegation. It
contains definition of prefixes that are going to be delegation to
clients. Only pd-class scoped parameters can be defined here. Prefix
class is declared as follows:
\begin{lstlisting}
pd-class
{
pd-pool prefix/length
pd-length prefix-length
}
\end{lstlisting}

\subsubsection{Temporary address class scope}
\label{server-ta-class-scope}
That is an equivalent of address class for temporary addresses. It
contains definition of temporary addresses that are going to be
assigned to clients that request temporary addresses. Only ta-class
scoped parameters can be defined here. Prefix class is declared as
follows:
\begin{lstlisting}
ta-class {
pool 2001:db8:1::1-2001:db81:1::ffff
}
\end{lstlisting}

\subsubsection{Routing scope}
\label{server-route-scope}
Support for routing configuration was added in 0.8.0RC1. It is
possible to define routing scope. Each scope represents a single
router available on-link. In this scope, routes available via
specified link my be defined.

\begin{lstlisting}
next-hop address-of-a-router
{
route1-parameters
route2-parameters
...
}
\end{lstlisting}

\subsubsection{Server options}

So called standard options are defined by the base DHCPv6 specification,
Expand Down Expand Up @@ -204,6 +247,25 @@ \subsubsection{Server options}
wait for DNS server response during DNS Update before declaring
update a failure. See Section \ref{feature-dns-update}.

\item[class] -- (scope: interface). This definition must be followed by
curly braces and creates a new address class scope. See
Section \ref{server-class-scope}.

\item[pd-class] -- (scope: interface). This definition must be
followed by curly braces and creates a new prefix-delegation class
scope. See Section \ref{server-pd-class-scope}.

\item[ta-class] -- (scope: interface). This definition must be
followed by curly braces and creates a new temporary address class
scope. See Section \ref{server-ta-class-scope}.

\item[next-hop] -- (scope: interface). This definition takes one
parameter that defines IPv6 address of a router. Without any further
parameters, it conveys an information about default route for
bandwidth limited networks. That mode is discouraged, unless there are
significant bandwith limitations. It is usually followed by curly
braces that create a new route scope. See Section \ref{server-route-scope}.

\item[preference] -- (scope: interface, type: 0-255, default:
none). Eech server can be configured to a specific
preference level. When client receives several
Expand Down

0 comments on commit 9233ee2

Please sign in to comment.