rocknsm/docket

A RESTful API frontend for Stenographer

docket

A RESTful API frontend for Stenographer

Read the documentation

Limitations

Docket does not perform any authentication whatsoever. If you need to control access to your PCAP data, you should configure the forward-facing reverse proxy (such as nginx, apache, lighttpd, etc) to perform this function. These programs have robust and flexible methods of authentication available from .htpasswd files, to PAM, to Kerberos.

docket's Issues

Current RPM issues (devel branch)

• docket-celery-*.service files need to call docket.app instead of manage.app.
• /etc/sysconfig/docket points to the config located at /etc/docket/docket.yaml, but that doesn't exist
• /var/log/docket isn't created by the RPM spec file

x509 certifcate hostname mismatch throws uncaught exception

This was my error, b/c I configured docket to pull from the wrong IP endpoint, but ideally the process doesn't stand on it's head when this happens.

2018039T02:25:42[MainProcess:140099298334848] Starting new HTTPS connection (1): 127.0.0.1
2018039T02:25:42[MainProcess:140099298334848] Stats: 127.0.0.1:1234 Connection Error? hostname '127.0.0.1' doesn't match u'192.168.192.4'
2018039T02:25:42[MainProcess:140099298334848] Exception on /stats/ [GET]
Traceback (most recent call last):
  File "/usr/lib/python2.7/site-packages/flask/app.py", line 1612, in full_dispatch_request
    rv = self.dispatch_request()
  File "/usr/lib/python2.7/site-packages/flask/app.py", line 1598, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "/usr/lib/python2.7/site-packages/flask_restful/__init__.py", line 477, in wrapper
    resp = resource(*args, **kwargs)
  File "/usr/lib/python2.7/site-packages/flask/views.py", line 84, in view
    return self.dispatch_request(*args, **kwargs)
  File "/usr/lib/python2.7/site-packages/flask_restful/__init__.py", line 587, in dispatch_request
    resp = meth(*args, **kwargs)
  File "/opt/rocknsm/docket/docket/resources/query.py", line 800, in get
    stats = get_stats(selected_sensors=selected)
  File "/opt/rocknsm/docket/docket/tasks.py", line 81, in get_stats
    raise ex
SSLError: hostname '127.0.0.1' doesn't match u'192.168.192.4'

Add Travis-CI build and testing

Travis is a nosey fella...need to add a build & test script so he stops bugging me

Allow re-download of results

The results are kept on the system for a default period of 1 hour. Rather than the current blocking mode we use, we should perform a redirect to a result URI. This would allow us to re-use the existing PCAP vs. rerunning the query every time.

Needs more flushing out how this would best work.

Need to document `/query` API endpoint for `stenoread` compatibility

Docket supports compatibility as a stenoread endpoint, which is useful for aggregating queries. Needs to be added to usage.md

Document the things

Docket needs documentation for users to know what is going on.

Need to implement steno-limit-bytes and steno-limit-packets

These are passed to stenographer as headers but is not yet implemented by docket (other than some infrastructure is in place).

Move default configuration path to `/etc/docket/`

Default configuration should be located at /etc/docket per Fedora packaging guidelines.

nginx-example.conf file missing

The nginx-example.conf file does not seem to exist after installing docket & nginx.

I run the following while installing and get the error below.
sudo cp /usr/share/doc/docket-*/nginx-example.conf
/etc/nginx/conf.d/docket.con

Error:
cp: cannot stat '/usr/share/doc/docket-*/nginx-example.conf': No such file or directory

I navigate to the docket-1.0.3 directory and only find a docs directory that is empty.

Update:
I was able to just find the file under the contrib directory and copy it to where it needs to go. I'm just not sure why it seems to not be packaged with the rpm.

pylint hates my code

Need to do a massive cleanup to make pylint at least a little happier.

Ansible configure stenographer to listen on public interface

Configure stenographer config to listen on public interface instead of
loopback. Also need to punch hole in firewall for docket

Rewrite UI using PatternFly

See https://github.com/patternfly/patternfly-react for the ReactJS components.

Add python packaging information

I'm not 100% sure the best way to handle this, but it feels like docket should use setuptools to create a proper python package. Not sure how that is typically managed for a flask app.

misspelled "execellent" in about docket page

in docket, when you click on about docket, "execellent" is spelled incorrectly in the "about docket" pane

Need to package Python libs

Need the following packaged in RPM (one each):

asn1crypto==0.22.0
billiard==3.5.0.2
celery==4.0.2
certifi==2017.4.17
tonyg-rfc3339==0.1
vine==1.1.3
amqp==2.1.4
kombu==4.0.2
Jinja2==2.9.6
MarkupSafe==1.0
Werkzeug==0.12.2
click==6.7
flask==0.12.2
itsdangerous==0.24

Add ansible prereq checks

• test for pyopenssl on hosts that generate keys
• test for hosts in [stenographer] group
• test for user group for stenographer and nginx