format.py 45.5 KB
Newer Older
Łukasz Nowak's avatar
Łukasz Nowak committed
1
# -*- coding: utf-8 -*-
Marco Mariani's avatar
Marco Mariani committed
2
# vim: set et sts=2:
Łukasz Nowak's avatar
Łukasz Nowak committed
3 4
##############################################################################
#
5 6
# Copyright (c) 2010, 2011, 2012 Vifib SARL and Contributors.
# All Rights Reserved.
Łukasz Nowak's avatar
Łukasz Nowak committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly advised to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################
30

Marco Mariani's avatar
Marco Mariani committed
31
import argparse
Łukasz Nowak's avatar
Łukasz Nowak committed
32
import ConfigParser
33 34
import errno
import fcntl
Łukasz Nowak's avatar
Łukasz Nowak committed
35
import grp
36
import json
Łukasz Nowak's avatar
Łukasz Nowak committed
37 38 39 40
import logging
import netaddr
import netifaces
import os
Łukasz Nowak's avatar
Łukasz Nowak committed
41
import pwd
Łukasz Nowak's avatar
Łukasz Nowak committed
42 43
import random
import socket
44
import struct
Łukasz Nowak's avatar
Łukasz Nowak committed
45 46
import subprocess
import sys
47
import threading
Łukasz Nowak's avatar
Łukasz Nowak committed
48
import time
Marco Mariani's avatar
Marco Mariani committed
49 50 51
import zipfile

import lxml.etree
Marco Mariani's avatar
Marco Mariani committed
52
import xml_marshaller.xml_marshaller
Marco Mariani's avatar
Marco Mariani committed
53

Marco Mariani's avatar
Marco Mariani committed
54 55
from slapos.util import mkdir_p
import slapos.slap as slap
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
56 57


Marco Mariani's avatar
Marco Mariani committed
58 59 60 61
def prettify_xml(xml):
  root = lxml.etree.fromstring(xml)
  return lxml.etree.tostring(root, pretty_print=True)

Łukasz Nowak's avatar
Łukasz Nowak committed
62

Vincent Pelletier's avatar
Vincent Pelletier committed
63
class OS(object):
64 65
  """Wrap parts of the 'os' module to provide logging of performed actions."""

Vincent Pelletier's avatar
Vincent Pelletier committed
66 67 68
  _os = os

  def __init__(self, config):
69
    self._dry_run = config.dry_run
Vincent Pelletier's avatar
Vincent Pelletier committed
70 71 72 73 74 75 76 77 78
    self._logger = config.logger
    add = self._addWrapper
    add('chown')
    add('chmod')
    add('makedirs')
    add('mkdir')

  def _addWrapper(self, name):
    def wrapper(*args, **kw):
Marco Mariani's avatar
Marco Mariani committed
79 80 81 82
      arg_list = [repr(x) for x in args] + [
              '%s=%r' % (x, y) for x, y in kw.iteritems()
              ]
      self._logger.debug('%s(%s)' % (name, ', '.join(arg_list)))
83 84
      if not self._dry_run:
        getattr(self._os, name)(*args, **kw)
Vincent Pelletier's avatar
Vincent Pelletier committed
85 86 87 88
    setattr(self, name, wrapper)

  def __getattr__(self, name):
    return getattr(self._os, name)
Łukasz Nowak's avatar
Łukasz Nowak committed
89

90

91 92 93
class UsageError(Exception):
  pass

94

95
class NoAddressOnInterface(Exception):
Łukasz Nowak's avatar
Łukasz Nowak committed
96
  """
Marco Mariani's avatar
Marco Mariani committed
97
  Exception raised if there is no address on the interface to construct IPv6
98 99 100
  address with.

  Attributes:
101
    brige: String, the name of the interface.
Łukasz Nowak's avatar
Łukasz Nowak committed
102 103
  """

104 105
  def __init__(self, interface):
    super(NoAddressOnInterface, self).__init__(
Marco Mariani's avatar
Marco Mariani committed
106
      'No IPv6 found on interface %s to construct IPv6 with.' % interface
107
    )
Łukasz Nowak's avatar
Łukasz Nowak committed
108

109

110 111 112
class AddressGenerationError(Exception):
  """
  Exception raised if the generation of an IPv6 based on the prefix obtained
113
  from the interface failed.
114 115 116 117 118 119 120 121

  Attributes:
    addr: String, the invalid address the exception is raised for.
  """
  def __init__(self, addr):
    super(AddressGenerationError, self).__init__(
      'Generated IPv6 %s seems not to be a valid IP.' % addr
    )
Łukasz Nowak's avatar
Łukasz Nowak committed
122

123

Łukasz Nowak's avatar
Łukasz Nowak committed
124
def callAndRead(argument_list, raise_on_error=True):
Marco Mariani's avatar
Marco Mariani committed
125 126 127
  popen = subprocess.Popen(argument_list,
                           stdout=subprocess.PIPE,
                           stderr=subprocess.STDOUT)
Łukasz Nowak's avatar
Łukasz Nowak committed
128 129
  result = popen.communicate()[0]
  if raise_on_error and popen.returncode != 0:
130
    raise ValueError('Issue while invoking %r, result was:\n%s' % (
Marco Mariani's avatar
Marco Mariani committed
131
                     argument_list, result))
Łukasz Nowak's avatar
Łukasz Nowak committed
132 133
  return popen.returncode, result

134

Łukasz Nowak's avatar
Łukasz Nowak committed
135 136 137 138 139 140
def isGlobalScopeAddress(a):
  """Returns True if a is global scope IP v4/6 address"""
  ip = netaddr.IPAddress(a)
  return not ip.is_link_local() and not ip.is_loopback() and \
      not ip.is_reserved() and ip.is_unicast()

141

Łukasz Nowak's avatar
Łukasz Nowak committed
142 143 144 145 146
def netmaskToPrefixIPv4(netmask):
  """Convert string represented netmask to its integer prefix"""
  return netaddr.strategy.ipv4.netmask_to_prefix[
          netaddr.strategy.ipv4.str_to_int(netmask)]

147

Łukasz Nowak's avatar
Łukasz Nowak committed
148 149 150 151 152
def netmaskToPrefixIPv6(netmask):
  """Convert string represented netmask to its integer prefix"""
  return netaddr.strategy.ipv6.netmask_to_prefix[
          netaddr.strategy.ipv6.str_to_int(netmask)]

153

Łukasz Nowak's avatar
Łukasz Nowak committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
def _getDict(instance):
  """
  Serialize an object instance into dictionaries. List and dict will remains
  the same, basic type too. But encapsulated object will be returned as dict.
  Set, collections and other aren't handle for now.

  Args:
    instance: an object of any type.

  Returns:
    A dictionary if the given object wasn't a list, a list otherwise.
  """
  if isinstance(instance, list):
    return [_getDict(item) for item in instance]

  elif isinstance(instance, dict):
    result = {}
171
    for key in instance:
Łukasz Nowak's avatar
Łukasz Nowak committed
172 173 174 175 176
      result[key] = _getDict(instance[key])
    return result

  else:
    try:
177
      dikt = instance.__dict__
Łukasz Nowak's avatar
Łukasz Nowak committed
178 179
    except AttributeError:
      return instance
180 181 182 183
    result = {}
    for key, value in dikt.iteritems():
      result[key] = _getDict(value)
    return result
Łukasz Nowak's avatar
Łukasz Nowak committed
184

185

Vincent Pelletier's avatar
Vincent Pelletier committed
186
class Computer(object):
Łukasz Nowak's avatar
Łukasz Nowak committed
187
  "Object representing the computer"
188 189
  instance_root = None
  software_root = None
Łukasz Nowak's avatar
Łukasz Nowak committed
190

191
  def __init__(self, reference, interface=None, addr=None, netmask=None,
Marco Mariani's avatar
Marco Mariani committed
192
               ipv6_interface=None, software_user='slapsoft'):
