Skip to content
Snippets Groups Projects
warden_client.py 14.1 KiB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 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 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2011-2013 Cesnet z.s.p.o
# Use of this source is governed by a 3-clause BSD-style license, see LICENSE file.

import json, httplib, ssl, socket, logging, logging.handlers
from urlparse import urlparse
from urllib import urlencode
from sys import stderr, exc_info
from pprint import pformat
from traceback import format_tb
from os import path


class HTTPSConnection(httplib.HTTPSConnection):
    '''
    Overridden to allow peer certificate validation, configuration
    of SSL/ TLS version and cipher selection.  See:
    http://hg.python.org/cpython/file/c1c45755397b/Lib/httplib.py#l1144
    and `ssl.wrap_socket()`
    '''
    def __init__(self, host, **kwargs):
        self.ciphers = kwargs.pop('ciphers',None)
        self.ca_certs = kwargs.pop('ca_certs',None)
        self.ssl_version = kwargs.pop('ssl_version',ssl.PROTOCOL_SSLv23)

        httplib.HTTPSConnection.__init__(self,host,**kwargs)

    def connect(self):
        sock = socket.create_connection( (self.host, self.port), self.timeout)

        if self._tunnel_host:
            self.sock = sock
            self._tunnel()

        self.sock = ssl.wrap_socket(
            sock,
            keyfile = self.key_file,
            certfile = self.cert_file,
            ca_certs = self.ca_certs,
            cert_reqs = ssl.CERT_REQUIRED if self.ca_certs else ssl.CERT_NONE,
            ssl_version = self.ssl_version)



class Error(Exception):
    """ Object for returning error messages to calling application.
        Caller can test whether it received data or error by checking
        isinstance(res, Error).
        However if he does not want to deal with errors altogether,
        this error object also returns False value if used in Bool
        context (e.g. in "if res: print res" print is not evaluated),
        and also acts as empty iterator (e.g. in "for e in res: print e"
        print is also not evaluated).
        Also, it can be raised as an exception.
    """

    def __init__(self, message, logger=None, error=None, prio="error", method=None,
            req_id=None, detail=None, exc=None):

        self.message = message
        self.error = error
        self.method = method
        self.req_id = req_id
        self.detail = detail
        (self.exctype, self.excval, self.exctb) = exc or (None, None, None)
        self.cause = self.excval # compatibility with other exceptions
        if logger:
            getattr(logger, prio, "error")(str(self))
            info = self.info_str()
            if info:
                logger.info(info)
            debug = self.debug_str()
            if debug:
                logger.debug(debug)


    def __len__ (self):
        """ In list or iterable context we're empty """
        return 0


    def __iter__(self):
        """ We are the iterator """
        return self


    def next(self):
        """ In list or iterable context we're empty """
        raise StopIteration


    def __bool__(self):
        """ In boolean context we're never True """
        return False


    def __str__(self):
        out = []
        out.append("(%s)" % (self.error or "local"))
        if self.method is not None:
            out.append(" in %s" % self.method)
        if self.req_id is not None:
            out.append("(%8x)" % self.req_id)
        if self.message is not None:
            out.append(": %s" % self.message)
        if self.excval is not None:
            out.append(" - cause was %s: %s" % (type(self.excval).__name__, str(self.excval)))
        return "".join(out)


    def info_str(self):
        return ("Detail: %s" % pformat(self.detail)) or ""


    def debug_str(self):
        out = []
        if self.excval is not None:
            out.append("Exception %s: %s\n" % (type(self.excval).__name__, str(self.excval)))
        if self.exctb is not None:
            out.append("Traceback:\n%s" % "".join(format_tb(self.exctb)))
        return "".join(out)



