re2o/freeradius_utils/auth.py

# -*- mode: python; coding: utf-8 -*-
# Re2o est un logiciel d'administration développé initiallement au rezometz. Il
# se veut agnostique au réseau considéré, de manière à être installable en
# quelques clics.
#
# Copyirght © 2017  Daniel Stan
# Copyright © 2017  Gabriel Détraz
# Copyright © 2017  Goulven Kermarec
# Copyright © 2017  Augustin Lemesle
#
# 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 2 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.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

"""
Backend python pour freeradius.

Ce fichier contient la définition de plusieurs fonctions d'interface à
freeradius qui peuvent être appelées (suivant les configurations) à certains
moment de l'authentification, en WiFi, filaire, ou par les NAS eux-mêmes.

Inspirés d'autres exemples trouvés ici :
https://github.com/FreeRADIUS/freeradius-server/blob/master/src/modules/rlm_python/

Inspiré du travail de Daniel Stan au Crans
"""

import os
import sys
import logging
import radiusd  # Module magique freeradius (radiusd.py is dummy)

from django.core.wsgi import get_wsgi_application
from django.db.models import Q

proj_path = "/var/www/re2o/"
# This is so Django knows where to find stuff.
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "re2o.settings")
sys.path.append(proj_path)

# This is so my local_settings.py gets loaded.
os.chdir(proj_path)

# This is so models get loaded.
application = get_wsgi_application()

from machines.models import Interface, IpList, Nas, Domain
from topologie.models import Port, Switch
from users.models import User
from preferences.models import OptionalTopologie


options, created = OptionalTopologie.objects.get_or_create()
VLAN_NOK = options.vlan_decision_nok.vlan_id
VLAN_OK = options.vlan_decision_ok.vlan_id
RADIUS_POLICY = options.radius_general_policy

#: Serveur radius de test (pas la prod)
TEST_SERVER = bool(os.getenv('DBG_FREERADIUS', False))


# Logging
class RadiusdHandler(logging.Handler):
    """Handler de logs pour freeradius"""

    def emit(self, record):
        """Process un message de log, en convertissant les niveaux"""
        if record.levelno >= logging.WARN:
            rad_sig = radiusd.L_ERR
        elif record.levelno >= logging.INFO:
            rad_sig = radiusd.L_INFO
        else:
            rad_sig = radiusd.L_DBG
        radiusd.radlog(rad_sig, record.msg)


# Initialisation d'un logger (pour logguer unifié)
logger = logging.getLogger('auth.py')
logger.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(name)s: [%(levelname)s] %(message)s')
handler = RadiusdHandler()
handler.setFormatter(formatter)
logger.addHandler(handler)


def radius_event(fun):
    """Décorateur pour les fonctions d'interfaces avec radius.
    Une telle fonction prend un uniquement argument, qui est une liste de
    tuples (clé, valeur) et renvoie un triplet dont les composantes sont :
     * le code de retour (voir radiusd.RLM_MODULE_* )
     * un tuple de couples (clé, valeur) pour les valeurs de réponse (accès ok
       et autres trucs du genre)
     * un tuple de couples (clé, valeur) pour les valeurs internes à mettre à
       jour (mot de passe par exemple)

    On se contente avec ce décorateur (pour l'instant) de convertir la liste de
    tuples en entrée en un dictionnaire."""

    def new_f(auth_data):
        """ The function transforming the tuples as dict """
        if isinstance(auth_data, dict):
            data = auth_data
        else:
            data = dict()
            for (key, value) in auth_data or []:
                # Beware: les valeurs scalaires sont entre guillemets
                # Ex: Calling-Station-Id: "une_adresse_mac"
                data[key] = value.replace('"', '')
        try:
            # TODO s'assurer ici que les tuples renvoyés sont bien des
            # (str,str) : rlm_python ne digère PAS les unicodes
            return fun(data)
        except Exception as err:
            logger.error('Failed %r on data %r' % (err, auth_data))
            raise

    return new_f


@radius_event
def instantiate(*_):
    """Utile pour initialiser les connexions ldap une première fois (otherwise,
    do nothing)"""
    logger.info('Instantiation')
    if TEST_SERVER:
        logger.info(u'DBG_FREERADIUS is enabled')