Łukasz Nowak's avatar
Łukasz Nowak committed
193 194 195
    """
    Attributes:
      reference: String, the reference of the computer.
196
      interface: String, the name of the computer's used interface.
Łukasz Nowak's avatar
Łukasz Nowak committed
197 198
    """
    self.reference = str(reference)
199
    self.interface = interface
Łukasz Nowak's avatar
Łukasz Nowak committed
200 201 202
    self.partition_list = []
    self.address = addr
    self.netmask = netmask
Łukasz Nowak's avatar
Łukasz Nowak committed
203
    self.ipv6_interface = ipv6_interface
204
    self.software_user = software_user
Łukasz Nowak's avatar
Łukasz Nowak committed
205 206

  def __getinitargs__(self):
207
    return (self.reference, self.interface)
Łukasz Nowak's avatar
Łukasz Nowak committed
208

209
  def getAddress(self, allow_tap=False):
Łukasz Nowak's avatar
Łukasz Nowak committed
210
    """
Marco Mariani's avatar
Marco Mariani committed
211
    Return a list of the interface address not attributed to any partition (which
Łukasz Nowak's avatar
Łukasz Nowak committed
212 213 214
    are therefore free for the computer itself).

    Returns:
215
      False if the interface isn't available, else the list of the free addresses.
Łukasz Nowak's avatar
Łukasz Nowak committed
216
    """
217
    if self.interface is None:
Marco Mariani's avatar
Marco Mariani committed
218
      return {'addr': self.address, 'netmask': self.netmask}
Łukasz Nowak's avatar
Łukasz Nowak committed
219 220 221 222 223 224

    computer_partition_address_list = []
    for partition in self.partition_list:
      for address in partition.address_list:
        if netaddr.valid_ipv6(address['addr']):
          computer_partition_address_list.append(address['addr'])
225
    # Going through addresses of the computer's interface
226
    for address_dict in self.interface.getGlobalScopeAddressList():
Łukasz Nowak's avatar
Łukasz Nowak committed
227 228 229 230
      # Comparing with computer's partition addresses
      if address_dict['addr'] not in computer_partition_address_list:
        return address_dict

231
    if allow_tap:
Marco Mariani's avatar
Marco Mariani committed
232
      # all addresses on interface are for partition, so let's add new one
233 234 235 236 237 238
      computer_tap = Tap('compdummy')
      computer_tap.createWithOwner(User('root'), attach_to_tap=True)
      self.interface.addTap(computer_tap)
      return self.interface.addAddr()

    # Can't find address
Marco Mariani's avatar
Marco Mariani committed
239
    raise NoAddressOnInterface('No valid IPv6 found on %s.' % self.interface.name)
Łukasz Nowak's avatar
Łukasz Nowak committed
240 241 242 243 244 245 246 247 248

  def send(self, config):
    """
    Send a marshalled dictionary of the computer object serialized via_getDict.
    """

    slap_instance = slap.slap()
    connection_dict = {}
    if config.key_file and config.cert_file:
Marco Mariani's avatar
Marco Mariani committed
249 250
      connection_dict['key_file'] = config.key_file
      connection_dict['cert_file'] = config.cert_file
Łukasz Nowak's avatar
Łukasz Nowak committed
251
    slap_instance.initializeConnection(config.master_url,
Marco Mariani's avatar
Marco Mariani committed
252
                                       **connection_dict)
Łukasz Nowak's avatar
Łukasz Nowak committed
253
    slap_computer = slap_instance.registerComputer(self.reference)
Marco Mariani's avatar
Marco Mariani committed
254

255 256
    if config.dry_run:
      return
257
    try:
Marco Mariani's avatar
Marco Mariani committed
258
      slap_computer.updateConfiguration(xml_marshaller.xml_marshaller.dumps(_getDict(self)))
259 260 261 262
    except slap.NotFoundError as error:
      raise slap.NotFoundError("%s\nERROR : This SlapOS node is not recognised by "
          "SlapOS Master. Please make sure computer_id of slapos.cfg looks "
          "like 'COMP-123' and is correct.\nError is : 404 Not Found." % error)
Łukasz Nowak's avatar
Łukasz Nowak committed
263

264
  def dump(self, path_to_xml, path_to_json):
Łukasz Nowak's avatar
Łukasz Nowak committed
265 266 267 268 269
    """
    Dump the computer object to an xml file via xml_marshaller.

    Args:
      path_to_xml: String, path to the file to load.
Marco Mariani's avatar
Marco Mariani committed
270
      path_to_json: String, path to the JSON version to save.
Łukasz Nowak's avatar
Łukasz Nowak committed
271 272 273
    """

    computer_dict = _getDict(self)
274 275 276 277 278

    if path_to_json:
      with open(path_to_json, 'wb') as fout:
        fout.write(json.dumps(computer_dict, sort_keys=True, indent=2))

Marco Mariani's avatar
Marco Mariani committed
279
    new_xml = xml_marshaller.xml_marshaller.dumps(computer_dict)
Marco Mariani's avatar
Marco Mariani committed
280 281 282 283 284 285 286 287 288 289 290
    new_pretty_xml = prettify_xml(new_xml)

    path_to_archive = path_to_xml + '.zip'

    if os.path.exists(path_to_archive):
      # the archive file exists, we only backup if something has changed
      with open(path_to_xml, 'rb') as fin:
        if fin.read() == new_pretty_xml:
          # computer configuration did not change, nothing to write
          return

291 292
    if os.path.exists(path_to_xml):
      self.backup_xml(path_to_archive, path_to_xml)
Marco Mariani's avatar
Marco Mariani committed
293

Marco Mariani's avatar
Marco Mariani committed
294 295
    with open(path_to_xml, 'wb') as fout:
      fout.write(new_pretty_xml)
Marco Mariani's avatar
Marco Mariani committed
296 297 298


  def backup_xml(self, path_to_archive, path_to_xml):
Marco Mariani's avatar
Marco Mariani committed
299 300 301
    """
    Stores a copy of the current xml file to an historical archive.
    """
Marco Mariani's avatar
Marco Mariani committed
302
    xml_content = open(path_to_xml).read()
Marco Mariani's avatar
typo  
Marco Mariani committed
303
    saved_filename = os.path.basename(path_to_xml) + time.strftime('.%Y%m%d-%H:%M')
Marco Mariani's avatar
Marco Mariani committed
304 305 306 307

    with zipfile.ZipFile(path_to_archive, 'a') as archive:
      archive.writestr(saved_filename, xml_content, zipfile.ZIP_DEFLATED)

Łukasz Nowak's avatar
Łukasz Nowak committed
308 309

  @classmethod
Łukasz Nowak's avatar
Łukasz Nowak committed
310
  def load(cls, path_to_xml, reference, ipv6_interface):
Łukasz Nowak's avatar
Łukasz Nowak committed
311 312 313 314 315 316 317 318
    """
    Create a computer object from a valid xml file.

    Arg:
      path_to_xml: String, a path to a valid file containing
          a valid configuration.

    Return:
319
      A Computer object.
Łukasz Nowak's avatar
Łukasz Nowak committed
320 321
    """

Marco Mariani's avatar
Marco Mariani committed
322
    dumped_dict = xml_marshaller.xml_marshaller.loads(open(path_to_xml).read())
Łukasz Nowak's avatar
Łukasz Nowak committed
323 324 325 326 327 328

    # Reconstructing the computer object from the xml
    computer = Computer(
        reference = reference,
        addr = dumped_dict['address'],
        netmask = dumped_dict['netmask'],
Marco Mariani's avatar
Marco Mariani committed
329 330
        ipv6_interface = ipv6_interface,
        software_user = dumped_dict.get('software_user', 'slapsoft'),
Łukasz Nowak's avatar
Łukasz Nowak committed
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
    )

    for partition_dict in dumped_dict['partition_list']:

      if partition_dict['user']:
        user = User(partition_dict['user']['name'])
      else:
        user = User('root')

      if partition_dict['tap']:
        tap = Tap(partition_dict['tap']['name'])
      else:
        tap = Tap(partition_dict['reference'])

      address_list = partition_dict['address_list']

      partition = Partition(
          reference = partition_dict['reference'],
          path = partition_dict['path'],
          user = user,
          address_list = address_list,
          tap = tap,
      )

      computer.partition_list.append(partition)

    return computer