class Client(object):

    def __init__(self,
            url,
            certfile=None,
            keyfile=None,
            cafile=None,
            timeout=60,
            recv_events_limit=6000,
            errlog={"level": "debug"},
            syslog=None,
            filelog=None,
            idstore=None,
            name="warden_client",
            secret=None):

        self.name = name
        self.secret = secret
        # Init logging as soon as possible and make sure we don't
        # spit out exceptions but just log or return Error objects
        self.init_log(errlog, syslog, filelog)

        self.url = urlparse(url, allow_fragments=False)

        self.conn = None

        base = path.join(path.dirname(__file__))
        self.certfile = path.join(base, certfile or "cert.pem")
        self.keyfile  = path.join(base, keyfile or "key.pem")
        self.cafile = path.join(base, cafile or "ca.pem")
        self.timeout = int(timeout)
        self.recv_events_limit = int(recv_events_limit)
        self.idstore = path.join(base, idstore) if idstore is not None else None

        self.ciphers = 'TLS_RSA_WITH_AES_256_CBC_SHA'
        self.sslversion = ssl.PROTOCOL_TLSv1


    def init_log(self, errlog, syslog, filelog):

        def loglevel(lev):
            try:
                return int(getattr(logging, lev.upper()))
            except (AttributeError, ValueError):
                self.logger.warning("Unknown loglevel \"%s\", using \"debug\"" % lev)
                return logging.DEBUG

        def facility(fac):
            try:
                return int(getattr(logging.handlers.SysLogHandler, "LOG_" + fac.upper()))
            except (AttributeError, ValueError):
                self.logger.warning("Unknown syslog facility \"%s\", using \"local7\"" % fac)
                return logging.handlers.SysLogHandler.LOG_LOCAL7

        form = "%(filename)s[%(process)d]: (%(levelname)s) %(name)s %(message)s"
        format_notime = logging.Formatter(form)
        format_time = logging.Formatter('%(asctime)s ' + form)

        self.logger = logging.getLogger(self.name)
        self.logger.propagate = False   # Don't bubble up to root logger
        self.logger.setLevel(logging.DEBUG)

        if errlog is not None:
            el = logging.StreamHandler(stderr)
            el.setFormatter(format_time)
            el.setLevel(loglevel(errlog.get("level", "debug")))
            self.logger.addHandler(el)

        if filelog is not None:
            try:
                fl = logging.FileHandler(
                    filename=path.join(
                        path.dirname(__file__),
                        filelog.get("file", "%s.log" % self.name)))
                fl.setLevel(loglevel(filelog.get("level", "warning")))
                fl.setFormatter(format_time)
                self.logger.addHandler(fl)
            except Exception as e:
                Error("Unable to setup file logging", self.logger, exc=exc_info())

        if syslog is not None:
            try:
                sl = logging.handlers.SysLogHandler(
                    address=syslog.get("socket", "/dev/log"),
                    facility=facility(syslog.get("facility", "local7")))
                sl.setLevel(loglevel(syslog.get("level", "warning")))
                sl.setFormatter(format_notime)
                self.logger.addHandler(sl)
            except Exception as e:
                Error("Unable to setup syslog logging", self.logger, exc=exc_info())

        if not (errlog or filelog or syslog):
            # User wants explicitly no logging, so let him shoot his socks off.
            # This silences complaining of logging module about no suitable
            # handler.
            self.logger.addHandler(logging.NullHandler())


    def connect(self):

        try:
            if self.url.scheme=="https":
                self.conn = HTTPSConnection(
                    self.url.netloc,
                    key_file = self.keyfile,
                    cert_file = self.certfile,
                    timeout = self.timeout,
                    ciphers = self.ciphers,
                    ca_certs = self.cafile,
                    ssl_version = self.sslversion)
            elif self.url.scheme=="http":
                self.conn = httplib.HTTPConnection(
                    self.url.netloc,
                    timeout = self.timeout)
            else:
                return Error("Don't know how to connect to \"%s\"" % self.url.scheme, self.logger,
                        detail={"url": self.url.geturl()})
        except Exception:
            return Error("HTTPS connection failed", self.logger, exc=exc_info(),
                detail={
                    "url": self.url.geturl(),
                    "timeout": self.timeout,
                    "key_file": self.keyfile,
                    "cert_file": self.certfile,
                    "cafile": self.cafile,
                    "ciphers": self.ciphers,
                    "ssl_version": self.sslversion})

        return True


    def sendRequest(self, func="", payload=None, **kwargs):

        if self.secret is None:
            kwargs["client"] = self.name
        else:
            kwargs["secret"] = self.secret

        if kwargs:
            for k in kwargs.keys():
                if kwargs[k] is None:
                    del kwargs[k]
            argurl = "?" + urlencode(kwargs, doseq=True)
        else:
            argurl = ""

        try:
            if payload is None:
                data = ""
            else:
                data = json.dumps(payload)
        except:
            return Error("Serialization to JSON failed", self.logger,
                exc=exc_info(), method=func, detail=payload)

        self.headers = {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "Content-Length": str(len(data))
        }

        # We are connecting here at first use instead of in
        # constructor, because constructor cannot return data/errors
        # and we don't want to spit exceptions into user's face
        # And maaaybee sometime we will implement reconnection on errors
        if self.conn is None:
            err = self.connect()
            if not err:
                return err  # either False of Error instance

        loc = '%s/%s%s' % (self.url.path, func, argurl)
        try:
            self.conn.request("POST", loc, data, self.headers)
        except:
            return Error("Sending of request to server failed", self.logger,
                exc=exc_info(), method=func, detail={
                    "loc": loc,
                    "headers": self.headers,
                    "data": data})

        try:
            res = self.conn.getresponse()
        except:
            return Error("HTTP reply failed", self.logger, method=func, exc=exc_info())

        try:
            response_data = res.read()
        except:
            return Error("Fetching HTTP data from server failed", self.logger, method=func, exc=exc_info())

        if res.status==httplib.OK:
            try:
                data = json.loads(response_data)
            except:
                data = Error("JSON message parsing failed", self.logger,
                    exc=exc_info(), method=func, detail={"response": response_data})
        else:
            try:
                data = json.loads(response_data)
                data["error"]   # trigger exception if not dict or no error key
            except:
                data = Error("Generic server HTTP error", self.logger,
                    method=func,
                    error=res.status,
                    exc=exc_info(),
                    detail={"response": response_data})
            else:
                data = Error(data.get("message", None), self.logger,
                    method=data.get("method", None),
                    error=res.status,
                    req_id=data.get("req_id", None),
                    detail=data.get("detail", None))

        return data


    def _saveID(self, id, idstore=None):
        idf = idstore or self.idstore
        if not idf:
            return False
        try:
            with open(idf, "w+") as f:
                f.write(str(id))
        except (ValueError, IOError) as e:
            # Use Error instance just for proper logging
            Error("Writing id file \"%s\" failed" % idf, self.logger,
                prio="info", exc=exc_info(), detail={"idstore": idf})
        return id


    def _loadID(self, idstore=None):
        idf = idstore or self.idstore
        if not idf:
            return None
        try:
            with open(idf, "r") as f:
                id = int(f.read())
        except (ValueError, IOError) as e:
            Error("Reading id file \"%s\" failed, relying on server" % idf,
                self.logger, prio="info", exc=exc_info(), detail={"idstore": idf})
            id = None
        return id


    def getDebug(self):
        return self.sendRequest("getDebug")


    def getInfo(self):
        return self.sendRequest("getInfo")


    def sendEvents(self, events=[]):
        res = self.sendRequest(
            "sendEvents", payload=events)
        return res


    def getEvents(self, id=None, idstore=None, count=1,
            cat=None, nocat=None,
            tag=None, notag=None,
            group=None, nogroup=None):

        if not id:
            id = self._loadID(idstore)

        res = self.sendRequest(
            "getEvents", id=id, count=count or self.recv_events_limit, cat=cat,
            nocat=nocat, tag=tag, notag=notag, group=group, nogroup=nogroup)
        if not res:
            return res  # Should be Error instance

        try:
            events = res["events"]
            newid = res["lastid"]
        except KeyError:
            return Error("Server returned bogus reply", self.logger,
                method="getEvents", exc=exc_info(), detail={"response": res})

        self._saveID(newid)

        return events


    def close(self):

        if hasattr(self, "conn") and hasattr(self.conn, "close"):
            self.conn.close()


    __del__ = close



def read_cfg(cfgfile):
    abspath = path.join(path.dirname(__file__), cfgfile)
    with open(abspath, "r") as f:
        stripcomments = "\n".join((l for l in f if not l.lstrip().startswith("#")))
        return json.loads(stripcomments)