Thread Info
  • State Not Answered
  • Locked Locked
  • Replies 4 replies
  • Subscribers 3 subscribers
  • Views 4260 views
  • Users 0 members are here
Options
Suggested
This discussion has been locked.
You can no longer post new replies to this discussion. If you have a question you can start a new discussion

Best practice for documentation

IngoPohlschneider
Hello everyone,
I am wondering how you guys do the documentation for your UTMs.

I started doing it using Sharepoint sites and lists but I'd like to do it in some kind of automated way

How do you guys do it?
Any best practice I should know of?

Is there a way to read the config automatically? I would also like to be able to see deltas/changes.

PS: I know that there is the "printable configuration" but I think it is not a very good option and not that well parseable.

Best regards
chas0rde


This thread was automatically locked due to age.
  • 0
    Hi,

    The config files are not human readable, but there is a list of changes in webadmin.

    Currently, I do the following:
    1. keep email records of all requested firewall rule changes

    2. make sure everything in the firewall is well described & commented

    3. create network flow diagrams (see the PCI DSS docs for some basic examples)

    4. keep traditional network diagrams, with comments and supporting docs as needed

    5. use wikis and/or shared folders for documents/diagrams. make sure they don't contain any keys or passwords unless the files themselves are protected with strong encryption, and restrict access.

    One of my gripes is that #2 is impossible on the IPS Advanced rule management settings; you cannot put any comments on modified rules.
    I've got a feature request for improving this.

    I'm currently starting to work with SUM for a migration from 7.5 to 9.1, but afaict, it doesn't really help much with any of this.

    Barry
  • 0
    Hello
    I too use SUM. Mainly for S2S-Tunnel deployment, to keep definitions globally unique and manage Webfiltering policy globally.

    Good commenting in the objects (where possible) helps a lot but I think it gets a bit cluttered in the comment once you start to put internal contacts (who requested certain rules...) and such into the comment.

    Is there a length-limit in the comment-field? On the webgui it seems as if not (or a big one). At least 1200 letters could be typed into the field. 
    Nevertheless it clutters the UI

    In my personal opinion documentation first is not the worst approach for critical systems like firewalls, but my boss thinks automatic (documentation-last) approach is better. 
    I am sure he is right if you think of people not doing a perfectly good job on documenting stuff they do. But I think that those people should rather be kicked of firewall-admin instead of doing a "automatically reading config and changes from UTM and later on see who caused the security breach"-approach

    Is there any possibility to read config information from the CLI / psql-DB (w/o harming support)?

    Best regards
  • 0
    Hi, 
    re CLI: you can dump the iptables rules safely...
    sudo iptables -n -L

    'L' is for list, 'n' is for numeric (IPs instead of looking up the IPs and showing the DNS names).

    The backup files contains the pgSQL data, but I'm not sure how to read it. Other sane options might be to copy the db off and load it in another system, but I doubt it'd be very readable; probably well normalized and full of REFs (like the "printable" configuration).

    Barry
  • 0
    You can use the "printable configuration" for your documentation.
    At the bottom of the page, you can see, this
    printable_config.jpg

    The links in this document connect you to your utm https://utm.domain.com:4444/???, but in this document, there are all detailed information. safe this in .mht format and you can edit this document in word (and erase the hyperlinks for example).

    Nice greetings