359
  def construct(self, alter_user=True, alter_network=True, create_tap=True):
Łukasz Nowak's avatar
Łukasz Nowak committed
360 361 362 363
    """
    Construct the computer object as it is.
    """
    if alter_network and self.address is not None:
364
      self.interface.addAddr(self.address, self.netmask)
Łukasz Nowak's avatar
Łukasz Nowak committed
365

366
    for path in self.instance_root, self.software_root:
Łukasz Nowak's avatar
Łukasz Nowak committed
367 368 369 370 371
      if not os.path.exists(path):
        os.makedirs(path, 0755)
      else:
        os.chmod(path, 0755)

372 373
    # own self.software_root by software user
    slapsoft = User(self.software_user)
Łukasz Nowak's avatar
Łukasz Nowak committed
374 375 376
    slapsoft.path = self.software_root
    if alter_user:
      slapsoft.create()
Łukasz Nowak's avatar
Łukasz Nowak committed
377
      slapsoft_pw = pwd.getpwnam(slapsoft.name)
Łukasz Nowak's avatar
Łukasz Nowak committed
378 379 380
      os.chown(self.software_root, slapsoft_pw.pw_uid, slapsoft_pw.pw_gid)
    os.chmod(self.software_root, 0755)

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
    # Speed hack:
    # Blindly add all IPs from existing configuration, just to speed up actual
    # computer configuration later on.
    for partition in self.partition_list:
      try:
        for address in partition.address_list:
          try:
            netmask = netmaskToPrefixIPv6(address['netmask'])
          except:
            continue
          callAndRead(['ip', 'addr', 'add',
                       '%s/%s' % (address['addr'], netmask),
                       'dev', self.interface.name])
      except ValueError:
        pass

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
    try:
      for partition_index, partition in enumerate(self.partition_list):
        # Reconstructing User's
        partition.path = os.path.join(self.instance_root, partition.reference)
        partition.user.setPath(partition.path)
        partition.user.additional_group_list = [slapsoft.name]
        if alter_user:
          partition.user.create()

        # Reconstructing Tap
        if partition.user and partition.user.isAvailable():
          owner = partition.user
        else:
          owner = User('root')

412
        if alter_network and create_tap:
413
          # In case it has to be  attached to the TAP network device, only one
414 415
          # is necessary for the interface to assert carrier
          if self.interface.attach_to_tap and partition_index == 0:
416
            partition.tap.createWithOwner(owner, attach_to_tap=True)
Łukasz Nowak's avatar
Łukasz Nowak committed
417
          else:
418 419
            partition.tap.createWithOwner(owner)

420
          self.interface.addTap(partition.tap)
421 422 423 424 425 426 427 428 429 430

        # Reconstructing partition's directory
        partition.createPath(alter_user)

        # Reconstructing partition's address
        # There should be two addresses on each Computer Partition:
        #  * global IPv6
        #  * local IPv4, took from slapformat:ipv4_local_network
        if len(partition.address_list) == 0:
          # regenerate
431 432
          partition.address_list.append(self.interface.addIPv4LocalAddress())
          partition.address_list.append(self.interface.addAddr())
433 434 435 436 437
        elif alter_network:
          # regenerate list of addresses
          old_partition_address_list = partition.address_list
          partition.address_list = []
          if len(old_partition_address_list) != 2:
438 439 440
            raise ValueError(
              'There should be exactly 2 stored addresses. Got: %r' %
              (old_partition_address_list,))
Vincent Pelletier's avatar
Vincent Pelletier committed
441 442
          if not any([netaddr.valid_ipv6(q['addr'])
              for q in old_partition_address_list]):
443
            raise ValueError('Not valid ipv6 addresses loaded')
Vincent Pelletier's avatar
Vincent Pelletier committed
444 445
          if not any([netaddr.valid_ipv4(q['addr'])
              for q in old_partition_address_list]):
446
            raise ValueError('Not valid ipv6 addresses loaded')
Marco Mariani's avatar
Marco Mariani committed
447

448 449
          for address in old_partition_address_list:
            if netaddr.valid_ipv6(address['addr']):
450
              partition.address_list.append(self.interface.addAddr(
Vincent Pelletier's avatar
Vincent Pelletier committed
451 452
                address['addr'],
                address['netmask']))
453
            elif netaddr.valid_ipv4(address['addr']):
454
              partition.address_list.append(self.interface.addIPv4LocalAddress(
Vincent Pelletier's avatar
Vincent Pelletier committed
455
                address['addr']))
456 457 458
            else:
              raise ValueError('Address %r is incorrect' % address['addr'])
    finally:
459
      if alter_network and create_tap and self.interface.attach_to_tap:
460 461 462 463
        try:
          self.partition_list[0].tap.detach()
        except IndexError:
          pass
Łukasz Nowak's avatar
Łukasz Nowak committed
464

465

Vincent Pelletier's avatar
Vincent Pelletier committed
466
class Partition(object):
Łukasz Nowak's avatar
Łukasz Nowak committed
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
  "Represent a computer partition"

  def __init__(self, reference, path, user, address_list, tap):
    """
    Attributes:
      reference: String, the name of the partition.
      path: String, the path to the partition folder.
      user: User, the user linked to this partition.
      address_list: List of associated IP addresses.
      tap: Tap, the tap interface linked to this partition.
    """

    self.reference = str(reference)
    self.path = str(path)
    self.user = user
    self.address_list = address_list or []
    self.tap = tap

  def __getinitargs__(self):
    return (self.reference, self.path, self.user, self.address_list, self.tap)

  def createPath(self, alter_user=True):
    """
Vincent Pelletier's avatar
Vincent Pelletier committed
490 491
    Create the directory of the partition, assign to the partition user and
    give it the 750 permission. In case if path exists just modifies it.
Łukasz Nowak's avatar
Łukasz Nowak committed
492 493
    """

494
    self.path = os.path.abspath(self.path)
Łukasz Nowak's avatar
Łukasz Nowak committed
495
    owner = self.user if self.user else User('root')
496 497
    if not os.path.exists(self.path):
      os.mkdir(self.path, 0750)
Łukasz Nowak's avatar
Łukasz Nowak committed
498
    if alter_user:
Łukasz Nowak's avatar
Łukasz Nowak committed
499
      owner_pw = pwd.getpwnam(owner.name)
500 501
      os.chown(self.path, owner_pw.pw_uid, owner_pw.pw_gid)
    os.chmod(self.path, 0750)
Łukasz Nowak's avatar
Łukasz Nowak committed
502

503

Vincent Pelletier's avatar
Vincent Pelletier committed
504
class User(object):
Marco Mariani's avatar
Marco Mariani committed
505 506
  """User: represent and manipulate a user on the system."""

507
  path = None
Łukasz Nowak's avatar
Łukasz Nowak committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533

  def __init__(self, user_name, additional_group_list=None):
    """
    Attributes:
        user_name: string, the name of the user, who will have is home in
    """
    self.name = str(user_name)
    self.additional_group_list = additional_group_list

  def __getinitargs__(self):
    return (self.name,)

  def setPath(self, path):
    self.path = path

  def create(self):
    """
    Create a user on the system who will be named after the self.name with its
    own group and directory.

    Returns:
        True: if the user creation went right
    """
    # XXX: This method shall be no-op in case if all is correctly setup
    #      This method shall check if all is correctly done
    #      This method shall not reset groups, just add them
Jondy Zhao's avatar
Jondy Zhao committed
534
    grpname = 'grp_' + self.name if sys.platform == 'cygwin' else self.name
