├── .gitignore ├── krill ├── start.sh └── Dockerfile ├── bird └── Dockerfile ├── openbgpd └── Dockerfile ├── rift-python └── Dockerfile ├── rpki-client └── Dockerfile ├── SECURITY.md ├── quagga ├── zebra.conf ├── debian.conf ├── Dockerfile └── quagga ├── routinator └── Dockerfile ├── .github ├── PULL_REQUEST_TEMPLATE.md └── ISSUE_TEMPLATE │ ├── add_package.yml │ └── bug_report.yml ├── sdn └── Dockerfile ├── pox └── Dockerfile ├── frr └── Dockerfile ├── scion └── Dockerfile ├── CONTRIBUTING.md ├── base ├── Dockerfile └── .bashrc ├── p4 └── Dockerfile ├── README.md ├── Makefile ├── CODE_OF_CONDUCT.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | .DS_Store -------------------------------------------------------------------------------- /krill/start.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | KRILL="krill" 4 | DATA_DIR="/etc/krill" 5 | KRILL_PID="$DATA_DIR/krill.pid" 6 | CONF="$DATA_DIR/krill.conf" 7 | SCRIPT_OUT="$DATA_DIR/krill.log" 8 | 9 | nohup $KRILL -c $CONF >$SCRIPT_OUT 2>&1 & 10 | echo $! > $KRILL_PID -------------------------------------------------------------------------------- /bird/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | ARG DEBIAN_FRONTEND="noninteractive" 5 | RUN apt update && apt install -y bird 6 | 7 | RUN apt clean && \ 8 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* -------------------------------------------------------------------------------- /openbgpd/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | ARG DEBIAN_FRONTEND="noninteractive" 5 | RUN apt update && apt install -y openbgpd 6 | 7 | RUN apt clean && \ 8 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* -------------------------------------------------------------------------------- /rift-python/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | RUN git clone https://github.com/brunorijsman/rift-python /rift && \ 5 | sed -i 's/\(.*\)==.*/\1/g' /rift/requirements-3-10.txt && \ 6 | python3 -m pip install --no-cache-dir --break-system-packages -r /rift/requirements-3-10.txt 7 | 8 | RUN mkdir /etc/rift -------------------------------------------------------------------------------- /rpki-client/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | ARG DEBIAN_FRONTEND="noninteractive" 5 | RUN apt update && apt install -y rpki-client stayrtr cron 6 | 7 | RUN sed -i -e 's/Type=exec/Type=simple/' /lib/systemd/system/stayrtr.service 8 | 9 | RUN apt clean && \ 10 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | We release patches for security vulnerabilities only for the last image versions. 6 | 7 | ## Reporting a Vulnerability 8 | 9 | Please report (suspected) security vulnerabilities opening an issue or mailing to 10 | **[contact@kathara.org](mailto:contact@kathara.org)**. You will receive a response from 11 | us within 48 hours. If the issue is confirmed, we will release a patch as soon 12 | as possible. 13 | -------------------------------------------------------------------------------- /quagga/zebra.conf: -------------------------------------------------------------------------------- 1 | ! -*- zebra -*- 2 | ! 3 | ! zebra sample configuration file 4 | ! 5 | ! $Id: zebra.conf.sample,v 1.1 2002/12/13 20:15:30 paul Exp $ 6 | ! 7 | hostname Router 8 | password zebra 9 | enable password zebra 10 | ! 11 | ! Interface's description. 12 | ! 13 | !interface lo 14 | ! description test of desc. 15 | ! 16 | !interface sit0 17 | ! multicast 18 | 19 | ! 20 | ! Static default route sample. 21 | ! 22 | !ip route 0.0.0.0/0 203.181.89.241 23 | ! 24 | 25 | !log file /var/log/quagga/zebra.log 26 | -------------------------------------------------------------------------------- /routinator/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | ARG DEBIAN_FRONTEND="noninteractive" 5 | RUN apt update 6 | RUN apt upgrade -y 7 | RUN apt install -y libssl-dev 8 | 9 | ENV PATH=$PATH:/root/.cargo/bin 10 | RUN curl https://sh.rustup.rs -sSf | bash -s -- -y 11 | 12 | RUN git clone https://github.com/NLnetLabs/routinator && \ 13 | cd routinator && cargo build --release --locked && \ 14 | cd .. && rm -Rf routinator/ 15 | 16 | RUN apt clean && \ 17 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 10 | 11 | **- What I did** 12 | 13 | **- How I did it** 14 | 15 | **- How to verify it** 16 | 17 | **- Description for the changelog** 18 | 22 | -------------------------------------------------------------------------------- /krill/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | ARG DEBIAN_FRONTEND="noninteractive" 5 | RUN apt update 6 | RUN apt upgrade -y 7 | RUN apt install -y libssl-dev haproxy 8 | 9 | ENV PATH=$PATH:/root/.cargo/bin 10 | RUN curl https://sh.rustup.rs -sSf | bash -s -- -y 11 | 12 | RUN git clone https://github.com/NLnetLabs/krill && \ 13 | cd krill && cargo build --release --locked && \ 14 | cd .. && rm -Rf krill/ 15 | 16 | RUN mkdir /etc/krill 17 | 18 | COPY start.sh /start.sh 19 | 20 | RUN chmod +x /start.sh 21 | 22 | RUN apt clean && \ 23 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* -------------------------------------------------------------------------------- /sdn/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | ARG DEBIAN_FRONTEND="noninteractive" 5 | RUN apt update 6 | RUN apt upgrade -y 7 | RUN apt install -y \ 8 | gcc \ 9 | libffi-dev \ 10 | libssl-dev \ 11 | libxml2-dev \ 12 | libxslt1-dev \ 13 | openvswitch-common \ 14 | openvswitch-switch \ 15 | zlib1g-dev 16 | 17 | RUN python3 -m pip install --no-cache-dir --break-system-packages eventlet==0.30.2 18 | RUN python3 -m pip install --no-cache-dir --break-system-packages ryu 19 | 20 | RUN /usr/bin/ovsdb-tool create /etc/openvswitch/conf.db 21 | RUN mkdir -pv /var/run/openvswitch/ 22 | 23 | RUN ln -s /bin/true /usr/local/sbin/modprobe 24 | 25 | ENV OVS_SBINDIR="/usr/local/sbin" 26 | 27 | RUN apt clean && \ 28 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* 29 | -------------------------------------------------------------------------------- /quagga/debian.conf: -------------------------------------------------------------------------------- 1 | # 2 | # If this option is set the /etc/init.d/quagga script automatically loads 3 | # the config via "vtysh -b" when the servers are started. 4 | # Check /etc/pam.d/quagga if you intend to use "vtysh"! 5 | # 6 | vtysh_enable=yes 7 | zebra_options=" --daemon -A 127.0.0.1" 8 | bgpd_options=" --daemon -A 127.0.0.1" 9 | ospfd_options=" --daemon -A 127.0.0.1" 10 | ospf6d_options=" --daemon -A ::1" 11 | ripd_options=" --daemon -A 127.0.0.1" 12 | ripngd_options=" --daemon -A ::1" 13 | isisd_options=" --daemon -A 127.0.0.1" 14 | # 15 | # Please note that watchquagga_options is an array and not a string so that 16 | # quotes can be used. 17 | # 18 | # The list of daemons to watch is automatically generated by the init script 19 | # from daemons.conf and appended to the watchquagga_options. 20 | # Example: 21 | # watchquagga_options=("-Adz" "-r" '/sbin/service %s restart' -s '/sbin/service %s start' -k '/sbin/service %s stop') 22 | watchquagga_enable=yes 23 | watchquagga_options=(--daemon) 24 | -------------------------------------------------------------------------------- /pox/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team , Riccardo Gobbato" 3 | 4 | ARG DEBIAN_FRONTEND="noninteractive" 5 | RUN apt update 6 | RUN apt upgrade -y 7 | 8 | RUN apt install -y zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libsqlite3-dev libreadline-dev libffi-dev libbz2-dev 9 | 10 | RUN wget https://www.python.org/ftp/python/3.9.17/Python-3.9.17.tar.xz && \ 11 | tar xfv Python-3.9.17.tar.xz && \ 12 | cd Python-3.9.17 && \ 13 | ./configure --enable-optimizations --enable-shared && \ 14 | make -j8 build_all && \ 15 | make -j8 altinstall && \ 16 | ldconfig && \ 17 | cd .. && rm -rf Python-3.9.17* 18 | 19 | RUN apt remove -y zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libsqlite3-dev libreadline-dev libffi-dev libbz2-dev 20 | 21 | RUN python3.9 -m pip install networkx 22 | 23 | RUN git clone https://github.com/noxrepo/pox.git && \ 24 | chmod +x /pox/pox.py 25 | 26 | RUN apt clean && \ 27 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/add_package.yml: -------------------------------------------------------------------------------- 1 | name: Add Package To Image 2 | description: Suggest a package to add to a Kathará Docker image 3 | body: 4 | - type: markdown 5 | attributes: 6 | value: | 7 | --- 8 | 9 | Thank you for contributing to Kathará with new ideas! 10 | - type: input 11 | id: image 12 | attributes: 13 | label: Image Name 14 | description: "Which Kathará image you want to improve with the new package?" 15 | placeholder: "kathara/frr" 16 | validations: 17 | required: true 18 | - type: textarea 19 | id: bug-description 20 | attributes: 21 | label: Related Bug 22 | description: "Is your package request related to a problem? Please describe." 23 | - type: textarea 24 | id: feature-description 25 | attributes: 26 | label: Package Description 27 | description: "Why is it a good idea add this package to the Kathará image?" 28 | validations: 29 | required: true 30 | - type: textarea 31 | id: solution 32 | attributes: 33 | label: Solution 34 | description: "Describe the solution you would like." 35 | - type: textarea 36 | id: alternatives 37 | attributes: 38 | label: Alternative Solutions 39 | description: "Describe alternative solutions you have considered." 40 | - type: textarea 41 | id: context 42 | attributes: 43 | label: Additional Context 44 | description: "Add any other context or screenshots about the feature request here." 45 | -------------------------------------------------------------------------------- /frr/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | RUN curl -s https://deb.frrouting.org/frr/keys.asc | apt-key add - 5 | 6 | RUN echo "deb https://deb.frrouting.org/frr $(lsb_release -s -c) \"frr-9\"" | tee -a /etc/apt/sources.list.d/frr.list 7 | 8 | ARG DEBIAN_FRONTEND="noninteractive" 9 | RUN apt update && apt install -y frr frr-pythontools frr-rpki-rtrlib 10 | 11 | RUN sed -i -e 's/service/no service/' /etc/frr/vtysh.conf \ 12 | && rm /etc/frr/frr.conf 13 | 14 | RUN apt clean && \ 15 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* 16 | 17 | RUN sed -i 's|ExecStart=/usr/lib/frr/frrinit.sh start|ExecStart=/usr/bin/su -c "/usr/lib/frr/frrinit.sh start"|' /lib/systemd/system/frr.service && \ 18 | sed -i 's|ExecStop=/usr/lib/frr/frrinit.sh stop|ExecStop=/usr/bin/su -c "/usr/lib/frr/frrinit.sh stop"|' /lib/systemd/system/frr.service && \ 19 | sed -i 's|ExecReload=/usr/lib/frr/frrinit.sh reload|ExecReload=/usr/bin/su -c "/usr/lib/frr/frrinit.sh reload"|' /lib/systemd/system/frr.service && \ 20 | sed -i 's|ExecStart=/usr/lib/frr/frrinit.sh start|ExecStart=/usr/bin/su -c "/usr/lib/frr/frrinit.sh start"|' /lib/systemd/system/frr\@.service && \ 21 | sed -i 's|ExecStop=/usr/lib/frr/frrinit.sh stop|ExecStop=/usr/bin/su -c "/usr/lib/frr/frrinit.sh stop"|' /lib/systemd/system/frr\@.service && \ 22 | sed -i 's|ExecReload=/usr/lib/frr/frrinit.sh reload|ExecReload=/usr/bin/su -c "/usr/lib/frr/frrinit.sh reload"|' /lib/systemd/system/frr\@.service 23 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: Bug Report 2 | description: Report a bug in a Kathará Docker image 3 | body: 4 | - type: markdown 5 | attributes: 6 | value: | 7 | Before opening a bug report, please search for the behaviour in the existing issues. 8 | 9 | --- 10 | 11 | Thank you for taking the time to file a bug report. To address this bug as fast as possible, we need some information. 12 | - type: input 13 | id: image 14 | attributes: 15 | label: Image Name 16 | description: "With which Kathará image did you encounter problems?" 17 | placeholder: "kathara/frr" 18 | validations: 19 | required: true 20 | - type: textarea 21 | id: bug-description 22 | attributes: 23 | label: Bug Description 24 | description: "What happened?" 25 | validations: 26 | required: true 27 | - type: textarea 28 | id: steps 29 | attributes: 30 | label: Steps To Reproduce 31 | description: "Which steps do we need to take to reproduce this error? Attach also a network scenario to reproduce the error." 32 | validations: 33 | required: true 34 | - type: textarea 35 | id: expected 36 | attributes: 37 | label: Expected Behavior 38 | description: "A description of what you expected to happen." 39 | validations: 40 | required: true 41 | - type: textarea 42 | id: context 43 | attributes: 44 | label: Additional Context 45 | description: "Add any other context or screenshots about the feature request here." 46 | -------------------------------------------------------------------------------- /scion/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Network Security Group, ETH Zurich " 3 | 4 | # Install SCION from GitHub release 5 | ARG DEBIAN_FRONTEND="noninteractive" 6 | ARG TARGETARCH 7 | 8 | WORKDIR /tmp 9 | 10 | RUN wget https://github.com/scionproto/scion/releases/download/v0.12.0/scion_0.12.0_deb_$TARGETARCH.tar.gz && \ 11 | tar xfz scion_0.12.0_deb_$TARGETARCH.tar.gz && \ 12 | apt install ./scion*.deb && \ 13 | apt clean && \ 14 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* 15 | 16 | # Strip templating from systemd service files, systemd-replacement-script does not support it 17 | RUN mv /usr/lib/systemd/system/scion-router\@.service /usr/lib/systemd/system/scion-router.service && \ 18 | sed -i 's/%i/br/g' /usr/lib/systemd/system/scion-router.service && \ 19 | mv /usr/lib/systemd/system/scion-control\@.service /usr/lib/systemd/system/scion-control.service && \ 20 | sed -i 's/%i/cs/g' /usr/lib/systemd/system/scion-control.service 21 | 22 | # Adjust scion-ip-gateway.service for compatibility with docker environment 23 | RUN sed -i 's/^User=scion/User=root/' /usr/lib/systemd/system/scion-ip-gateway.service && \ 24 | sed -i 's/^Group=scion/Group=root/' /usr/lib/systemd/system/scion-ip-gateway.service && \ 25 | sed -i '/^AmbientCapabilities=cap_net_admin/d' /usr/lib/systemd/system/scion-ip-gateway.service && \ 26 | sed -i '/^\[Service\]/a ExecStartPre=\/bin\/bash -c '"'"'mkdir -p /dev/net; mknod /dev/net/tun c 10 200; chmod 600 /dev/net/tun'"'"'' /usr/lib/systemd/system/scion-ip-gateway.service 27 | 28 | WORKDIR / 29 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ## How to contribute to Kathará 2 | 3 | :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: 4 | 5 | #### Code of Conduct 6 | 7 | This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). 8 | By participating, you are expected to uphold this code. Please report unacceptable behavior to [contact@kathara.org](mailto:contact@kathara.org). 9 | 10 | #### **Did you find a bug?** 11 | 12 | * **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/KatharaFramework/Docker-Images/issues). 13 | 14 | * If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/KatharaFramework/Docker-Images/issues/new/choose). 15 | Be sure to include a **title and clear description**, as much relevant information as possible. Use the bug report template to create the issue. 16 | 17 | #### **Did you write a patch that fixes a bug?** 18 | 19 | * Open a new GitHub pull request with the patch. 20 | 21 | * Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. 22 | 23 | #### **Do you intend to add a new feature or change an existing one?** 24 | 25 | * Open a new GitHub pull request with the new feature. Ensure the PR description clearly describes the new feature and provides proper use cases. 26 | 27 | * Open an issue describing the requested feature and the reason you need it (reporting use cases). 28 | 29 | Kathará is a volunteer effort. We encourage you to contribute to the project! Thanks! :heart: :heart: :heart: 30 | 31 | Kathará Team :rocket: 32 | -------------------------------------------------------------------------------- /base/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM debian:12 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | ENV LANG C.UTF-8 5 | ENV LC_ALL C.UTF-8 6 | 7 | ARG DEBIAN_FRONTEND="noninteractive" 8 | RUN apt update 9 | RUN apt upgrade -y 10 | RUN apt install -y \ 11 | apache2 \ 12 | apache2-bin \ 13 | apt-utils \ 14 | apt-transport-https \ 15 | arping \ 16 | arptables \ 17 | bind9 \ 18 | bind9-utils \ 19 | bison \ 20 | bridge-utils \ 21 | build-essential \ 22 | curl \ 23 | diffutils \ 24 | dnsutils \ 25 | dublin-traceroute \ 26 | ethtool \ 27 | expect \ 28 | flex \ 29 | geoip-database \ 30 | git \ 31 | gnupg \ 32 | hping3 \ 33 | ieee-data \ 34 | ifupdown \ 35 | iperf3 \ 36 | iptables \ 37 | iputils-ping \ 38 | iputils-tracepath \ 39 | less \ 40 | libdublintraceroute-dev \ 41 | libjsoncpp-dev \ 42 | libpcap-dev \ 43 | libtins-dev \ 44 | links \ 45 | lsb-base \ 46 | lsb-release \ 47 | make \ 48 | man-db \ 49 | mtr \ 50 | nano \ 51 | ndisc6 \ 52 | net-tools \ 53 | netbase \ 54 | netcat-openbsd \ 55 | openssh-client \ 56 | openssh-server \ 57 | openssh-sftp-server \ 58 | openssl \ 59 | pkg-config \ 60 | python3-dev \ 61 | python3-pip \ 62 | radvd \ 63 | rsync \ 64 | screen \ 65 | sed \ 66 | systemd-userdbd \ 67 | tar \ 68 | tcpdump \ 69 | telnet \ 70 | tmux \ 71 | traceroute \ 72 | wget \ 73 | vim 74 | 75 | WORKDIR /tmp 76 | 77 | RUN FILE_NAME=`wget -q -O - https://mirrors.edge.kernel.org/pub/linux/utils/net/iproute2/ | \ 78 | tac | \ 79 | grep -m 1 -o "iproute2-6[\.0-9]*[0-9]" | \ 80 | head -n 1` && \ 81 | wget -q https://mirrors.edge.kernel.org/pub/linux/utils/net/iproute2/$FILE_NAME.tar.xz && \ 82 | tar xf $FILE_NAME.tar.xz && \ 83 | cd $FILE_NAME && \ 84 | ./configure && \ 85 | make -j$(nproc --ignore=4) && \ 86 | make install && \ 87 | cd .. && \ 88 | rm -r $FILE_NAME && \ 89 | rm $FILE_NAME.tar.xz 90 | 91 | RUN python3 -m pip install --no-cache-dir --upgrade --break-system-packages pip && \ 92 | python3 -m pip install --no-cache-dir --break-system-packages scapy dublintraceroute tabulate 93 | 94 | RUN ln -s /etc/init.d/named /etc/init.d/bind 95 | 96 | RUN wget https://raw.githubusercontent.com/gdraheim/docker-systemctl-replacement/master/files/docker/systemctl3.py -O /usr/local/bin/systemctl && \ 97 | chmod +x /usr/local/bin/systemctl 98 | 99 | COPY .bashrc /root/.bashrc 100 | 101 | RUN apt clean && \ 102 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* 103 | 104 | WORKDIR / 105 | 106 | VOLUME /hosthome 107 | VOLUME /shared 108 | -------------------------------------------------------------------------------- /quagga/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | ARG DEBIAN_FRONTEND="noninteractive" 5 | RUN apt update 6 | RUN apt upgrade -y 7 | RUN apt install -y \ 8 | autoconf \ 9 | gawk \ 10 | libc-ares-dev \ 11 | libreadline-dev \ 12 | libtool \ 13 | texinfo 14 | 15 | RUN wget -q https://github.com/Quagga/quagga/releases/download/quagga-1.2.4/quagga-1.2.4.tar.gz && \ 16 | tar xfvz quagga-1.2.4.tar.gz && \ 17 | cd quagga-1.2.4 && \ 18 | ./configure CFLAGS="-fcommon" \ 19 | --enable-user=quagga \ 20 | --enable-group=quagga \ 21 | --enable-vty-group=quaggavty \ 22 | --prefix=/usr \ 23 | --sysconfdir=/etc/quagga \ 24 | --localstatedir=/var/state/quagga && \ 25 | make -j$(nproc --ignore=4) && make install && ldconfig && \ 26 | cd .. && rm -Rf quagga-1.2.4* 27 | 28 | RUN addgroup --system quaggavty > /dev/null && \ 29 | addgroup --system quagga > /dev/null && \ 30 | adduser --system --ingroup quagga --home /var/state/quagga --gecos "Quagga routing suite" --shell /bin/false quagga > /dev/null && \ 31 | usermod -aG quaggavty quagga && \ 32 | install -m 755 -o quagga -g quagga -d /var/log/quagga && \ 33 | install -m 755 -o quagga -g quagga -d /var/state/quagga && \ 34 | install -m 775 -o quagga -g quaggavty -d /etc/quagga && \ 35 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/zebra.conf && \ 36 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/bgpd.conf && \ 37 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/ospfd.conf && \ 38 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/ospf6d.conf && \ 39 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/isisd.conf && \ 40 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/ripd.conf && \ 41 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/ripngd.conf && \ 42 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/pimd.conf && \ 43 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/ldpd.conf && \ 44 | install -m 640 -o quagga -g quagga /dev/null /etc/quagga/nhrpd.conf && \ 45 | install -m 640 -o quagga -g quaggavty /dev/null /etc/quagga/vtysh.conf 46 | 47 | RUN ln -s /var/log/quagga /var/log/zebra 48 | RUN ln -s /etc/quagga /etc/zebra 49 | 50 | COPY zebra.conf /etc/quagga/zebra.conf 51 | RUN chown quagga:quagga /etc/quagga/zebra.conf 52 | RUN chmod 640 /etc/quagga/zebra.conf 53 | 54 | COPY debian.conf /etc/quagga/debian.conf 55 | RUN chown quagga:quagga /etc/quagga/debian.conf 56 | RUN chmod 640 /etc/quagga/debian.conf 57 | 58 | COPY quagga /etc/init.d/quagga 59 | RUN chown root:root /etc/init.d/quagga 60 | RUN chmod 0755 /etc/init.d/quagga 61 | RUN ln -s /etc/init.d/quagga /etc/init.d/zebra 62 | 63 | RUN apt remove -y autoconf gawk texinfo && apt autoremove -y && \ 64 | apt clean && \ 65 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/* -------------------------------------------------------------------------------- /p4/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM kathara/base 2 | LABEL org.opencontainers.image.authors="Kathara Team " 3 | 4 | ARG DEBIAN_FRONTEND="noninteractive" 5 | RUN apt update 6 | RUN apt upgrade -y 7 | RUN apt install -y \ 8 | automake \ 9 | cmake \ 10 | g++ \ 11 | libgc-dev \ 12 | libgmp-dev \ 13 | libpcap-dev \ 14 | libboost-dev \ 15 | libboost-test-dev \ 16 | libboost-program-options-dev \ 17 | libboost-system-dev \ 18 | libboost-filesystem-dev \ 19 | libboost-thread-dev \ 20 | libboost-iostreams-dev \ 21 | libboost-graph-dev \ 22 | libevent-dev \ 23 | libjudy-dev \ 24 | libprotobuf-dev \ 25 | libssl-dev \ 26 | libelf-dev \ 27 | libtool \ 28 | llvm \ 29 | protobuf-compiler 30 | 31 | WORKDIR /tmp 32 | 33 | RUN git clone --recursive https://github.com/p4lang/p4c.git && \ 34 | cd p4c && mkdir build && cd build && \ 35 | cmake .. -DENABLE_EBPF=OFF -DENABLE_UBPF=OFF -DENABLE_DPDK=OFF -DENABLE_P4TC=OFF && \ 36 | make -j$(nproc --ignore=4) && \ 37 | make install && ldconfig && \ 38 | cd .. && rm -Rf p4c/ 39 | 40 | RUN git clone --depth=1 -b v1.43.2 https://github.com/google/grpc.git && \ 41 | cd grpc && \ 42 | git submodule update --init --recursive && \ 43 | mkdir -p cmake/build && cd cmake/build && \ 44 | cmake ../.. && make -j$(nproc --ignore=4) && \ 45 | make install && ldconfig && \ 46 | cd ../.. && rm -Rf grpc && \ 47 | git clone https://github.com/p4lang/PI && \ 48 | cd PI && \ 49 | git submodule update --init && \ 50 | ./autogen.sh && \ 51 | ./configure --with-proto && make -j$(nproc --ignore=4) && \ 52 | make install && ldconfig && \ 53 | cd .. && rm -Rf PI 54 | 55 | WORKDIR / 56 | 57 | RUN git clone https://github.com/p4lang/behavioral-model && \ 58 | cd behavioral-model && \ 59 | sed -i 's/sudo//g' ci/install-thrift.sh && bash ci/install-thrift.sh && \ 60 | sed -i 's/sudo//g' ci/install-nanomsg.sh && bash ci/install-nanomsg.sh && \ 61 | ldconfig && \ 62 | sed -i 's/sudo//g' ci/install-nnpy.sh && \ 63 | sed -i 's/pip3 install/pip3 install --no-cache-dir --break-system-packages/g' ci/install-nnpy.sh && bash ci/install-nnpy.sh && \ 64 | ./autogen.sh && \ 65 | ./configure --with-pi && \ 66 | make -j$(nproc --ignore=4) && \ 67 | make install && ldconfig 68 | 69 | RUN cd behavioral-model/tools && make install && \ 70 | cd / && mv behavioral-model/tools . && \ 71 | rm -Rf behavioral-model/ 72 | 73 | RUN python3 -m pip install --no-cache-dir --break-system-packages p4runtime && \ 74 | git clone https://github.com/p4lang/tutorials.git && \ 75 | mv tutorials/utils/p4runtime_lib /usr/local/lib/python$(python3 -c "import platform; v = platform.python_version_tuple(); print(v[0] + '.' + v[1])")/site-packages/p4runtime_lib && \ 76 | rm -Rf tutorials 77 | 78 | RUN echo "export PYTHONPATH=\$PYTHONPATH:/usr/local/lib/python$(python3 -c "import platform; v = platform.python_version_tuple(); print(v[0] + '.' + v[1])")/site-packages/" >> /root/.bashrc 79 | 80 | ENV PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION python 81 | 82 | RUN apt remove -y automake cmake g++ llvm && apt autoremove -y && \ 83 | apt clean && \ 84 | rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/ -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Docker Images 2 | 3 | This repository contains `Dockerfile`s used to build Kathará images. A list of the Docker images we provide can be found at [this page](https://hub.docker.com/u/kathara/) in the Docker Hub. 4 | Images are built both with `docker build` and with `docker buildx` for multi-architecture support. 5 | Currently our images are based on Debian 11 and are compiled for `amd64` and `arm64`. 6 | If you need images based on other Linux distributions, feel free to create a PR with other Dockerfiles. 7 | 8 | Currently available images are: 9 | - `kathara/base`: used to build all other images. It contains a variety of network tools and some complex services like bind, apache, etc. 10 | - `kathara/quagga`: extends the base image adding [Quagga](https://www.nongnu.org/quagga/). 11 | - `kathara/frr`: extends the base image adding [FRRouting](https://frrouting.org/). 12 | - `kathara/openbgpd`: extend the base image adding the [OpenBGPD daemon](https://www.openbgpd.org/). 13 | - `kathara/krill`: extends the base image adding [Krill RPKI Certificate Authority](https://www.nlnetlabs.nl/projects/rpki/krill/). 14 | - `kathara/routinator`: extends the base image adding [Routinator RPKI Relying Party](https://www.nlnetlabs.nl/projects/rpki/routinator/). 15 | - `kathara/rpki-client`: extends the base image adding [OpenBGPD RPKI Client](https://www.rpki-client.org). 16 | - `kathara/bird`: extends the base image adding [BIRD](https://bird.network.cz/). 17 | - `kathara/rift-python`: extends the base image adding [Routing In Fat Trees (RIFT) Python Implementation](https://github.com/brunorijsman/rift-python). 18 | - `kathara/sdn`: extends the base image adding [OpenVSwitch](https://www.openvswitch.org/) and [Ryu SDN controller](https://osrg.github.io/ryu/). 19 | - `kathara/p4`: extends the base image adding [Behavioral Model (bmv2)](https://github.com/p4lang/behavioral-model) to compile and run P4-compliant programmable switches. 20 | - `kathara/pox`: extends the base image adding [POX](https://github.com/noxrepo/pox) (Python based SDN Controller) and python3-networkx. 21 | - `kathara/scion`: extends the base image adding [SCION](https://scion-architecture.net) (Scalability, Control, and Isolation On Next-Generation Networks). 22 | 23 | 24 | ## Building from source 25 | To build an image from source, run `make ` to build for the current architecture. 26 | To build an image with `docker buildx` for multi-architectures use the command `make -multi`. 27 | **Beware**: building images with `docker buildx` automatically push the images on the Kathará Docker Hub. If you are not allowed to push, change the `Makefile` before running `make`. 28 | 29 | Example: `make quagga` or `make quagga-multi`. 30 | 31 | ## Extend Kathará Images 32 | 33 | The easiest way to extend a Kathará image is to clone this repository, change the Dockerfile according to your needings and locally build the new image. 34 | 35 | If you instead want to alter (locally) an existing Kathará image, refer to the following steps: 36 | 1. `docker pull kathara/` 37 | 2. `docker run -tid --name kathara/` 38 | 3. `docker exec -ti bash` 39 | 4. Do your thing, then exit. 40 | 5. `docker commit kathara/` 41 | 6. `docker rm -f ` 42 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | BUILDX=docker buildx build --platform linux/amd64,linux/arm64 2 | 3 | .PHONY: base quagga frr bird openbgpd krill routinator rpki-client rift-python sdn p4 scion all pushall all-multi create-builder base-multi quagga-multi frr-multi bird-multi openbgpd-multi krill-multi routinator-multi rpki-client-multi rift-python-multi sdn-multi p4-multi scion-multi delete-builder 4 | 5 | all: base quagga frr bird openbgpd krill rpki-client routinator rift-python sdn p4 scion 6 | all-multi: create-builder base-multi quagga-multi frr-multi bird-multi openbgpd-multi krill-multi routinator-multi rpki-client-multi rift-python-multi sdn-multi p4-multi scion-multi delete-builder 7 | 8 | pushall: 9 | docker push kathara/base 10 | docker push kathara/quagga 11 | docker push kathara/frr 12 | docker push kathara/bird 13 | docker push kathara/openbgpd 14 | docker push kathara/krill 15 | docker push kathara/routinator 16 | docker push kathara/rpki-client 17 | docker push kathara/rift-python 18 | docker push kathara/sdn 19 | docker push kathara/p4 20 | docker push kathara/scion 21 | 22 | base: 23 | docker build -t kathara/base base 24 | 25 | quagga: base 26 | docker build -t kathara/quagga quagga 27 | 28 | frr: base 29 | docker build -t kathara/frr frr 30 | 31 | bird: base 32 | docker build -t kathara/bird bird 33 | 34 | openbgpd: base 35 | docker build -t kathara/openbgpd openbgpd 36 | 37 | krill: base 38 | docker build -t kathara/krill krill 39 | 40 | routinator: base 41 | docker build -t kathara/routinator routinator 42 | 43 | rpki-client: base 44 | docker build -t kathara/rpki-client rpki-client 45 | 46 | rift-python: base 47 | docker build -t kathara/rift-python rift-python 48 | 49 | sdn: base 50 | docker build -t kathara/sdn sdn 51 | 52 | pox: base 53 | docker build -t kathara/pox pox 54 | 55 | p4: base 56 | docker build -t kathara/p4 p4 57 | 58 | scion: base 59 | docker build -t kathara/scion scion 60 | 61 | base-multi: create-builder 62 | $(BUILDX) -t kathara/base --push base 63 | 64 | quagga-multi: create-builder base-multi 65 | $(BUILDX) -t kathara/quagga --push quagga 66 | 67 | frr-multi: create-builder base-multi 68 | $(BUILDX) -t kathara/frr --push frr 69 | 70 | bird-multi: create-builder base-multi 71 | $(BUILDX) -t kathara/bird --push bird 72 | 73 | openbgpd-multi: create-builder base-multi 74 | $(BUILDX) -t kathara/openbgpd --push openbgpd 75 | 76 | krill-multi: create-builder base-multi 77 | $(BUILDX) -t kathara/krill --push krill 78 | 79 | routinator-multi: create-builder base-multi 80 | $(BUILDX) -t kathara/routinator --push routinator 81 | 82 | rpki-client-multi: create-builder base-multi 83 | $(BUILDX) -t kathara/rpki-client --push rpki-client 84 | 85 | rift-python-multi: create-builder base-multi 86 | $(BUILDX) -t kathara/rift-python --push rift-python 87 | 88 | sdn-multi: create-builder base-multi 89 | $(BUILDX) -t kathara/sdn --push sdn 90 | 91 | pox-multi: create-builder base-multi 92 | $(BUILDX) -t kathara/pox --push pox 93 | 94 | p4-multi: create-builder base-multi 95 | $(BUILDX) -t kathara/p4 --push p4 96 | 97 | scion-multi: create-builder base-multi 98 | $(BUILDX) -t kathara/scion --push scion 99 | 100 | create-builder: 101 | docker buildx create --name kat-builder --use 102 | docker buildx inspect --bootstrap 103 | 104 | delete-builder: 105 | docker buildx rm kat-builder 106 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at contact@kathara.org. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /base/.bashrc: -------------------------------------------------------------------------------- 1 | # ~/.bashrc: executed by bash(1) for non-login shells. 2 | # see /usr/share/doc/bash/examples/startup-files (in the package bash-doc) 3 | # for examples 4 | 5 | # If not running interactively, don't do anything 6 | [ -z "$PS1" ] && return 7 | 8 | # don't put duplicate lines in the history. See bash(1) for more options 9 | # ... or force ignoredups and ignorespace 10 | HISTCONTROL=ignoredups:ignorespace 11 | 12 | # append to the history file, don't overwrite it 13 | shopt -s histappend 14 | 15 | # for setting history length see HISTSIZE and HISTFILESIZE in bash(1) 16 | HISTSIZE=1000 17 | HISTFILESIZE=2000 18 | 19 | # check the window size after each command and, if necessary, 20 | # update the values of LINES and COLUMNS. 21 | shopt -s checkwinsize 22 | 23 | # make less more friendly for non-text input files, see lesspipe(1) 24 | [ -x /usr/bin/lesspipe ] && eval "$(SHELL=/bin/sh lesspipe)" 25 | 26 | # set variable identifying the chroot you work in (used in the prompt below) 27 | if [ -z "$debian_chroot" ] && [ -r /etc/debian_chroot ]; then 28 | debian_chroot=$(cat /etc/debian_chroot) 29 | fi 30 | 31 | # set a fancy prompt (non-color, unless we know we "want" color) 32 | case "$TERM" in 33 | xterm-color) color_prompt=yes;; 34 | esac 35 | 36 | # uncomment for a colored prompt, if the terminal has the capability; turned 37 | # off by default to not distract the user: the focus in a terminal window 38 | # should be on the output of commands, not on the prompt 39 | #force_color_prompt=yes 40 | 41 | if [ -n "$force_color_prompt" ]; then 42 | if [ -x /usr/bin/tput ] && tput setaf 1 >&/dev/null; then 43 | # We have color support; assume it's compliant with Ecma-48 44 | # (ISO/IEC-6429). (Lack of such support is extremely rare, and such 45 | # a case would tend to support setf rather than setaf.) 46 | color_prompt=yes 47 | else 48 | color_prompt= 49 | fi 50 | fi 51 | 52 | if [ "$color_prompt" = yes ]; then 53 | PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\$ ' 54 | else 55 | PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w\$ ' 56 | fi 57 | unset color_prompt force_color_prompt 58 | 59 | # If this is an xterm set the title to user@host:dir 60 | case "$TERM" in 61 | xterm*|rxvt*) 62 | PS1="\[\e]0;${debian_chroot:+($debian_chroot)}\u@\h: \w\a\]$PS1" 63 | ;; 64 | *) 65 | ;; 66 | esac 67 | 68 | # enable color support of ls and also add handy aliases 69 | if [ -x /usr/bin/dircolors ]; then 70 | test -r ~/.dircolors && eval "$(dircolors -b ~/.dircolors)" || eval "$(dircolors -b)" 71 | alias ls='ls --color=auto' 72 | #alias dir='dir --color=auto' 73 | #alias vdir='vdir --color=auto' 74 | 75 | alias grep='grep --color=auto' 76 | alias fgrep='fgrep --color=auto' 77 | alias egrep='egrep --color=auto' 78 | fi 79 | 80 | # some more ls aliases 81 | alias ll='ls -alF' 82 | alias la='ls -A' 83 | alias l='ls -CF' 84 | 85 | # Alias definitions. 86 | # You may want to put all your additions into a separate file like 87 | # ~/.bash_aliases, instead of adding them here directly. 88 | # See /usr/share/doc/bash-doc/examples in the bash-doc package. 89 | 90 | if [ -f ~/.bash_aliases ]; then 91 | . ~/.bash_aliases 92 | fi 93 | 94 | # enable programmable completion features (you don't need to enable 95 | # this, if it's already enabled in /etc/bash.bashrc and /etc/profile 96 | # sources /etc/bash.bashrc). 97 | #if [ -f /etc/bash_completion ] && ! shopt -oq posix; then 98 | # . /etc/bash_completion 99 | #fi 100 | 101 | export VTYSH_PAGER="less -EFX" 102 | -------------------------------------------------------------------------------- /quagga/quagga: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | ### BEGIN INIT INFO 4 | # Provides: quagga 5 | # Required-Start: $local_fs $network $remote_fs $syslog 6 | # Required-Stop: $local_fs $network $remote_fs $syslog 7 | # Default-Start: 2 3 4 5 8 | # Default-Stop: 0 1 6 9 | # Short-Description: start and stop the Quagga routing suite 10 | # Description: Quagga is a routing suite for IP routing protocols like 11 | # BGP, OSPF, RIP and others. This script contols the main 12 | # daemon "quagga" as well as the individual protocol daemons. 13 | ### END INIT INFO 14 | # 15 | 16 | PATH=/bin:/usr/bin:/sbin:/usr/sbin 17 | D_PATH=/usr/sbin 18 | C_PATH=/etc/quagga 19 | 20 | # Local Daemon selection may be done by using /etc/quagga/daemons. 21 | # See /usr/share/doc/quagga/README.Debian.gz for further information. 22 | # Keep zebra first and do not list watchquagga! 23 | DAEMONS="zebra bgpd ripd ripngd ospfd ospf6d isisd" 24 | 25 | . /lib/lsb/init-functions 26 | 27 | # Print the name of the pidfile. 28 | pidfile() 29 | { 30 | echo "/var/run/quagga/$1.pid" 31 | } 32 | 33 | # Check if daemon is started by using the pidfile. 34 | started() 35 | { 36 | [ -e `pidfile $1` ] && kill -0 `cat \`pidfile $1\`` 2> /dev/null && return 0 37 | return 1 38 | } 39 | 40 | # Loads the config via vtysh -b if configured to do so. 41 | vtysh_b () 42 | { 43 | # Rember, that all variables have been incremented by 1 in convert_daemon_prios() 44 | if [ "$vtysh_enable" = 2 -a -f $C_PATH/Quagga.conf ]; then 45 | /usr/bin/vtysh -b 46 | fi 47 | } 48 | 49 | # Check if the daemon is activated and if its executable and config files 50 | # are in place. 51 | # params: daemon name 52 | # returns: 0=ok, 1=error 53 | check_daemon() 54 | { 55 | # If the integrated config file is used the others are not checked. 56 | if [ -r "$C_PATH/Quagga.conf" ]; then 57 | return 0 58 | fi 59 | 60 | # vtysh_enable has no config file nor binary so skip check. 61 | # (Not sure why vtysh_enable is in this list but does not hurt) 62 | if [ $1 != "watchquagga" -a $1 != "vtysh_enable" ]; then 63 | # check for daemon binary 64 | if [ ! -x "$D_PATH/$1" ]; then return 1; fi 65 | 66 | # check for config file 67 | if [ ! -r "$C_PATH/$1.conf" ]; then 68 | echo -n " (not started without config file)" 69 | return 1 70 | fi 71 | fi 72 | return 0 73 | } 74 | 75 | # Starts the server if it's not alrady running according to the pid file. 76 | # The Quagga daemons creates the pidfile when starting. 77 | start() 78 | { 79 | echo -n " $1" 80 | if ! check_daemon $1; then return; fi 81 | 82 | if [ "$1" = "watchquagga" ]; then 83 | start-stop-daemon \ 84 | --oknodo \ 85 | --start \ 86 | --pidfile=`pidfile $1` \ 87 | --exec "$D_PATH/$1" \ 88 | -- \ 89 | "${watchquagga_options[@]}" 90 | else 91 | start-stop-daemon \ 92 | --start \ 93 | --pidfile=`pidfile $1` \ 94 | --exec "$D_PATH/$1" \ 95 | -- \ 96 | `eval echo "$""$1""_options"` 97 | fi 98 | } 99 | 100 | # Stop the daemon given in the parameter, printing its name to the terminal. 101 | stop() 102 | { 103 | if ! started "$1" ; then 104 | echo -n " ($1)" 105 | return 0 106 | else 107 | PIDFILE=`pidfile $1` 108 | PID=`cat $PIDFILE 2>/dev/null` 109 | start-stop-daemon --stop --quiet --oknodo --exec "$D_PATH/$1" 110 | # 111 | # Now we have to wait until $DAEMON has _really_ stopped. 112 | # 113 | if test -n "$PID" && kill -0 $PID 2>/dev/null; then 114 | echo -n " (waiting) ." 115 | cnt=0 116 | while kill -0 $PID 2>/dev/null; do 117 | cnt=`expr $cnt + 1` 118 | if [ $cnt -gt 60 ]; then 119 | # Waited 120 secs now, fail. 120 | echo -n "Failed.. " 121 | break 122 | fi 123 | sleep 2 124 | echo -n "." 125 | done 126 | fi 127 | echo -n " $1" 128 | rm -f `pidfile $1` 129 | fi 130 | } 131 | 132 | # Converts values from /etc/quagga/daemons to all-numeric values. 133 | convert_daemon_prios() 134 | { 135 | for name in $DAEMONS zebra vtysh_enable watchquagga_enable; do 136 | # First, assign the value set by the user to $value 137 | eval value=\$$name 138 | 139 | # Daemon not activated or entry missing? 140 | if [ "$value" = "no" -o "$value" = "" ]; then value=0; fi 141 | 142 | # These strings parsed for backwards compatibility. 143 | if [ "$value" = "yes" -o "$value" = "true" ]; then value=1; fi 144 | 145 | # Zebra is threatened special. It must be between 0=off and the first 146 | # user assigned value "1" so we increase all other enabled daemons' values. 147 | if [ "$name" != "zebra" -a "$value" -gt 0 ]; then value=`expr "$value" + 1`; fi 148 | 149 | # If e.g. name is zebra then we set "zebra=yes". 150 | eval $name=$value 151 | done 152 | } 153 | 154 | # Starts watchquagga for all wanted daemons. 155 | start_watchquagga() 156 | { 157 | local daemon_name 158 | local daemon_prio 159 | local found_one 160 | 161 | # Start the monitor daemon only if desired. 162 | if [ 0 -eq "$watchquagga_enable" ]; then 163 | return 164 | fi 165 | 166 | # Check variable type 167 | if ! declare -p watchquagga_options | grep -q '^declare \-a'; then 168 | echo 169 | echo "ERROR: The variable watchquagga_options from /etc/quagga/debian.cnf must be a BASH array!" 170 | echo "ERROR: Please convert config file and restart!" 171 | exit 1 172 | fi 173 | 174 | # Which daemons have been started? 175 | found_one=0 176 | for daemon_name in $DAEMONS; do 177 | eval daemon_prio=\$$daemon_name 178 | if [ "$daemon_prio" -gt 0 ]; then 179 | watchquagga_options+=($daemon_name) 180 | found_one=1 181 | fi 182 | done 183 | 184 | # Start if at least one daemon is activated. 185 | if [ $found_one -eq 1 ]; then 186 | echo -n "Starting Quagga monitor daemon:" 187 | start watchquagga 188 | echo "." 189 | fi 190 | } 191 | 192 | # Stopps watchquagga. 193 | stop_watchquagga() 194 | { 195 | echo -n "Stopping Quagga monitor daemon:" 196 | stop watchquagga 197 | echo "." 198 | } 199 | 200 | # Stops all daemons that have a lower level of priority than the given. 201 | # (technically if daemon_prio >= wanted_prio) 202 | stop_prio() 203 | { 204 | local wanted_prio 205 | local daemon_prio 206 | local daemon_list 207 | 208 | wanted_prio=$1 209 | daemon_list=${2:-$DAEMONS} 210 | 211 | echo -n "Stopping Quagga daemons (prio:$wanted_prio):" 212 | 213 | for prio_i in `seq 10 -1 $wanted_prio`; do 214 | for daemon_name in $daemon_list; do 215 | eval daemon_prio=\$$daemon_name 216 | if [ $daemon_prio -eq $prio_i ]; then 217 | stop "$daemon_name" 218 | fi 219 | done 220 | done 221 | echo "." 222 | } 223 | 224 | # Starts all daemons that have a higher level of priority than the given. 225 | # (technically if daemon_prio <= wanted_prio) 226 | start_prio() 227 | { 228 | local wanted_prio 229 | local daemon_prio 230 | local daemon_list 231 | 232 | wanted_prio=$1 233 | daemon_list=${2:-$DAEMONS} 234 | 235 | echo -n "Starting Quagga daemons (prio:$wanted_prio):" 236 | 237 | for prio_i in `seq 1 $wanted_prio`; do 238 | for daemon_name in $daemon_list; do 239 | eval daemon_prio=\$$daemon_name 240 | if [ $daemon_prio -eq $prio_i ]; then 241 | start "$daemon_name" 242 | fi 243 | done 244 | done 245 | echo "." 246 | } 247 | 248 | ######################################################### 249 | # Main program # 250 | ######################################################### 251 | 252 | # Config broken but script must exit silently. 253 | [ ! -r "$C_PATH/daemons" ] && exit 0 254 | 255 | # Load configuration 256 | . "$C_PATH/daemons" 257 | . "$C_PATH/debian.conf" 258 | 259 | # Set priority of un-startable daemons to 'no' and substitute 'yes' to '0' 260 | convert_daemon_prios 261 | 262 | if [ ! -d /var/run/quagga ]; then 263 | mkdir -p /var/run/quagga 264 | chown quagga:quagga /var/run/quagga 265 | chmod 755 /var/run/quagga 266 | fi 267 | 268 | case "$1" in 269 | start) 270 | # Try to load this necessary (at least for 2.6) module. 271 | if [ -d /lib/modules/`uname -r` ] ; then 272 | echo "Loading capability module if not yet done." 273 | set +e; LC_ALL=C modprobe -a capability 2>&1 | egrep -v "(not found|Can't locate)"; set -e 274 | fi 275 | 276 | # Start all daemons 277 | cd $C_PATH/ 278 | if [ "$2" != "watchquagga" ]; then 279 | start_prio 10 $2 280 | fi 281 | vtysh_b 282 | start_watchquagga 283 | ;; 284 | 285 | 1|2|3|4|5|6|7|8|9|10) 286 | # Stop/start daemons for the appropriate priority level 287 | stop_prio $1 288 | start_prio $1 289 | vtysh_b 290 | ;; 291 | 292 | stop|0) 293 | # Stop all daemons at level '0' or 'stop' 294 | stop_watchquagga 295 | if [ "$2" != "watchquagga" ]; then 296 | stop_prio 0 $2 297 | fi 298 | 299 | if [ -z "$2" -o "$2" = "zebra" ]; then 300 | echo "Removing all routes made by zebra." 301 | ip route flush proto zebra 302 | fi 303 | ;; 304 | 305 | restart|force-reload) 306 | $0 stop $2 307 | sleep 1 308 | $0 start $2 309 | ;; 310 | 311 | status) 312 | rc=3 313 | for i in /var/run/quagga/*.pid; do 314 | if [ -f "$i" ]; then 315 | d=`basename $i .pid` 316 | running="$running $d" 317 | rc=0 318 | fi 319 | done 320 | echo $running 321 | exit $rc 322 | ;; 323 | 324 | *) 325 | echo "Usage: /etc/init.d/quagga {start|stop|restart|force-reload|} [daemon]" 326 | echo " E.g. '/etc/init.d/quagga 5' would start all daemons with a prio 1-5." 327 | echo " Read /usr/share/doc/quagga/README.Debian for details." 328 | exit 1 329 | ;; 330 | esac 331 | 332 | exit 0 333 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------