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
|
# Copyright (C) 2017-2021 Internet Systems Consortium, Inc. ("ISC")
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
"""
This file contains classes used for communication with Control Agent.
"""
class CARequest:
"""
This class defines the HTTP request to be sent.
The supported parameters listed are:
- path (specifies the path on the server, CA uses only /)
- scheme - http or https
- http_host - hostname of the CA
- http_port - TCP port of the CA
- ca - False or CA file or path
- cert - False or cert file
- key - False or private key file
- command - specifies the command to send (e.g. list-commands)
- service - specifies service that is target for the command (e.g. dhcp4)
- timeout - timeout (in ms)
- auth - basic HTTP authentication credential
- args - extra arguments my be added here
- headers - extra HTTP headers may be added here
- version - version to be reported in HTTP header
"""
path = '/'
scheme = 'http'
http_host = ''
http_port = 0
ca = False
cert = False
key = False
command = ''
service = ''
timeout = 0
auth = None
args = ''
headers = {}
version = ""
# This is a storage for generated command (input data to be sent over POST)
content = ''
def generate_body(self):
"""
Generates the content, out of specified command line
and optional content.
this stores the output in self.content
"""
self.content = '{ "command": "' + self.command + '"'
if self.service is not None:
self.service = [x for x in self.service if x]
if len(self.service) > 0:
self.content += ', "service": ["' + '","'.join(self.service) + '"]'
if len(self.args) > 1:
self.content += ', "arguments": { ' + self.args + ' }'
self.content += ' }'
def generate_headers(self):
"""
Generate HTTP headers
In particular, this method generates Content-Length and its value.
"""
self.headers['User-Agent'] = "Kea-shell/%s"%(self.version)
self.headers['Accept'] = '*/*'
if self.auth is not None:
self.headers['Authorization'] = "Basic %s"%(self.auth)
self.headers['Content-Type'] = 'application/json'
self.headers['Content-Length'] = "%d"%(len(self.content))
class CAResponse:
"""
This class represents the HTTP response
"""
def __init__(self, status, reason, body):
"""
Constructor
Three mandatory parameters are:
status - numerical number the describe the status (e.g. 200 = OK)
reason - textual explanation of what happened
body - the actual body structure of the response
"""
self.status = status
self.reason = reason
self.body = body
status = 0
reason = ''
body = ''
def print_response(self, debug=False):
"""
Used for debugging
if debug is true, this prints even more information
"""
if debug:
print(self.status)
print(self.reason)
print(self.body)
|