Łukasz Nowak's avatar
Łukasz Nowak committed
535
    try:
Jondy Zhao's avatar
Jondy Zhao committed
536
      grp.getgrnam(grpname)
Łukasz Nowak's avatar
Łukasz Nowak committed
537
    except KeyError:
Jondy Zhao's avatar
Jondy Zhao committed
538
      callAndRead(['groupadd', grpname])
Łukasz Nowak's avatar
Łukasz Nowak committed
539

Vincent Pelletier's avatar
Vincent Pelletier committed
540 541
    user_parameter_list = ['-d', self.path, '-g', self.name, '-s',
      '/bin/false']
Łukasz Nowak's avatar
Łukasz Nowak committed
542 543 544 545
    if self.additional_group_list is not None:
      user_parameter_list.extend(['-G', ','.join(self.additional_group_list)])
    user_parameter_list.append(self.name)
    try:
Łukasz Nowak's avatar
Łukasz Nowak committed
546
      pwd.getpwnam(self.name)
Łukasz Nowak's avatar
Łukasz Nowak committed
547
    except KeyError:
548
      user_parameter_list.append('-r')
Łukasz Nowak's avatar
Łukasz Nowak committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
      callAndRead(['useradd'] + user_parameter_list)
    else:
      callAndRead(['usermod'] + user_parameter_list)

    return True

  def isAvailable(self):
    """
    Determine the availability of a user on the system

    Return:
        True: if available
        False: otherwise
    """

    try:
Łukasz Nowak's avatar
Łukasz Nowak committed
565
      pwd.getpwnam(self.name)
Łukasz Nowak's avatar
Łukasz Nowak committed
566 567 568 569
      return True
    except KeyError:
      return False

570

Vincent Pelletier's avatar
Vincent Pelletier committed
571
class Tap(object):
Łukasz Nowak's avatar
Łukasz Nowak committed
572
  "Tap represent a tap interface on the system"
573 574 575
  IFF_TAP = 0x0002
  TUNSETIFF = 0x400454ca
  KEEP_TAP_ATTACHED_EVENT = threading.Event()
Łukasz Nowak's avatar
Łukasz Nowak committed
576 577 578 579 580 581 582 583 584 585 586 587

  def __init__(self, tap_name):
    """
    Attributes:
        tap_name: String, the name of the tap interface.
    """

    self.name = str(tap_name)

  def __getinitargs__(self):
    return (self.name,)

588 589 590
  def attach(self):
    """
    Attach to the TAP interface, meaning  that it just opens the TAP interface
Marco Mariani's avatar
Marco Mariani committed
591
    and waits for the caller to notify that it can be safely detached.
592 593 594 595 596 597 598 599

    Linux  distinguishes administrative  and operational  state of  an network
    interface.  The  former can be set  manually by running ``ip  link set dev
    <dev> up|down'', whereas the latter states that the interface can actually
    transmit  data (for  a wired  network interface,  it basically  means that
    there is  carrier, e.g.  the network  cable is plugged  into a  switch for
    example).

600
    In case of bridge:
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
    In order  to be able to check  the uniqueness of IPv6  address assigned to
    the bridge, the network interface  must be up from an administrative *and*
    operational point of view.

    However,  from  Linux  2.6.39,  the  bridge  reflects  the  state  of  the
    underlying device (e.g.  the bridge asserts carrier if at least one of its
    ports has carrier) whereas it  always asserted carrier before. This should
    work fine for "real" network interface,  but will not work properly if the
    bridge only binds TAP interfaces, which, from 2.6.36, reports carrier only
    and only if an userspace program is attached.
    """
    tap_fd = os.open("/dev/net/tun", os.O_RDWR)

    try:
      # Attach to the TAP interface which has previously been created
      fcntl.ioctl(tap_fd, self.TUNSETIFF,
                  struct.pack("16sI", self.name, self.IFF_TAP))

619
    except IOError as error:
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
      # If  EBUSY, it  means another  program is  already attached,  thus just
      # ignore it...
      if error.errno != errno.EBUSY:
        os.close(tap_fd)
        raise
    else:
      # Block until the  caller send an event stating that  the program can be
      # now detached safely,  thus bringing down the TAP  device (from 2.6.36)
      # and the bridge at the same time (from 2.6.39)
      self.KEEP_TAP_ATTACHED_EVENT.wait()
    finally:
      os.close(tap_fd)

  def detach(self):
    """
    Detach to the  TAP network interface by notifying  the thread which attach
    to the TAP and closing the TAP file descriptor
    """
    self.KEEP_TAP_ATTACHED_EVENT.set()

  def createWithOwner(self, owner, attach_to_tap=False):
Łukasz Nowak's avatar
Łukasz Nowak committed
641 642 643 644 645 646 647 648 649
    """
    Create a tap interface on the system.
    """

    # some systems does not have -p switch for tunctl
    #callAndRead(['tunctl', '-p', '-t', self.name, '-u', owner.name])
    check_file = '/sys/devices/virtual/net/%s/owner' % self.name
    owner_id = None
    if os.path.exists(check_file):
650
      owner_id = open(check_file).read().strip()
Łukasz Nowak's avatar
Łukasz Nowak committed
651
      try:
652 653
        owner_id = int(owner_id)
      except ValueError:
Łukasz Nowak's avatar
Łukasz Nowak committed
654
        pass
655
    if owner_id != pwd.getpwnam(owner.name).pw_uid:
Łukasz Nowak's avatar
Łukasz Nowak committed
656 657 658
      callAndRead(['tunctl', '-t', self.name, '-u', owner.name])
    callAndRead(['ip', 'link', 'set', self.name, 'up'])

659 660 661
    if attach_to_tap:
      threading.Thread(target=self.attach).start()

662

663
class Interface(object):
Marco Mariani's avatar
Marco Mariani committed
664
  """Represent a network interface on the system"""
Łukasz Nowak's avatar
Łukasz Nowak committed
665

Marco Mariani's avatar
Marco Mariani committed
666
  def __init__(self, name, ipv4_local_network, ipv6_interface=None, logger=None):
Łukasz Nowak's avatar
Łukasz Nowak committed
667 668
    """
    Attributes:
669
        name: String, the name of the interface
Łukasz Nowak's avatar
Łukasz Nowak committed
670 671
    """

Marco Mariani's avatar
Marco Mariani committed
672
    self.logger = logger
Łukasz Nowak's avatar
Łukasz Nowak committed
673 674
    self.name = str(name)
    self.ipv4_local_network = ipv4_local_network
Łukasz Nowak's avatar
Łukasz Nowak committed
675
    self.ipv6_interface = ipv6_interface
Łukasz Nowak's avatar
Łukasz Nowak committed
676

677
    # Attach to TAP  network interface, only if the  interface interface does not
678
    # report carrier
679
    _, result = callAndRead(['ip', 'addr', 'list', self.name])
680 681
    self.attach_to_tap = 'DOWN' in result.split('\n', 1)[0]

Łukasz Nowak's avatar
Łukasz Nowak committed
682 683 684 685
  def __getinitargs__(self):
    return (self.name,)

  def getIPv4LocalAddressList(self):
Vincent Pelletier's avatar
Vincent Pelletier committed
686 687 688 689
    """
    Returns currently configured local IPv4 addresses which are in
    ipv4_local_network
    """
Łukasz Nowak's avatar
Łukasz Nowak committed
690 691 692 693 694 695 696 697 698
    if not socket.AF_INET in netifaces.ifaddresses(self.name):
      return []
    return [dict(addr=q['addr'], netmask=q['netmask']) for q in
      netifaces.ifaddresses(self.name)[socket.AF_INET] if netaddr.IPAddress(
        q['addr'], 4) in netaddr.glob_to_iprange(
          netaddr.cidr_to_glob(self.ipv4_local_network))]

  def getGlobalScopeAddressList(self):
    """Returns currently configured global scope IPv6 addresses"""