@radius_event
def authorize(data):
    """On test si on connait le calling nas:
    - si le nas est inconnue, on suppose que c'est une requète 802.1X, on la
      traite
    - si le nas est connu, on applique 802.1X si le mode est activé
    - si le nas est connu et si il s'agit d'un nas auth par mac, on repond
      accept en authorize
    """
    # Pour les requetes proxifiees, on split
    nas = data.get('NAS-IP-Address', data.get('NAS-Identifier', None))
    nas_instance = find_nas_from_request(nas)
    # Toutes les reuquètes non proxifiées
    nas_type = None
    if nas_instance:
        nas_type = Nas.objects.filter(nas_type=nas_instance.type).first()
    if not nas_type or nas_type.port_access_mode == '802.1X':
        user = data.get('User-Name', '').decode('utf-8', errors='replace')
        user = user.split('@', 1)[0]
        mac = data.get('Calling-Station-Id', '')
        result, log, password = check_user_machine_and_register(
            nas_type,
            user,
            mac
        )
        logger.info(log.encode('utf-8'))
        logger.info(user.encode('utf-8'))

        if not result:
            return radiusd.RLM_MODULE_REJECT
        else:
            return (
                radiusd.RLM_MODULE_UPDATED,
                (),
                (
                    (str("NT-Password"), str(password)),
                ),
            )

    else:
        return (
            radiusd.RLM_MODULE_UPDATED,
            (),
            (
                ("Auth-Type", "Accept"),
            ),
        )


@radius_event
def post_auth(data):
    """ Function called after the user is authenticated
    """

    nas = data.get('NAS-IP-Address', data.get('NAS-Identifier', None))
    nas_instance = find_nas_from_request(nas)
    # Toutes les reuquètes non proxifiées
    if not nas_instance:
        logger.info(u"Requète proxifiée, nas inconnu".encode('utf-8'))
        return radiusd.RLM_MODULE_OK
    nas_type = Nas.objects.filter(nas_type=nas_instance.type).first()
    if not nas_type:
        logger.info(
            u"Type de nas non enregistré dans la bdd!".encode('utf-8')
        )
        return radiusd.RLM_MODULE_OK

    mac = data.get('Calling-Station-Id', None)

    # Switch et bornes héritent de machine et peuvent avoir plusieurs
    # interfaces filles
    nas_machine = nas_instance.machine
    # Si il s'agit d'un switch
    if hasattr(nas_machine, 'switch'):
        port = data.get('NAS-Port-Id', data.get('NAS-Port', None))
        # Pour les infrastructures possédant des switchs Juniper :
        # On vérifie si le switch fait partie d'un stack Juniper
        instance_stack = nas_machine.switch.stack
        if instance_stack:
            # Si c'est le cas, on resélectionne le bon switch dans la stack
            id_stack_member = port.split("-")[1].split('/')[0]
            nas_machine = (Switch.objects
                           .filter(stack=instance_stack)
                           .filter(stack_member_id=id_stack_member)
                           .prefetch_related(
                               'interface_set__domain__extension'
                           )
                           .first())
        # On récupère le numéro du port sur l'output de freeradius.
        # La ligne suivante fonctionne pour cisco, HP et Juniper
        port = port.split(".")[0].split('/')[-1][-2:]
        out = decide_vlan_and_register_switch(nas_machine, nas_type, port, mac)
        sw_name, room, reason, vlan_id = out

        log_message = '(fil) %s -> %s [%s%s]' % (
            sw_name + u":" + port + u"/" + str(room),
            mac,
            vlan_id,
            (reason and u': ' + reason).encode('utf-8')
        )
        logger.info(log_message)

        # Filaire
        return (
            radiusd.RLM_MODULE_UPDATED,
            (
                ("Tunnel-Type", "VLAN"),
                ("Tunnel-Medium-Type", "IEEE-802"),
                ("Tunnel-Private-Group-Id", '%d' % int(vlan_id)),
            ),
            ()
        )

    else:
        return radiusd.RLM_MODULE_OK


# TODO : remove this function
@radius_event
def dummy_fun(_):
    """Do nothing, successfully. (C'est pour avoir un truc à mettre)"""
    return radiusd.RLM_MODULE_OK


def detach(_=None):
    """Appelé lors du déchargement du module (enfin, normalement)"""
    print("*** goodbye from auth.py ***")
    return radiusd.RLM_MODULE_OK


def find_nas_from_request(nas_id):
    """ Get the nas object from its ID """
    nas = (Interface.objects
           .filter(
               Q(domain=Domain.objects.filter(name=nas_id)) |
               Q(ipv4=IpList.objects.filter(ipv4=nas_id))
           )
           .select_related('type')
           .select_related('machine__switch__stack'))
    return nas.first()


