key.py

Go to the documentation of this file.

# -*- coding: utf-8 -*-
# @COPYRIGHT_begin
#
# Copyright [2010-2014] Institute of Nuclear Physics PAN, Krakow, Poland
#
# Licensed under the Apache License, Version 2.0 (the "License");
#    you may not use this file except in compliance with the License.
#    You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.
#
# @COPYRIGHT_end

##
# @package src.clm.views.user.key
# @alldecoratedby{src.clm.utils.decorators.user_log}
# 

import base64
import hashlib
import os
import re
import subprocess

from clm.models.key import Key
from clm.utils.decorators import user_log
from clm.utils.exception import CLMException


@user_log(log=False)
##
# 
#     Returns the requested Key's. Key must belong to the caller.
# 
#     @clmview_user
#     @param_post{name,string} Requested Key's name
# 
#     @response{dict} Key.dict property of the requested key
#     
def get(cm_id, caller_id, name):
    try:
        k = Key.objects.filter(user_id__exact=caller_id).filter(name__exact=name)[0]
    except:
        raise CLMException('ssh_key_get')

    return k.dict


@user_log(log=False)
##
# 
#     Returns caller's Keys.
# 
#     @clmview_user
#     @response{list(dict)} Key.dict property of each Key
#     
def get_list(cm_id, caller_id):
    return [k.dict for k in Key.objects.filter(user_id__exact=caller_id)]


@user_log(log=True)
##
# 
#     Generates Key pair named @prm{name} for caller. Public part of that Key is
#     stored in database with specified name, whereas content of the private Key
#     part is returned. Neither public, nor private part of the key is saved to
#     file. Private part of the key is never stored - it's only returned once.
# 
#     @clmview_user
#     @param_post{name,string} Key's name
# 
#     @response{string} content of private Key's file
#     
def generate(cm_id, caller_id, name):
    keys_limit = False
    try:
        from clm.settings import SSH_KEYS_LIMIT
        keys_limit = SSH_KEYS_LIMIT
    except:
        pass
    if keys_limit and len(Key.objects.filter(user_id__exact=caller_id)) > keys_limit:
        raise CLMException('ssh_key_limit')
    if Key.objects.filter(user_id__exact=caller_id).filter(name__exact=name).exists():
        raise CLMException('ssh_key_already_exist')
    if subprocess.call(['ssh-keygen', '-q', '-f', '/tmp/' + str(caller_id) + '_' + name, '-N', '']) != 0:
        raise CLMException('ssh_key_generate')
    f_prv = open('/tmp/' + str(caller_id) + '_' + name, 'r')
    f_pub = open('/tmp/' + str(caller_id) + '_' + name + '.pub', 'r')
    k = Key()
    k.user_id = caller_id
    k.data = f_pub.read()
    k.name = name
    s = hashlib.md5(base64.b64decode(k.data.split()[1])).hexdigest()
    k.fingerprint = ':'.join([s[i:i + 2] for i in xrange(0, 30, 2)])
    try:
        k.save()
    except:
        raise CLMException('ssh_key_generate')
    finally:
        private = f_prv.read()
        os.remove('/tmp/' + str(caller_id) + '_' + name)
        os.remove('/tmp/' + str(caller_id) + '_' + name + '.pub')

    return private


@user_log(log=True)
##
# 
#     Adds given Key named @prm{name} with content @prm{key} to caller's keys list.
# 
#     @clmview_user
#     @param_post{key,string} key's content
#     @param_post{name,string} key's name
# 
#     @response{None}
#     
def add(cm_id, caller_id, key, name):
    keys_limit = False
    try:
        from clm.settings import SSH_KEYS_LIMIT
        keys_limit = SSH_KEYS_LIMIT
    except:
        pass
    if keys_limit and len(Key.objects.filter(user_id__exact=caller_id)) > keys_limit:
        raise CLMException('ssh_key_limit')
    k = Key()
    k.user_id = caller_id
    k.data = key
    k.name = name
    r = re.search('ssh-rsa (.*) (.*)', key)
    if not r:
        raise CLMException('ssh_key_format')
    s = hashlib.md5(base64.b64decode(r.groups()[0])).hexdigest()
    k.fingerprint = ':'.join([s[i:i + 2] for i in xrange(0, 30, 2)])
    try:
        k.save()
    except:
        raise CLMException('ssh_key_add')


@user_log(log=True)
##
# 
#     Method deletes specified key named @prm{name}.
# 
#     @clmview_user
#     @param_post{name,string} name of the Key to delete
#     @response{None}
#     
def delete(cm_id, caller_id, name):
    try:
        Key.objects.filter(user_id__exact=caller_id).filter(name__exact=name).delete()
    except:
        raise CLMException('ssh_key_delete')


@user_log(log=True)
##
# 
#     Method removes key with id \c id.
# 
#     @clmview_user
#     @param_post{key_ids,list(int)} list of Key ids to delete
# 
#     @response{dict} \n fields:
#     @dictkey{status,string}
#     @dictkey{data,dict}
#     
def delete_by_id(cm_id, caller_id, key_ids):
    results = []
    for key_id in key_ids:
        try:
            Key.objects.filter(user_id__exact=caller_id).filter(id__exact=key_id).delete()
            results.append({'status': 'ok', 'data': ''})
        except:
            results.append({'status': 'ssh_key_delete', 'data': ''})

    return results