Łukasz Nowak's avatar
Łukasz Nowak committed
699 700 701 702
    if self.ipv6_interface:
      interface_name = self.ipv6_interface
    else:
      interface_name = self.name
703
    try:
Vincent Pelletier's avatar
Vincent Pelletier committed
704 705 706
      address_list = [q
        for q in netifaces.ifaddresses(interface_name)[socket.AF_INET6]
        if isGlobalScopeAddress(q['addr'].split('%')[0])]
707 708
    except KeyError:
      raise ValueError("%s must have at least one IPv6 address assigned" % \
Łukasz Nowak's avatar
Łukasz Nowak committed
709
                         interface_name)
Jondy Zhao's avatar
Jondy Zhao committed
710 711 712
    if sys.platform == 'cygwin':
      for q in address_list:
        q.setdefault('netmask', 'FFFF:FFFF:FFFF:FFFF::')
Łukasz Nowak's avatar
Łukasz Nowak committed
713 714 715 716 717 718 719 720 721 722
    # XXX: Missing implementation of Unique Local IPv6 Unicast Addresses as
    # defined in http://www.rfc-editor.org/rfc/rfc4193.txt
    # XXX: XXX: XXX: IT IS DISALLOWED TO IMPLEMENT link-local addresses as
    # Linux and BSD are possibly wrongly implementing it -- it is "too local"
    # it is impossible to listen or access it on same node
    # XXX: IT IS DISALLOWED to implement ad hoc solution like inventing node
    # local addresses or anything which does not exists in RFC!
    return address_list

  def getInterfaceList(self):
723
    """Returns list of interfaces already present on bridge"""
Łukasz Nowak's avatar
Łukasz Nowak committed
724
    interface_list = []
725
    _, result = callAndRead(['brctl', 'show'])
726
    in_interface = False
Łukasz Nowak's avatar
Łukasz Nowak committed
727 728 729 730
    for line in result.split('\n'):
      if len(line.split()) > 1:
        if self.name in line:
          interface_list.append(line.split()[-1])
731
          in_interface = True
Łukasz Nowak's avatar
Łukasz Nowak committed
732
          continue
733
        if in_interface:
Łukasz Nowak's avatar
Łukasz Nowak committed
734
          break
735
      elif in_interface:
Łukasz Nowak's avatar
Łukasz Nowak committed
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
        if line.strip():
          interface_list.append(line.strip())

    return interface_list

  def addTap(self, tap):
    """
    Add the tap interface tap to the bridge.

    Args:
      tap: Tap, the tap interface.
    """
    if tap.name not in self.getInterfaceList():
      callAndRead(['brctl', 'addif', self.name, tap.name])

  def _addSystemAddress(self, address, netmask, ipv6=True):
752
    """Adds system address to interface
753

Łukasz Nowak's avatar
Łukasz Nowak committed
754 755 756 757 758 759 760
    Returns True if address was added successfully.

    Returns False if there was issue.
    """
    if ipv6:
      address_string = '%s/%s' % (address, netmaskToPrefixIPv6(netmask))
      af = socket.AF_INET6
Łukasz Nowak's avatar
Łukasz Nowak committed
761 762 763 764
      if self.ipv6_interface:
        interface_name = self.ipv6_interface
      else:
        interface_name = self.name
Łukasz Nowak's avatar
Łukasz Nowak committed
765 766 767
    else:
      af = socket.AF_INET
      address_string = '%s/%s' % (address, netmaskToPrefixIPv4(netmask))
Łukasz Nowak's avatar
Łukasz Nowak committed
768
      interface_name = self.name
Łukasz Nowak's avatar
Łukasz Nowak committed
769 770 771

    # check if address is already took by any other interface
    for interface in netifaces.interfaces():
Łukasz Nowak's avatar
Łukasz Nowak committed
772
      if interface != interface_name:
Łukasz Nowak's avatar
Łukasz Nowak committed
773 774
        address_dict = netifaces.ifaddresses(interface)
        if af in address_dict:
775
          if address in [q['addr'].split('%')[0] for q in address_dict[af]]:
Łukasz Nowak's avatar
Łukasz Nowak committed
776 777
            return False

Vincent Pelletier's avatar
Vincent Pelletier committed
778 779
    if not af in netifaces.ifaddresses(interface_name) \
        or not address in [q['addr'].split('%')[0]
Marco Mariani's avatar
Marco Mariani committed
780 781
                           for q in netifaces.ifaddresses(interface_name)[af]
                           ]:
Łukasz Nowak's avatar
Łukasz Nowak committed
782
      # add an address
Łukasz Nowak's avatar
Łukasz Nowak committed
783
      callAndRead(['ip', 'addr', 'add', address_string, 'dev', interface_name])
784 785 786 787 788

      # Fake success for local ipv4
      if not ipv6:
        return True

Łukasz Nowak's avatar
Łukasz Nowak committed
789 790
      # wait few moments
      time.sleep(2)
791 792 793 794 795 796

    # Fake success for local ipv4
    if not ipv6:
      return True

    # check existence on interface for ipv6
797
    _, result = callAndRead(['ip', '-6', 'addr', 'list', interface_name])
Łukasz Nowak's avatar
Łukasz Nowak committed
798 799 800 801
    for l in result.split('\n'):
      if address in l:
        if 'tentative' in l:
          # duplicate, remove
Marco Mariani's avatar
Marco Mariani committed
802
          callAndRead(['ip', 'addr', 'del', address_string, 'dev', interface_name])
Łukasz Nowak's avatar
Łukasz Nowak committed
803 804 805 806 807 808 809 810 811 812 813 814 815
          return False
        # found and clean
        return True
    # even when added not found, this is bad...
    return False

  def _generateRandomIPv4Address(self, netmask):
    # no addresses found, generate new one
    # Try 10 times to add address, raise in case if not possible
    try_num = 10
    while try_num > 0:
      addr = random.choice([q for q in netaddr.glob_to_iprange(
        netaddr.cidr_to_glob(self.ipv4_local_network))]).format()
Vincent Pelletier's avatar
Vincent Pelletier committed
816 817
      if dict(addr=addr, netmask=netmask) not in \
          self.getIPv4LocalAddressList():
Łukasz Nowak's avatar
Łukasz Nowak committed
818 819 820 821 822 823 824 825 826
        # Checking the validity of the IPv6 address
        if self._addSystemAddress(addr, netmask, False):
          return dict(addr=addr, netmask=netmask)
        try_num -= 1

    raise AddressGenerationError(addr)

  def addIPv4LocalAddress(self, addr=None):
    """Adds local IPv4 address in ipv4_local_network"""
Jondy Zhao's avatar
Jondy Zhao committed
827 828
    netmask = '255.255.255.254' if sys.platform == 'cygwin' \
             else '255.255.255.255'
Łukasz Nowak's avatar
Łukasz Nowak committed
829 830 831 832
    local_address_list = self.getIPv4LocalAddressList()
    if addr is None:
      return self._generateRandomIPv4Address(netmask)
    elif dict(addr=addr, netmask=netmask) not in local_address_list:
833 834 835
      if self._addSystemAddress(addr, netmask, False):
        return dict(addr=addr, netmask=netmask)
      else:
Marco Mariani's avatar
Marco Mariani committed
836
        self.logger.warning('Impossible to add old local IPv4 %s. Generating '
837
            'new IPv4 address.' % addr)
838
        return self._generateRandomIPv4Address(netmask)