def check_user_machine_and_register(nas_type, username, mac_address):
    """Verifie le username et la mac renseignee. L'enregistre si elle est
    inconnue.
    Renvoie le mot de passe ntlm de l'user si tout est ok
    Utilise pour les authentifications en 802.1X"""
    interface = Interface.objects.filter(mac_address=mac_address).first()
    user = User.objects.filter(pseudo=username).first()
    if not user:
        return (False, u"User inconnu", '')
    if not user.has_access():
        return (False, u"Adhérent non cotisant", '')
    if interface:
        if interface.machine.user != user:
            return (False,
                    u"Machine enregistrée sur le compte d'un autre "
                    "user...",
                    '')
        elif not interface.is_active:
            return (False, u"Machine desactivée", '')
        elif not interface.ipv4:
            interface.assign_ipv4()
            return (True, u"Ok, Reassignation de l'ipv4", user.pwd_ntlm)
        else:
            return (True, u"Access ok", user.pwd_ntlm)
    elif nas_type:
        if nas_type.autocapture_mac:
            result, reason = user.autoregister_machine(mac_address, nas_type)
            if result:
                return (True,
                        u'Access Ok, Capture de la mac...',
                        user.pwd_ntlm)
            else:
                return (False, u'Erreur dans le register mac %s' % reason, '')
        else:
            return (False, u'Machine inconnue', '')
    else:
        return (False, u"Machine inconnue", '')


