Skip to content

Commit a2d8190

Browse files
author
Casey Boettcher
committed
Adding in basic web trappings
1 parent 95600d0 commit a2d8190

File tree

3 files changed

+115
-25
lines changed

3 files changed

+115
-25
lines changed

‎web/xfipchk.css

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
body
2+
{
3+
background-color: #777777;
4+
}
5+
6+
div#column
7+
{
8+
color: #FF6100;
9+
}
10+
11+
.api-cred
12+
{
13+
width: 250px;
14+
}

‎web/xfipchk.html

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>X-Force IP Check</title>
6+
<script src="jquery.js"></script>
7+
<script src="jquery.validate.js"></script>
8+
<link rel="stylesheet" type="text/css" href="xfipchk.css"/>
9+
:w
10+
</head>
11+
<body>
12+
<div id="column">
13+
<form id="the-form">
14+
<div>
15+
<p><span>Instructions:</span>
16+
<ol>
17+
<li>Paste your IBM X-Force API key and password into the corresponding fields.</li>
18+
<li>Enter IP addresses in the box labeled accordingly. They may be delimited by commas or newlines.</li>
19+
<li>Press the Submit button to call the API.</li>
20+
</ol>
21+
</p>
22+
<label for="api-key">X-Force API Key</label>
23+
<input type="text" autofocus required class="api-cred" name="api-key" id="api-key" title="api-key"
24+
placeholder="01234567-9abc-def0-1234-56789abcdef0"/>
25+
<label for="api-password">X-Force API Password</label>
26+
<input type="text" class="api-cred" required name="api-password" id="api-password" title="api-password"
27+
placeholder="01234567-9abc-def0-1234-56789abcdef0"/>
28+
</div>
29+
<div>
30+
<label for="ip-addresses">IP Addresses</label>
31+
<input type="textarea" class="ip-addresses" id="ip-addresses"/>
32+
</div>
33+
<script>
34+
$("the-form").validate();
35+
36+
37+
</script>
38+
</form>
39+
</div>
40+
</body>
41+
</html>

‎xfipchk.py

Lines changed: 60 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,15 @@
99
1010
"""
1111

12+
import os
1213
import sys
1314
import re
1415
import pprint
1516
import argparse
1617
import requests
1718
import IPy
19+
import http.server
20+
import socketserver
1821

1922
XFORCE_API_BASE = 'https://api.xforce.ibmcloud.com'
2023
XFORCE_API_IP_REP = 'ipr'
@@ -28,19 +31,31 @@ def parse_args():
2831
:return: a Namespace object of parsed arguments
2932
"""
3033
parser = argparse.ArgumentParser(description="Use the X-Force API to check IP address reputation.")
31-
parser.add_argument('-o', '--out', metavar='output_file',
34+
subparsers = parser.add_subparsers(help="Mutually exclusive sub-commands")
35+
36+
cli_parser = subparsers.add_parser('cli', help="Command-line Interface; run 'xfipchk cli -h' to see options")
37+
cli_parser.add_argument('-o', '--out', metavar='output_file',
3238
type=argparse.FileType('w'), help="Write result of X-Force call to file.")
33-
parser.add_argument('authN', type=argparse.FileType('r'),
34-
help='Path to a file containing your X-Force credentials, key and password on first and second '
39+
cli_parser.add_argument('authN', type=argparse.FileType('r'),
40+
help='Path to a file containing your X-Force credentials, key and password on first and second '
3541
'lines, respectively.')
3642

3743
# user should not be able to specify both IP on cmdline and in a file
38-
ip_group = parser.add_mutually_exclusive_group()
44+
ip_group = cli_parser.add_mutually_exclusive_group()
3945
# TODO: nargs='N' and loop through list
40-
ip_group.add_argument('-i', '--ip', nargs='?', metavar='ip_address', help='An IP address to be checked via '
41-
'X-Force. If the IP address is omitted or invalid, the user will be prompted for one.')
46+
ip_group.add_argument('-i', '--ip', metavar='ip_address', help='An IP address to be checked via X-Force. If the IP'
47+
'address is omitted or invalid, the user will be '
48+
'prompted for one.')
4249
ip_group.add_argument('-I', '--Ips', type=argparse.FileType('r'), metavar='file_of_ip_addresses',
4350
help='A file containing IP addresses, one per line.')
51+
52+
web_parser = subparsers.add_parser('web', help="Web interface; run 'xfipchk web -h' to see options")
53+
w_group = web_parser.add_argument_group(title="Web Interface", description="You may specify the address and port to"
54+
" bind to; defaults are 127.0.0.1 and "
55+
"8000")
56+
w_group.add_argument('-p', '--port', default=8000)
57+
w_group.add_argument('-a', '--address', default='127.0.0.1')
58+
4459
return parser.parse_args()
4560

4661

@@ -164,27 +179,47 @@ def print_json_file(results, file):
164179
file.write('######################################\n')
165180

166181

167-
def main():
182+
def start_server(ip_address="127.0.0.1", port=8000):
183+
# we want to serve out of the web directory
184+
handler = http.server.SimpleHTTPRequestHandler
185+
with socketserver.TCPServer((ip_address, port), handler) as httpd:
186+
print("Starting HTTP server on port {0}".format(port))
187+
httpd.serve_forever()
168188

169-
ip = None
170-
addresses = list()
189+
190+
def main():
171191
args = parse_args()
172-
if args.Ips:
173-
addresses = read_in_address_file(args.Ips)
174-
else:
175-
# get user-supplied IP address from the cmd line
176-
if args.ip:
177-
ip = validate_ip(args.ip)
178-
# prompt user for valid IP in case of typo on cmdline
179-
while not ip:
180-
ip = request_valid_ip()
181-
addresses.append(ip)
182-
creds = read_in_xforce_keys(args.authN)
183-
results = call_xforce_api(addresses, creds[0], creds[1])
184-
if args.out:
185-
print_json_file(results, args.out)
186-
else:
187-
print_json_stdout(results)
192+
# if port is in Namespace object, assume web interface
193+
if args.port:
194+
# TODO: should use a context manager here
195+
current = os.curdir
196+
try:
197+
os.chdir('./web')
198+
start_server(args.address, args.port)
199+
except OSError as ose:
200+
print(ose.strerror)
201+
finally:
202+
os.chdir(current)
203+
204+
elif args.cli:
205+
ip = None
206+
addresses = list()
207+
if args.Ips:
208+
addresses = read_in_address_file(args.Ips)
209+
else:
210+
# get user-supplied IP address from the cmd line
211+
if args.ip:
212+
ip = validate_ip(args.ip)
213+
# prompt user for valid IP in case of typo on cmdline
214+
while not ip:
215+
ip = request_valid_ip()
216+
addresses.append(ip)
217+
creds = read_in_xforce_keys(args.authN)
218+
results = call_xforce_api(addresses, creds[0], creds[1])
219+
if args.out:
220+
print_json_file(results, args.out)
221+
else:
222+
print_json_stdout(results)
188223

189224
return 0
190225

0 commit comments

Comments
 (0)