Łukasz Nowak's avatar
Łukasz Nowak committed
839 840 841 842 843 844
    else:
      # confirmed to be configured
      return dict(addr=addr, netmask=netmask)

  def addAddr(self, addr = None, netmask = None):
    """
845
    Adds IP address to interface.
Łukasz Nowak's avatar
Łukasz Nowak committed
846

847
    If addr is specified and exists already on interface does nothing.
Łukasz Nowak's avatar
Łukasz Nowak committed
848

849
    If addr is specified and does not exists on interface, tries to add given
Vincent Pelletier's avatar
Vincent Pelletier committed
850 851
    address. If it is not possible (ex. because network changed) calculates new
    address.
Łukasz Nowak's avatar
Łukasz Nowak committed
852 853

    Args:
854
      addr: Wished address to be added to interface.
Łukasz Nowak's avatar
Łukasz Nowak committed
855 856 857 858 859 860 861
      netmask: Wished netmask to be used.

    Returns:
      Tuple of (address, netmask).

    Raises:
      AddressGenerationError: Couldn't construct valid address with existing
862 863
          one's on the interface.
      NoAddressOnInterface: There's no address on the interface to construct
Łukasz Nowak's avatar
Łukasz Nowak committed
864 865
          an address with.
    """
866
    # Getting one address of the interface as base of the next addresses
Łukasz Nowak's avatar
Łukasz Nowak committed
867 868 869 870
    if self.ipv6_interface:
      interface_name = self.ipv6_interface
    else:
      interface_name = self.name
871
    interface_addr_list = self.getGlobalScopeAddressList()
Łukasz Nowak's avatar
Łukasz Nowak committed
872 873

    # No address found
874 875 876
    if len(interface_addr_list) == 0:
      raise NoAddressOnInterface(interface_name)
    address_dict = interface_addr_list[0]
Łukasz Nowak's avatar
Łukasz Nowak committed
877 878

    if addr is not None:
879
      if dict(addr=addr, netmask=netmask) in interface_addr_list:
Łukasz Nowak's avatar
Łukasz Nowak committed
880 881 882 883
        # confirmed to be configured
        return dict(addr=addr, netmask=netmask)
      if netmask == address_dict['netmask']:
        # same netmask, so there is a chance to add good one
884
        interface_network = netaddr.ip.IPNetwork('%s/%s' % (address_dict['addr'],
Łukasz Nowak's avatar
Łukasz Nowak committed
885
          netmaskToPrefixIPv6(address_dict['netmask'])))
Vincent Pelletier's avatar
Vincent Pelletier committed
886 887
        requested_network = netaddr.ip.IPNetwork('%s/%s' % (addr,
          netmaskToPrefixIPv6(netmask)))
888
        if interface_network.network == requested_network.network:
Łukasz Nowak's avatar
Łukasz Nowak committed
889 890 891 892
          # same network, try to add
          if self._addSystemAddress(addr, netmask):
            # succeed, return it
            return dict(addr=addr, netmask=netmask)
893
          else:
Marco Mariani's avatar
Marco Mariani committed
894
            self.logger.warning('Impossible to add old public IPv6 %s. '
895
                'Generating new IPv6 address.' % addr)
Łukasz Nowak's avatar
Łukasz Nowak committed
896 897 898 899 900

    # Try 10 times to add address, raise in case if not possible
    try_num = 10
    netmask = address_dict['netmask']
    while try_num > 0:
Vincent Pelletier's avatar
Vincent Pelletier committed
901 902
      addr = ':'.join(address_dict['addr'].split(':')[:-1] + ['%x' % (
        random.randint(1, 65000), )])
Łukasz Nowak's avatar
Łukasz Nowak committed
903
      socket.inet_pton(socket.AF_INET6, addr)
Vincent Pelletier's avatar
Vincent Pelletier committed
904 905
      if dict(addr=addr, netmask=netmask) not in \
          self.getGlobalScopeAddressList():
Łukasz Nowak's avatar
Łukasz Nowak committed
906 907 908 909 910 911 912
        # Checking the validity of the IPv6 address
        if self._addSystemAddress(addr, netmask):
          return dict(addr=addr, netmask=netmask)
        try_num -= 1

    raise AddressGenerationError(addr)

913

Marco Mariani's avatar
Marco Mariani committed
914 915 916 917 918 919 920 921 922 923
def parse_computer_definition(config, definition_path):
  config.logger.info('Using definition file %r' % definition_path)
  computer_definition = ConfigParser.RawConfigParser({
    'software_user': 'slapsoft',
  })
  computer_definition.read(definition_path)
  interface = None
  address = None
  netmask = None
  if computer_definition.has_option('computer', 'address'):
Marco Mariani's avatar
Marco Mariani committed
924
    address, netmask = computer_definition.get('computer', 'address').split('/')
Marco Mariani's avatar
Marco Mariani committed
925 926 927
  if config.alter_network and config.interface_name is not None \
      and config.ipv4_local_network is not None:
    interface = Interface(config.interface_name, config.ipv4_local_network,
Marco Mariani's avatar
Marco Mariani committed
928
      config.ipv6_interface, logger=config.logger)
Marco Mariani's avatar
Marco Mariani committed
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
  computer = Computer(
      reference=config.computer_id,
      interface=interface,
      addr=address,
      netmask=netmask,
      ipv6_interface=config.ipv6_interface,
      software_user=computer_definition.get('computer', 'software_user'),
    )
  partition_list = []
  for partition_number in range(int(config.partition_amount)):
    section = 'partition_%s' % partition_number
    user = User(computer_definition.get(section, 'user'))
    address_list = []
    for a in computer_definition.get(section, 'address').split():
      address, netmask = a.split('/')
      address_list.append(dict(addr=address, netmask=netmask))
    tap = Tap(computer_definition.get(section, 'network_interface'))
Marco Mariani's avatar
Marco Mariani committed
946 947 948 949 950 951 952
    partition = Partition(reference=computer_definition.get(section, 'pathname'),
                          path=os.path.join(config.instance_root,
                                            computer_definition.get(section, 'pathname')),
                          user=user,
                          address_list=address_list,
                          tap=tap)
    partition_list.append(partition)
Marco Mariani's avatar
Marco Mariani committed
953 954 955 956 957 958 959 960 961 962 963 964
  computer.partition_list = partition_list
  return computer


def parse_computer_xml(config, xml_path):
  if os.path.exists(xml_path):
    config.logger.info('Loading previous computer data from %r' % xml_path)
    computer = Computer.load(xml_path,
                             reference=config.computer_id,
                             ipv6_interface=config.ipv6_interface)
    # Connect to the interface defined by the configuration
    computer.interface = Interface(config.interface_name, config.ipv4_local_network,
965
        config.ipv6_interface)
Marco Mariani's avatar
Marco Mariani committed
966 967
  else:
    # If no pre-existent configuration found, create a new computer object
Marco Mariani's avatar
Marco Mariani committed
968
    config.logger.warning('Creating new data computer with id %r' % config.computer_id)
969
    computer = Computer(
Marco Mariani's avatar
Marco Mariani committed
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
      reference=config.computer_id,
      interface=Interface(config.interface_name, config.ipv4_local_network,
        config.ipv6_interface),
      addr=None,
      netmask=None,
      ipv6_interface=config.ipv6_interface,
      software_user=config.software_user,
    )

  partition_amount = int(config.partition_amount)
  existing_partition_amount = len(computer.partition_list)
  if existing_partition_amount > partition_amount:
    raise ValueError('Requested amount of computer partitions (%s) is lower '
        'then already configured (%s), cannot continue' % (partition_amount,
          len(computer.partition_list)))

  config.logger.info('Adding %s new partitions' %
Marco Mariani's avatar
Marco Mariani committed
987
      (partition_amount - existing_partition_amount))
Marco Mariani's avatar
Marco Mariani committed
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
  for nb_iter in range(existing_partition_amount, partition_amount):
    # add new ones
    user = User("%s%s" % (config.user_base_name, nb_iter))

    tap = Tap("%s%s" % (config.tap_base_name, nb_iter))

    path = os.path.join(config.instance_root, "%s%s" % (
                         config.partition_base_name, nb_iter))
    computer.partition_list.append(
      Partition(
        reference="%s%s" % (config.partition_base_name, nb_iter),
        path=path,
        user=user,
        address_list=None,
        tap=tap,
        ))

  return computer


