# -*- coding: utf-8 -*-
from __future__ import absolute_import, print_function, unicode_literals
import copy
import logging
import six
from lazy import lazy
from ..commands import EzjailAdmin
from ..exceptions import (AttachNonJailError, DuplicateJailHostnameError, DuplicateJailNameError, DuplicateJailUidError,
JailAlreadyAttachedError)
from ..handlers import BaseJailHandler
from .base import System
from .jails import Jail
__logger__ = logging.getLogger('pybsd')
[docs]class Master(System):
"""Describes a system that can host jails
Parameters
----------
name : :py:class:`str`
a name that identifies the system.
ext_if : :py:class:`tuple` (:py:class:`str`, :py:class:`list` [:py:class:`str`])
Definition of the system's outward-facing interface
int_if : Optional[ :py:class:`tuple` (:py:class:`str`, :py:class:`list` [:py:class:`str`]) ]
Definition of the system's internal network-facing interface. If it is not specified it defaults to ext_if,
as in that case the same interface will be used for all networks.
lo_if : Optional[ :py:class:`tuple` (:py:class:`str`, :py:class:`list` [:py:class:`str`]) ]
Definition of the system's loopback interface. It defaults to ('lo0', ['127.0.0.1/8', '::1/110'])
j_if : Optional[ :py:class:`tuple` (:py:class:`str`, :py:class:`list` [:py:class:`str`]) ]
Definition of the interface the system provides to hosted jails as their external interface. By default, this will be
the system's own ext_if.
jlo_if : Optional[ :py:class:`tuple` (:py:class:`str`, :py:class:`list` [:py:class:`str`]) ]
Definition of the interface the system provides to hosted jails as their loopback interface. By default, this will be
the system's own lo_if.
hostname : Optional[:py:class:`int`]
The system's hostname.
Attributes
----------
JailHandlerClass : :py:class:`class`
the class of the system's jail handler. It must be or extend :py:class:`~pybsd.BaseJailHandler`
"""
JailHandlerClass = BaseJailHandler
default_jail_type = 'Z'
def __init__(self, name, ext_if, int_if=None, lo_if=None, j_if=None, jlo_if=None, hostname=None):
super(Master, self).__init__(name, ext_if, int_if, lo_if, hostname)
self._j_if = self.make_if(j_if)
self._jlo_if = self.make_if(jlo_if)
self.ezjail_admin = EzjailAdmin(env=self)
self.jail_handler = self.JailHandlerClass(master=self)
self.jails = {}
@property
def j_if(self):
""":py:class:`~pybsd.network.Interface`: the interface the system provides to hosted jails as their external interface. By default,
this will be the system's own ext_if.
"""
return self._j_if or self.ext_if
[docs] def reset_j_if(self):
"""Resets the system's j_if to its default value (its own ext_if)"""
self._j_if = None
@property
def jlo_if(self):
""":py:class:`~pybsd.network.Interface`: the interface the system provides to hosted jails as their loopback interface.
By default, this will be the system's own lo_if.
"""
return self._jlo_if or self.lo_if
[docs] def reset_jlo_if(self):
"""Resets the system's jlo_if to its default value (its own lo_if)"""
self._jlo_if = None
@property
def names(self):
""":py:class:`set`: returns a set containing the names attached to a :py:class:`~pybsd.systems.masters.Master`.
These will be its own name and that of jails attached to it.
"""
names = {j.name for k, j in six.iteritems(self.jails)}
names.add(self.name)
return names
@property
def hostnames(self):
""":py:class:`set`: returns a set containing the hostnames attached to a :py:class:`~pybsd.systems.masters.Master`.
These will be its own hostname and that of jails attached to it.
"""
hostnames = {j.hostname for k, j in six.iteritems(self.jails)}
hostnames.add(self.hostname)
return hostnames
@property
def uids(self):
""":py:class:`set`: returns a set containing the uids attached to a :py:class:`~pybsd.systems.masters.Master`.
These will be the uids of jails attached to it.
"""
return {j.uid for k, j in six.iteritems(self.jails)}
[docs] def attach_jail(self, jail):
"""Adds a jail to the system's jails list.
Re-attaching an already-owned jail is transparent.
Parameters
----------
jail : :py:class:`~pybsd.systems.jails.Jail`
The jail to be added
Returns
-------
: :py:class:`~pybsd.systems.jails.Jail`
the jail that was added. This allows chaining of commands.
Raises
------
: :py:exc:`~pybsd.exceptions.AttachNonJailError`
if `jail` is not an instance of :py:class:`~pybsd.systems.jails.Jail`
: :py:exc:`~pybsd.exceptions.JailAlreadyAttachedError`
if `jail` is already attached to another :py:class:`~pybsd.systems.masters.Master`
: :py:exc:`~pybsd.exceptions.DuplicateJailNameError`
if another :py:class:`~pybsd.systems.jails.Jail` with the same name is already attached to `master`
: :py:exc:`~pybsd.exceptions.DuplicateJailHostnameError`
if another :py:class:`~pybsd.systems.jails.Jail` with the same hostname is already attached to `master`
: :py:exc:`~pybsd.exceptions.DuplicateJailUidError`
if another :py:class:`~pybsd.systems.jails.Jail` with the same uid is already attached to `master`
"""
if not isinstance(jail, Jail):
raise AttachNonJailError(self, jail)
elif jail.is_attached:
if jail.master == self:
return jail
raise JailAlreadyAttachedError(self, jail)
elif jail.name in self.jails:
raise DuplicateJailNameError(self, jail, jail.name)
hostname = jail.base_hostname or self.jail_handler.get_jail_hostname(jail, strict=False)
if hostname in self.hostnames:
raise DuplicateJailHostnameError(self, jail, hostname)
elif jail.uid in self.uids:
raise DuplicateJailUidError(self, jail, jail.uid)
else:
self.jails[jail.name] = jail
jail.master = self
return jail
[docs] def clone_jail(self, jail, name, uid, hostname=None):
"""Creates and returns the clone of a :py:class:`~pybsd.systems.jails.Jail`, using provided parameters
as the new value of unique properties.
Parameters
----------
jail : :py:class:`~pybsd.systems.jails.Jail`
The jail to be cloned
name : :py:class:`str`
a name that identifies the system.
uid : :py:class:`int`
The jail's id.
hostname : Optional[:py:class:`str`]
The jail's hostname.
Returns
-------
: :py:class:`~pybsd.systems.jails.Jail`
The cloned jail
Raises
------
:
see exceptions raised by :py:meth:`~pybsd.systems.masters.Master.attach_jail`
"""
if not isinstance(jail, Jail):
raise AttachNonJailError(self, jail)
_jail = copy.deepcopy(jail)
_jail.name = name
_jail.hostname = hostname
_jail.uid = uid
_jail.master = None
return self.attach_jail(_jail)
@lazy
[docs] def ezjail_admin_binary(self):
"""Returns the path of this environment's ezjail-admin binary.
Returns
-------
: :py:class:`str`
"""
return u'/usr/local/bin/ezjail-admin'