diff options
| -rw-r--r-- | .github/workflows/L10n-update.yml | 20 | ||||
| -rw-r--r-- | .github/workflows/php.yml | 47 | ||||
| -rw-r--r-- | .gitignore | 5 | ||||
| -rw-r--r-- | .phpcs.xml | 27 | ||||
| -rw-r--r-- | LICENSE | 339 | ||||
| -rw-r--r-- | README.md | 87 | ||||
| -rw-r--r-- | application/controllers/ConfigController.php | 23 | ||||
| -rw-r--r-- | application/controllers/LogController.php | 51 | ||||
| -rw-r--r-- | application/forms/Config/AuditLogConfigForm.php | 93 | ||||
| -rw-r--r-- | application/views/scripts/config/index.phtml | 6 | ||||
| -rw-r--r-- | application/views/scripts/log/index.phtml | 33 | ||||
| -rw-r--r-- | application/views/scripts/log/log-empty.phtml | 8 | ||||
| -rw-r--r-- | configuration.php | 26 | ||||
| -rw-r--r-- | library/Audit/ProvidedHook/AuditLog.php | 70 | ||||
| -rw-r--r-- | library/Audit/ProvidedHook/AuditStream.php | 38 | ||||
| -rw-r--r-- | module.info | 4 | ||||
| -rw-r--r-- | run.php | 8 |
17 files changed, 885 insertions, 0 deletions
diff --git a/.github/workflows/L10n-update.yml b/.github/workflows/L10n-update.yml new file mode 100644 index 0000000..9dce59a --- /dev/null +++ b/.github/workflows/L10n-update.yml @@ -0,0 +1,20 @@ +name: L10n Update + +on: + push: + branches: + - master + +jobs: + trigger-update: + name: L10n Update Trigger + runs-on: ubuntu-latest + + steps: + - name: Repository dispatch + uses: peter-evans/repository-dispatch@v1 + with: + token: ${{ secrets.ICINGABOT_TOKEN }} + repository: Icinga/L10n + event-type: update + client-payload: '{"origin": "${{ github.repository }}", "commit": "${{ github.sha }}"}' diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml new file mode 100644 index 0000000..e26a429 --- /dev/null +++ b/.github/workflows/php.yml @@ -0,0 +1,47 @@ +name: PHP Tests + +on: + push: + branches: + - master + - release/* + pull_request: + branches: + - master + +jobs: + lint: + name: Static analysis for php ${{ matrix.php }} on ${{ matrix.os }} + runs-on: ${{ matrix.os }} + + strategy: + fail-fast: false + matrix: + php: ['5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0'] + os: ['ubuntu-latest'] + include: + - php: '5.6' + allow_failure: true + - php: '7.0' + allow_failure: true + + steps: + - name: Checkout code base + uses: actions/checkout@v2 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + tools: phpcs + + - name: Setup dependencies + run: composer require -n --no-progress overtrue/phplint + + - name: PHP Lint + if: success() || matrix.allow_failure + run: ./vendor/bin/phplint -n --exclude={^vendor/.*} -- . + + - name: PHP CodeSniffer + if: success() || matrix.allow_failure + run: phpcs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1f03d4b --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Exclude all hidden files +.* + +# Except those related to Git +!.git* diff --git a/.phpcs.xml b/.phpcs.xml new file mode 100644 index 0000000..2aec461 --- /dev/null +++ b/.phpcs.xml @@ -0,0 +1,27 @@ +<?xml version="1.0"?> +<ruleset name="PHP_CodeSniffer"> + <description>Sniff our code a while</description> + + <file>./</file> + + <exclude-pattern>vendor/*</exclude-pattern> + + <arg value="wps"/> + <arg name="report-width" value="auto"/> + <arg name="report-full"/> + <arg name="report-gitblame"/> + <arg name="report-summary"/> + <arg name="encoding" value="UTF-8"/> + <arg name="extensions" value="php"/> + + <rule ref="PSR12"> + <exclude name="PSR12.Properties.ConstantVisibility.NotFound"/> + </rule> + + <rule ref="Generic.Files.LineLength"> + <properties> + <property name="lineLimit" value="120"/> + <property name="absoluteLineLimit" value="0"/> + </properties> + </rule> +</ruleset> @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e53e8b9 --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +# Audit module for Icinga Web 2 + +#### Table of Contents + +1. [About](#about) +2. [License](#license) +3. [Support](#support) +4. [Requirements](#requirements) +5. [Installation](#installation) +6. [Configuration](#configuration) + +## About + +## License + +Icinga Web 2 and this Icinga Web 2 module are licensed under the terms of the GNU General Public License Version 2, +you will find a copy of this license in the LICENSE file included in the source package. + +## Support + +Join the [Icinga community channels](https://www.icinga.com/community/get-involved/) for questions. + +## Requirements + +* [Icinga Web 2](https://www.icinga.com/products/icinga-web-2/) (>= 2.6.0) + +## Installation + +Extract this module to your Icinga Web 2 modules directory as `audit` directory. + +Git clone: + + cd /usr/share/icingaweb2/modules + git clone https://github.com/Icinga/icingaweb2-module-audit.git audit + +Tarball download (latest [release](https://github.com/Icinga/icingaweb2-module-audit/releases/latest)): + + cd /usr/share/icingaweb2/modules + wget https://github.com/Icinga/icingaweb2-module-audit/archive/v1.0.0.zip + unzip v1.0.0.zip + mv icingaweb2-module-audit-1.0.0 audit + +### Enable Icinga Web 2 module + +Enable the module in the Icinga Web 2 frontend in `Configuration -> Modules -> audit -> enable`. +You can also enable the module by using the `icingacli` command: + + icingacli module enable audit + +## Configuration + +By default the audit module does not log anything. Its logging facilities need to be configured first. + +There are currently two choices: + +* Standard Log +* JSON Log + +### Standard Log + +The standard log is a normal log with human readable messages. It's possible to log to a file and to syslog. +The configuration view in the frontend is located here: `Configuration -> Modules -> audit -> Configuration` + +> **Note** +> +> When logging to a file and with the proper permission, this can be viewed in the frontend under `Reporting -> Audit Log` + +### JSON Log + +The JSON log is supposed to be consumed by other applications. It writes one JSON object per line to a file. + +These objects have the following properties: + +* `activity_time` + A unix timestamp specifying when the activity occurred. +* `activity` + An arbitrary identifier specifying the type of activity. +* `identity` + An arbitrary name identifying the responsible subject. +* `message` + A human readable message. This is the same that appears in the standard log. +* `data` *(may be absent)* + An arbitrary number of additional properties dependent on the type of activity. + +Please see the documentation of the type of activity for more details. ([Icinga Web 2 activities](https://www.icinga.com/docs/icingaweb2/latest/doc/15-Auditing/)) + +An example for *Filebeat* how this log may be consumed can be found [here](https://www.elastic.co/blog/structured-logging-filebeat). diff --git a/application/controllers/ConfigController.php b/application/controllers/ConfigController.php new file mode 100644 index 0000000..5e6a31a --- /dev/null +++ b/application/controllers/ConfigController.php @@ -0,0 +1,23 @@ +<?php + +/* Icinga Web 2 | (c) 2018 Icinga Development Team | GPLv2+ */ + +namespace Icinga\Module\Audit\Controllers; + +use Icinga\Web\Controller; +use Icinga\Module\Audit\Forms\Config\AuditLogConfigForm; + +class ConfigController extends Controller +{ + public function indexAction() + { + $form = new AuditLogConfigForm(); + $form->setIniConfig($this->Config()); + $form->setSubmitLabel($this->translate('Save Configuration')); + + $form->handleRequest(); + + $this->view->form = $form; + $this->view->tabs = $this->Module()->getConfigTabs()->activate('config'); + } +} diff --git a/application/controllers/LogController.php b/application/controllers/LogController.php new file mode 100644 index 0000000..fc5e17c --- /dev/null +++ b/application/controllers/LogController.php @@ -0,0 +1,51 @@ +<?php + +/* Icinga Web 2 | (c) 2018 Icinga Development Team | GPLv2+ */ + +namespace Icinga\Module\Audit\Controllers; + +use Icinga\Data\ConfigObject; +use Icinga\Protocol\File\FileReader; +use Icinga\Web\Controller; + +class LogController extends Controller +{ + public function indexAction() + { + $this->assertPermission('audit/log'); + + if ($this->Config()->get('log', 'type') !== 'file') { + $this->httpNotFound('Page not found'); + } + + $this->getTabs()->add('audit/log', [ + 'active' => true, + 'label' => $this->translate('Audit Log'), + 'url' => 'audit/log', + ]); + + $file = $this->Config()->get('log', 'path', '/var/log/icingaweb2/audit.log'); + + if (! @file_exists($file)) { + $this->render('log-empty'); + + return; + } + + $resource = new FileReader(new ConfigObject([ + 'filename' => $file, + 'fields' => '/(?<!.)' // ^ can't handle multilines, don't ask *me* why this works + . '(?<datetime>[0-9]{4}(?:-[0-9]{2}){2}' // date + . 'T[0-9]{2}(?::[0-9]{2}){2}(?:[\+\-][0-9]{2}:[0-9]{2})?)' // time + . ' - (?<identity>.+)' // identity + . ' - (?<type>.+)' // type + . ' - (?<message>.+)' // message + . '(?!.)/msSU' // $ can't handle multilines, don't ... + ])); + + $this->view->logData = $resource->select()->order('DESC'); + + $this->setupLimitControl(); + $this->setupPaginationControl($this->view->logData); + } +} diff --git a/application/forms/Config/AuditLogConfigForm.php b/application/forms/Config/AuditLogConfigForm.php new file mode 100644 index 0000000..6e93b5a --- /dev/null +++ b/application/forms/Config/AuditLogConfigForm.php @@ -0,0 +1,93 @@ +<?php + +/* Icinga Web 2 | (c) 2018 Icinga Development Team | GPLv2+ */ + +namespace Icinga\Module\Audit\Forms\Config; + +use Icinga\Forms\ConfigForm; + +class AuditLogConfigForm extends ConfigForm +{ + public function createElements(array $formData) + { + $this->addElement( + 'select', + 'log_type', + [ + 'autosubmit' => true, + 'label' => $this->translate('Standard Log'), + 'description' => $this->translate('Human-readable message log'), + 'multiOptions' => [ + 'none' => $this->translate('None', 'log.type'), + 'file' => $this->translate('File'), + 'syslog' => 'Syslog' + ] + ] + ); + if (isset($formData['log_type']) && $formData['log_type'] === 'file') { + $this->addElement( + 'text', + 'log_path', + [ + 'label' => $this->translate('Standard Log Path'), + 'description' => $this->translate('The full path to the standard log'), + 'placeholder' => '/var/log/icingaweb2/audit.log' + ] + ); + } elseif (isset($formData['log_type']) && $formData['log_type'] === 'syslog') { + $this->addElement( + 'text', + 'log_ident', + [ + 'label' => $this->translate('Ident'), + 'description' => $this->translate('The identifier to use for syslog messages'), + 'placeholder' => 'icingaweb2-audit' + ] + ); + $this->addElement( + 'select', + 'log_facility', + [ + 'label' => $this->translate('Facility'), + 'description' => $this->translate('The facility to send syslog messages to'), + 'multiOptions' => [ + '' => 'auth', // The default + 'authpriv' => 'authpriv', + 'user' => 'user', + 'local0' => 'local0', + 'local1' => 'local1', + 'local2' => 'local2', + 'local3' => 'local3', + 'local4' => 'local4', + 'local5' => 'local5', + 'local6' => 'local6', + 'local7' => 'local7' + ] + ] + ); + } + + $this->addElement( + 'checkbox', + 'stream_format', + [ + 'autosubmit' => true, + 'label' => $this->translate('JSON Log'), + 'description' => $this->translate('Machine-parsable JSON objects'), + 'checkedValue' => 'json', + 'uncheckedValue' => 'none' + ] + ); + if (isset($formData['stream_format']) && $formData['stream_format'] === 'json') { + $this->addElement( + 'text', + 'stream_path', + [ + 'label' => $this->translate('JSON Log Path'), + 'description' => $this->translate('The full path to the JSON log'), + 'placeholder' => '/var/log/icingaweb2/audit.json' + ] + ); + } + } +} diff --git a/application/views/scripts/config/index.phtml b/application/views/scripts/config/index.phtml new file mode 100644 index 0000000..71f2a34 --- /dev/null +++ b/application/views/scripts/config/index.phtml @@ -0,0 +1,6 @@ +<div class="controls"> + <?= $this->tabs ?> +</div> +<div class="content"> + <?= $this->form ?> +</div> diff --git a/application/views/scripts/log/index.phtml b/application/views/scripts/log/index.phtml new file mode 100644 index 0000000..79b9239 --- /dev/null +++ b/application/views/scripts/log/index.phtml @@ -0,0 +1,33 @@ +<?php if (! $this->compact): ?> +<div class="controls separated"> + <?= $this->tabs ?> + <?= $this->paginator ?> + <div class="sort-controls-container"> + <?= $this->limiter ?> + </div> +</div> +<?php endif ?> +<div class="content"> +<?php if ($this->logData !== null): ?> + <table class="action"> + <tbody> + <?php foreach ($this->logData as $value): ?> + <?php $datetime = new Datetime($value->datetime) ?> + <tr class="state"> + <td style="width: 6em; text-align: center"> + <?= $this->escape($datetime->format('d.m. H:i')) ?> + <br> + <?= $this->escape($value->type) ?> + </td> + <td style="width: 12em; text-align: center"> + <?= $this->escape($value->identity) ?> + </td> + <td> + <?= nl2br($this->escape($value->message), false) ?> + </td> + </tr> + <?php endforeach ?> + </tbody> + </table> +<?php endif ?> +</div> diff --git a/application/views/scripts/log/log-empty.phtml b/application/views/scripts/log/log-empty.phtml new file mode 100644 index 0000000..901e6c4 --- /dev/null +++ b/application/views/scripts/log/log-empty.phtml @@ -0,0 +1,8 @@ +<?php if (! $this->compact): ?> +<div class="controls"> + <?= $this->tabs ?> +</div> +<?php endif ?> +<div class="content"> + <p><?= $this->escape($this->translate('No activity has been recorded yet.')) ?></p> +</div> diff --git a/configuration.php b/configuration.php new file mode 100644 index 0000000..46ecf5c --- /dev/null +++ b/configuration.php @@ -0,0 +1,26 @@ +<?php + +/* Icinga Web 2 | (c) 2018 Icinga Development Team | GPLv2+ */ + +/** @var $this \Icinga\Application\Modules\Module */ + +$this->provideConfigTab('config', [ + 'url' => 'config', + 'title' => $this->translate('Configuration') +]); + +$this->providePermission('audit/log', $this->translate('Allow access to the audit log')); + +try { + if ($this->getConfig()->get('log', 'type') === 'file') { + $section = $this->menuSection(N_('Reporting')); + $section->add(N_('Audit Log'), [ + 'permission' => 'audit/log', + 'url' => 'audit/log', + 'icon' => 'eye', + 'priority' => 910 + ]); + } +} catch (Exception $e) { + // This pops up again sooner or later anyway.. +} diff --git a/library/Audit/ProvidedHook/AuditLog.php b/library/Audit/ProvidedHook/AuditLog.php new file mode 100644 index 0000000..a03502e --- /dev/null +++ b/library/Audit/ProvidedHook/AuditLog.php @@ -0,0 +1,70 @@ +<?php + +/* Icinga Web 2 | (c) 2018 Icinga Development Team | GPLv2+ */ + +namespace Icinga\Module\Audit\ProvidedHook; + +use InvalidArgumentException; +use Icinga\Application\Config; +use Icinga\Application\Hook\AuditHook; +use Icinga\Util\File; + +class AuditLog extends AuditHook +{ + public function logMessage($time, $identity, $type, $message, array $data = null) + { + $logConfig = Config::module('audit')->getSection('log'); + if ($logConfig->type === 'file') { + $file = new File($logConfig->get('path', '/var/log/icingaweb2/audit.log'), 'a'); + $file->fwrite(date('c', $time) . ' - ' . $identity . ' - ' . $type . ' - ' . $message . PHP_EOL); + $file->fflush(); + } elseif ($logConfig->type === 'syslog') { + openlog( + $logConfig->get('ident', 'icingaweb2-audit'), + LOG_PID, + $this->resolveSyslogFacility($logConfig->get('facility', 'auth')) + ); + $date = date('c', $time); + syslog(LOG_INFO, "[$date] <$identity> <$type> $message"); + } + } + + /** + * Resolve the given syslog facility name to a valid identifier + * + * @param string $name + * + * @return int + * + * @throws InvalidArgumentException In case of an unknown name + */ + protected function resolveSyslogFacility($name) + { + switch ($name) { + case 'auth': + return LOG_AUTH; + case 'authpriv': + return LOG_AUTHPRIV; + case 'user': + return LOG_USER; + case 'local0': + return LOG_LOCAL0; + case 'local1': + return LOG_LOCAL1; + case 'local2': + return LOG_LOCAL2; + case 'local3': + return LOG_LOCAL3; + case 'local4': + return LOG_LOCAL4; + case 'local5': + return LOG_LOCAL5; + case 'local6': + return LOG_LOCAL6; + case 'local7': + return LOG_LOCAL7; + default: + throw new InvalidArgumentException("Unknown syslog facility '$name'"); + } + } +} diff --git a/library/Audit/ProvidedHook/AuditStream.php b/library/Audit/ProvidedHook/AuditStream.php new file mode 100644 index 0000000..b47968d --- /dev/null +++ b/library/Audit/ProvidedHook/AuditStream.php @@ -0,0 +1,38 @@ +<?php + +/* Icinga Web 2 | (c) 2018 Icinga Development Team | GPLv2+ */ + +namespace Icinga\Module\Audit\ProvidedHook; + +use InvalidArgumentException; +use Icinga\Application\Config; +use Icinga\Application\Hook\AuditHook; +use Icinga\Util\File; + +class AuditStream extends AuditHook +{ + public function logMessage($time, $identity, $type, $message, array $data = null) + { + $activityData = [ + 'activity_time' => $time, + 'activity' => $type, + 'message' => $message, + 'identity' => $identity + ]; + if (! empty($data)) { + $activityData['data'] = $data; + } + + $logConfig = Config::module('audit')->getSection('stream'); + if ($logConfig->format === 'json') { + $json = json_encode($activityData, JSON_FORCE_OBJECT); + if ($json === false) { + throw new InvalidArgumentException('Failed to encode message data to JSON: ' . json_last_error_msg()); + } + + $file = new File($logConfig->get('path', '/var/log/icingaweb2/audit.json'), 'a'); + $file->fwrite($json . PHP_EOL); + $file->fflush(); + } + } +} diff --git a/module.info b/module.info new file mode 100644 index 0000000..88f5534 --- /dev/null +++ b/module.info @@ -0,0 +1,4 @@ +Module: audit +Version: 1.0.2 +Description: Audit Module + The Audit module provides support to log and view activities to audit. @@ -0,0 +1,8 @@ +<?php + +/* Icinga Web 2 | (c) 2018 Icinga Development Team | GPLv2+ */ + +/** @var $this \Icinga\Application\Modules\Module */ + +$this->provideHook('audit', 'AuditLog', true); +$this->provideHook('audit', 'AuditStream', true); |