1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
def write_computer_definition(config, computer):
  computer_definition = ConfigParser.RawConfigParser()
  computer_definition.add_section('computer')
  if computer.address is not None and computer.netmask is not None:
    computer_definition.set('computer', 'address', '/'.join(
      [computer.address, computer.netmask]))
  for partition_number, partition in enumerate(computer.partition_list):
    section = 'partition_%s' % partition_number
    computer_definition.add_section(section)
    address_list = []
    for address in partition.address_list:
      address_list.append('/'.join([address['addr'], address['netmask']]))
    computer_definition.set(section, 'address', ' '.join(address_list))
    computer_definition.set(section, 'user', partition.user.name)
    computer_definition.set(section, 'network_interface', partition.tap.name)
    computer_definition.set(section, 'pathname', partition.reference)
  computer_definition.write(open(config.output_definition_file, 'w'))
  config.logger.info('Stored computer definition in %r' % config.output_definition_file)


Marco Mariani's avatar
Marco Mariani committed
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
def random_delay(config):
  # Add delay between 0 and 1 hour
  # XXX should be the contrary: now by default, and cron should have
  # --maximal-delay=3600
  if not config.now:
    duration = float(60 * 60) * random.random()
    print("Sleeping for %s seconds. To disable this feature, " \
                    "use with --now parameter in manual." % duration)
    time.sleep(duration)


def do_format(config):
  random_delay(config)

Marco Mariani's avatar
Marco Mariani committed
1042 1043
  if config.input_definition_file:
    computer = parse_computer_definition(config, config.input_definition_file)
1044 1045
  else:
    # no definition file, figure out computer
Marco Mariani's avatar
Marco Mariani committed
1046
    computer = parse_computer_xml(config, config.computer_xml)
1047 1048 1049 1050

  computer.instance_root = config.instance_root
  computer.software_root = config.software_root
  config.logger.info('Updating computer')
1051
  address = computer.getAddress(config.create_tap)
1052 1053 1054 1055
  computer.address = address['addr']
  computer.netmask = address['netmask']

  if config.output_definition_file:
1056
    write_computer_definition(config, computer)
Marco Mariani's avatar
Marco Mariani committed
1057

1058
  computer.construct(alter_user=config.alter_user,
Marco Mariani's avatar
Marco Mariani committed
1059 1060
                     alter_network=config.alter_network,
                     create_tap=config.create_tap)
1061

1062
  if getattr(config, 'certificate_repository_path', None):
1063 1064
    mkdir_p(config.certificate_repository_path, mode=0o700)

1065 1066
  # Dumping and sending to the erp5 the current configuration
  if not config.dry_run:
1067 1068
    computer.dump(path_to_xml=config.computer_xml,
                  path_to_json=config.computer_json)
1069 1070
  config.logger.info('Posting information to %r' % config.master_url)
  computer.send(config)
1071
  config.logger.info('slapformat successfully prepared computer.')
Łukasz Nowak's avatar
Łukasz Nowak committed
1072

1073

Marco Mariani's avatar
Marco Mariani committed
1074
class FormatConfig(object):
1075 1076 1077 1078
  key_file = None
  cert_file = None
  alter_network = None
  alter_user = None
1079
  create_tap = None
1080
  computer_xml = None
1081
  computer_json = None
Marco Mariani's avatar
Marco Mariani committed
1082
  input_definition_file = None
1083
  log_file = None
Marco Mariani's avatar
Marco Mariani committed
1084
  output_definition_file = None
1085
  dry_run = None
1086
  software_user = None
1087

Marco Mariani's avatar
Marco Mariani committed
1088 1089 1090
  def __init__(self, logger):
    self.logger = logger

1091 1092
  @staticmethod
  def checkRequiredBinary(binary_list):
Łukasz Nowak's avatar
Łukasz Nowak committed
1093 1094
    missing_binary_list = []
    for b in binary_list:
1095 1096
      if type(b) != type([]):
        b = [b]
Łukasz Nowak's avatar
Łukasz Nowak committed
1097
      try:
1098
        callAndRead(b)
Łukasz Nowak's avatar
Łukasz Nowak committed
1099 1100 1101
      except ValueError:
        pass
      except OSError:
Jondy Zhao's avatar
Jondy Zhao committed
1102
        missing_binary_list.append(b[0])
Łukasz Nowak's avatar
Łukasz Nowak committed
1103
    if missing_binary_list:
Vincent Pelletier's avatar
Vincent Pelletier committed
1104 1105
      raise UsageError('Some required binaries are missing or not '
          'functional: %s' % (','.join(missing_binary_list), ))
Łukasz Nowak's avatar
Łukasz Nowak committed
1106

Marco Mariani's avatar
Marco Mariani committed
1107
  def setConfig(self, options, configuration_parser):
Łukasz Nowak's avatar
Łukasz Nowak committed
1108 1109 1110 1111 1112
    """
    Set options given by parameters.
    """
    self.key_file = None
    self.cert_file = None
1113

Łukasz Nowak's avatar
Łukasz Nowak committed
1114
    # Set options parameters
Marco Mariani's avatar
Marco Mariani committed
1115
    for option, value in options.__dict__.items():
Łukasz Nowak's avatar
Łukasz Nowak committed
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
      setattr(self, option, value)

    # Merges the arguments and configuration
    for section in ("slapformat", "slapos"):
      configuration_dict = dict(configuration_parser.items(section))
      for key in configuration_dict:
        if not getattr(self, key, None):
          setattr(self, key, configuration_dict[key])

    # setup some nones
1126
    for parameter in ['interface_name', 'partition_base_name', 'user_base_name',
Łukasz Nowak's avatar
Łukasz Nowak committed
1127
        'tap_base_name', 'ipv4_local_network', 'ipv6_interface']:
Łukasz Nowak's avatar
Łukasz Nowak committed
1128 1129
      if getattr(self, parameter, None) is None:
        setattr(self, parameter, None)
1130

1131 1132 1133 1134
    # Backward compatibility
    if not getattr(self, "interface_name", None) \
        and getattr(self, "bridge_name", None):
      setattr(self, "interface_name", self.bridge_name)
1135 1136
      self.logger.warning('bridge_name option is deprecated and should be '
          'replaced by interface_name.')
1137 1138 1139
    if not getattr(self, "create_tap", None) \
        and getattr(self, "no_bridge", None):
      setattr(self, "create_tap", not self.no_bridge)
1140 1141
      self.logger.warning('no_bridge option is deprecated and should be '
          'replaced by create_tap.')
Łukasz Nowak's avatar
Łukasz Nowak committed
1142 1143 1144 1145 1146 1147

    # Set defaults lately
    if self.alter_network is None:
      self.alter_network = 'True'
    if self.alter_user is None:
      self.alter_user = 'True'
1148 1149
    if self.software_user is None:
      self.software_user = 'slapsoft'
1150 1151
    if self.create_tap is None:
      self.create_tap = True
Łukasz Nowak's avatar
Łukasz Nowak committed
1152 1153

    # Convert strings to booleans
1154
    for o in ['alter_network', 'alter_user', 'create_tap']:
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
      attr = getattr(self, o)
      if isinstance(attr, str):
        if attr.lower() == 'true':
          root_needed = True
          setattr(self, o, True)
        elif attr.lower() == 'false':
          setattr(self, o, False)
        else:
          message = 'Option %r needs to be "True" or "False", wrong value: ' \
              '%r' % (o, getattr(self, o))
          self.logger.error(message)
          raise UsageError(message)
Łukasz Nowak's avatar
Łukasz Nowak committed
1167

1168 1169 1170
    if not self.dry_run:
      if self.alter_user:
        self.checkRequiredBinary(['groupadd', 'useradd', 'usermod'])
1171
      if self.create_tap:
1172
        self.checkRequiredBinary([['tunctl', '-d']])
1173
      if self.alter_network:
1174
        self.checkRequiredBinary(['ip'])