def decide_vlan_and_register_switch(nas_machine, nas_type, port_number,
                                    mac_address):
    """Fonction de placement vlan pour un switch en radius filaire auth par
    mac.
    Plusieurs modes :
    - nas inconnu, port inconnu : on place sur le vlan par defaut VLAN_OK
    - pas de radius sur le port : VLAN_OK
    - bloq : VLAN_NOK
    - force : placement sur le vlan indiqué dans la bdd
    - mode strict :
        - pas de chambre associée : VLAN_NOK
        - pas d'utilisateur dans la chambre : VLAN_NOK
        - cotisation non à jour : VLAN_NOK
        - sinon passe à common (ci-dessous)
    - mode common :
        - interface connue (macaddress):
            - utilisateur proprio non cotisant ou banni : VLAN_NOK
            - user à jour : VLAN_OK
        - interface inconnue :
            - register mac désactivé : VLAN_NOK
            - register mac activé :
                - dans la chambre associé au port, pas d'user ou non à
                  jour : VLAN_NOK
                - user à jour, autocapture de la mac et VLAN_OK
    """
    # Get port from switch and port number
    extra_log = ""
    # Si le NAS est inconnu, on place sur le vlan defaut
    if not nas_machine:
        return ('?', u'Chambre inconnue', u'Nas inconnu', VLAN_OK)

    sw_name = str(nas_machine)

    port = (Port.objects
            .filter(
                switch=Switch.objects.filter(machine_ptr=nas_machine),
                port=port_number
            )
            .first())

    # Si le port est inconnu, on place sur le vlan defaut
    # Aucune information particulière ne permet de déterminer quelle
    # politique à appliquer sur ce port
    if not port:
        return (sw_name, "Chambre inconnue", u'Port inconnu', VLAN_OK)

    # On récupère le profil du port
    port_profile = port.get_port_profile

    # Si un vlan a été précisé dans la config du port,
    # on l'utilise pour VLAN_OK
    if port_profile.vlan_untagged:
        DECISION_VLAN = int(port_profile.vlan_untagged.vlan_id)
        extra_log = u"Force sur vlan " + str(DECISION_VLAN)
    else:
        DECISION_VLAN = VLAN_OK

    # Si le port est désactivé, on rejette sur le vlan de déconnexion
    if not port.state:
        return (sw_name, port.room, u'Port desactivé', VLAN_NOK)

    # Si radius est désactivé, on laisse passer
    if port_profile.radius_type == 'NO':
        return (sw_name,
                "",
                u"Pas d'authentification sur ce port" + extra_log,
                DECISION_VLAN)

    # Si le 802.1X est activé sur ce port, cela veut dire que la personne a été accept précédemment
    # Par conséquent, on laisse passer sur le bon vlan
    if nas_type.port_access_mode == '802.1X' and port_profile.radius_type == '802.1X':
        room = port.room or "Chambre/local inconnu"
        return (sw_name, room, u'Acceptation authentification 802.1X', DECISION_VLAN)

    # Sinon, cela veut dire qu'on fait de l'auth radius par mac
    # Si le port est en mode strict, on vérifie que tous les users
    # rattachés à ce port sont bien à jour de cotisation. Sinon on rejette (anti squattage)
    # Il n'est pas possible de se connecter sur une prise strict sans adhérent à jour de cotis
    # dedans
    if port_profile.radius_mode == 'STRICT':
        room = port.room
        if not room:
            return (sw_name, "Inconnue", u'Chambre inconnue', VLAN_NOK)

        room_user = User.objects.filter(
            Q(club__room=port.room) | Q(adherent__room=port.room)
        )
        if not room_user:
            return (sw_name, room, u'Chambre non cotisante', VLAN_NOK)
        for user in room_user:
            if not user.has_access():
                return (sw_name, room, u'Chambre resident desactive', VLAN_NOK)
        # else: user OK, on passe à la verif MAC

    # Si on fait de l'auth par mac, on cherche l'interface via sa mac dans la bdd
    if port_profile.radius_mode == 'COMMON' or port_profile.radius_mode == 'STRICT':
        # Authentification par mac
        interface = (Interface.objects
                     .filter(mac_address=mac_address)
                     .select_related('machine__user')
                     .select_related('ipv4')
                     .first())
        if not interface:
            room = port.room
            # On essaye de register la mac, si l'autocapture a été activée
            # Sinon on rejette sur vlan_nok
            if not nas_type.autocapture_mac:
                return (sw_name, "", u'Machine inconnue', VLAN_NOK)
            # On ne peut autocapturer que si on connait la chambre et donc l'user correspondant
            elif not room:
                return (sw_name,
                        "Inconnue",
                        u'Chambre et machine inconnues',
                        VLAN_NOK)
            else:
                # Si la chambre est vide (local club, prises en libre services)
                # Impossible d'autocapturer
                if not room_user:
                    room_user = User.objects.filter(
                        Q(club__room=port.room) | Q(adherent__room=port.room)
                    )
                if not room_user:
                    return (sw_name,
                            room,
                            u'Machine et propriétaire de la chambre '
                            'inconnus',
                            VLAN_NOK)
                # Si il y a plus d'un user dans la chambre, impossible de savoir à qui
                # Ajouter la machine
                elif room_user.count() > 1:
                    return (sw_name,
                            room,
                            u'Machine inconnue, il y a au moins 2 users '
                            'dans la chambre/local -> ajout de mac '
                            'automatique impossible',
                            VLAN_NOK)
                # Si l'adhérent de la chambre n'est pas à jour de cotis, pas d'autocapture
                elif not room_user.first().has_access():
                    return (sw_name,
                            room,
                            u'Machine inconnue et adhérent non cotisant',
                            VLAN_NOK)
                # Sinon on capture et on laisse passer sur le bon vlan
                else:
                    interface, reason = (room_user
                                      .first()
                                      .autoregister_machine(
                                          mac_address,
                                          nas_type
                                      ))
                    if interface:
                        ## Si on choisi de placer les machines sur le vlan correspondant à leur type :
                        if RADIUS_POLICY == 'MACHINE':
                            DECISION_VLAN = interface.type.ip_type.vlan.vlan_id
                        return (sw_name,
                                room,
                                u'Access Ok, Capture de la mac: ' + extra_log,
                                DECISION_VLAN)
                    else:
                        return (sw_name,
                                room,
                                u'Erreur dans le register mac %s' % (
                                    reason + str(mac_address)
                                ),
                                VLAN_NOK)
        # L'interface a été trouvée, on vérifie qu'elle est active, sinon on reject
        # Si elle n'a pas d'ipv4, on lui en met une
        # Enfin on laisse passer sur le vlan pertinent
        else:
            room = port.room
            if not interface.is_active:
                return (sw_name,
                        room,
                        u'Machine non active / adherent non cotisant',
                        VLAN_NOK)
            ## Si on choisi de placer les machines sur le vlan correspondant à leur type :
            if RADIUS_POLICY == 'MACHINE':
                DECISION_VLAN = interface.type.ip_type.vlan.vlan_id
            if not interface.ipv4:
                interface.assign_ipv4()
                return (sw_name,
                        room,
                        u"Ok, Reassignation de l'ipv4" + extra_log,
                        DECISION_VLAN)
            else:
                return (sw_name,
                        room,
                        u'Machine OK' + extra_log,
                        DECISION_VLAN)