Marco Mariani's avatar
Marco Mariani committed
1175

1176
    # Required, even for dry run
1177
    if self.alter_network and self.create_tap:
1178
      self.checkRequiredBinary(['brctl'])
Łukasz Nowak's avatar
Łukasz Nowak committed
1179

1180 1181 1182 1183
    # Check if root is needed
    if (self.alter_network or self.alter_user) and not self.dry_run:
      root_needed = True
    else:
1184
      root_needed = False
1185

Łukasz Nowak's avatar
Łukasz Nowak committed
1186 1187 1188 1189
    # check root
    if root_needed and os.getuid() != 0:
      message = "Root rights are needed"
      self.logger.error(message)
Marco Mariani's avatar
Marco Mariani committed
1190
      sys.stderr.write(message + '\n')
1191
      sys.exit()
Łukasz Nowak's avatar
Łukasz Nowak committed
1192 1193 1194 1195 1196 1197 1198 1199 1200

    if self.log_file:
      if not os.path.isdir(os.path.dirname(self.log_file)):
        # fallback to console only if directory for logs does not exists and
        # continue to run
        raise ValueError('Please create directory %r to store %r log file' % (
          os.path.dirname(self.log_file), self.log_file))
      else:
        file_handler = logging.FileHandler(self.log_file)
Vincent Pelletier's avatar
Vincent Pelletier committed
1201 1202
        file_handler.setFormatter(logging.Formatter("%(asctime)s - "
          "%(name)s - %(levelname)s - %(message)s"))
Łukasz Nowak's avatar
Łukasz Nowak committed
1203 1204
        self.logger.addHandler(file_handler)
        self.logger.info('Configured logging to file %r' % self.log_file)
1205

Łukasz Nowak's avatar
Łukasz Nowak committed
1206 1207 1208 1209 1210 1211
    # Check mandatory options
    for parameter in ('computer_id', 'instance_root', 'master_url',
                      'software_root', 'computer_xml'):
      if not getattr(self, parameter, None):
        raise UsageError("Parameter '%s' is not defined." % parameter)

1212 1213 1214 1215 1216
    # Check existence of SSL certificate files, if defined
    for attribute in ['key_file', 'cert_file', 'master_ca_file']:
      file_location = getattr(self, attribute, None)
      if file_location is not None:
        if not os.path.exists(file_location):
Marco Mariani's avatar
Marco Mariani committed
1217
          self.logger.fatal('File %r does not exist or is not readable.' %
1218 1219 1220
              file_location)
          sys.exit(1)

Łukasz Nowak's avatar
Łukasz Nowak committed
1221
    self.logger.info("Started.")
1222 1223
    if self.dry_run:
      self.logger.info("Dry-run mode enabled.")
1224
    if self.create_tap:
Cédric de Saint Martin's avatar
Cédric de Saint Martin committed
1225
      self.logger.info("Tap creation mode enabled.")
Łukasz Nowak's avatar
Łukasz Nowak committed
1226 1227 1228 1229

    # Calculate path once
    self.computer_xml = os.path.abspath(self.computer_xml)

Marco Mariani's avatar
Marco Mariani committed
1230 1231 1232 1233 1234 1235
    if self.input_definition_file:
      self.input_definition_file = os.path.abspath(self.input_definition_file)

    if self.output_definition_file:
      self.output_definition_file = os.path.abspath(self.output_definition_file)

Łukasz Nowak's avatar
Łukasz Nowak committed
1236

1237 1238
def tracing_monkeypatch(config):
  """Substitute os module and callAndRead function with tracing wrappers."""
Vincent Pelletier's avatar
Vincent Pelletier committed
1239 1240
  global os
  global callAndRead
1241

Vincent Pelletier's avatar
Vincent Pelletier committed
1242
  real_callAndRead = callAndRead
Łukasz Nowak's avatar
Łukasz Nowak committed
1243

1244 1245 1246 1247 1248 1249 1250 1251
  os = OS(config)
  if config.dry_run:
    def dry_callAndRead(argument_list, raise_on_error=True):
      if argument_list == ['brctl', 'show']:
        return real_callAndRead(argument_list, raise_on_error)
      else:
        return 0, ''
    callAndRead = dry_callAndRead
Marco Mariani's avatar
Marco Mariani committed
1252

1253
    def fake_getpwnam(user):
Vincent Pelletier's avatar
Vincent Pelletier committed
1254
      class result(object):
1255 1256 1257 1258 1259 1260
        pw_uid = 12345
        pw_gid = 54321
      return result
    pwd.getpwnam = fake_getpwnam
  else:
    dry_callAndRead = real_callAndRead
1261

Marco Mariani's avatar
Marco Mariani committed
1262 1263 1264 1265
  def logging_callAndRead(argument_list, raise_on_error=True):
    config.logger.debug(' '.join(argument_list))
    return dry_callAndRead(argument_list, raise_on_error)
  callAndRead = logging_callAndRead
1266 1267 1268 1269 1270 1271


def main(*args):
  "Run default configuration."

  # Parse arguments
Marco Mariani's avatar
Marco Mariani committed
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347

  ap = argparse.ArgumentParser(usage='usage: %s [options] CONFIGURATION_FILE' % sys.argv[0])

  ap.add_argument('-x', '--computer_xml',
                  help="Path to file with computer's XML. If does not exists, will be created",
                  default=None)

  ap.add_argument('--computer_json',
                  help="Path to a JSON version of the computer's XML (for development only).",
                  default=None)

  ap.add_argument('-l', '--log_file',
                  help="The path to the log file used by the script.")

  ap.add_argument('-i', '--input_definition_file',
                  help="Path to file to read definition of computer instead of "
                  "declaration. Using definition file allows to disable "
                  "'discovery' of machine services and allows to define computer "
                  "configuration in fully controlled manner.")

  ap.add_argument('-o', '--output_definition_file',
                  help="Path to file to write definition of computer from "
                  "declaration.")

  ap.add_argument('-n', '--dry_run',
                  help="Don't actually do anything.",
                  default=False,
                  action="store_true")

  ap.add_argument('-v', '--verbose',
                  default=False,
                  action="store_true",
                  help="Verbose output.")

  # the console option is actually ignored and not used anymore.
  ap.add_argument('-c', '--console',
                  default=False,
                  action="store_true",
                  help="Console output.")

  ap.add_argument('--alter_user',
                  choices=['True', 'False'],
                  help="Shall slapformat alter user database [default: True]")

  ap.add_argument('--alter_network',
                  choices=['True', 'False'],
                  help="Shall slapformat alter network configuration [default: True]")

  ap.add_argument('--now',
                  help="Launch slapformat without delay",
                  default=False,
                  action="store_true")

  ap.add_argument('configuration_file',
                  help='path to slapos.cfg')

  if args:
    options = ap.parse_args(list(args))
  else:
    options = ap.parse_args()

  logger = logging.getLogger("slapformat")
  logger.addHandler(logging.StreamHandler())

  if options.verbose:
    logger.setLevel(logging.DEBUG)
    logger.debug("Verbose mode enabled.")
  else:
    logger.setLevel(logging.INFO)

  config = FormatConfig(logger=logger)

  configuration_parser = ConfigParser.SafeConfigParser()
  if configuration_parser.read(options.configuration_file) != [options.configuration_file]:
    raise UsageError('Cannot find or parse configuration file: %s' % options.configuration_file)

1348
  try:
Marco Mariani's avatar
Marco Mariani committed
1349
    config.setConfig(options, configuration_parser)
1350 1351 1352 1353 1354 1355 1356
  except UsageError as err:
    sys.stderr.write(err.message + '\n')
    sys.stderr.write("For help use --help\n")
    sys.exit(1)

  tracing_monkeypatch(config)

1357
  try:
Marco Mariani's avatar
Marco Mariani committed
1358
    do_format(config=config)
1359 1360 1361
  except:
    config.logger.exception('Uncaught exception:')
    raise