Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add man pages for rpm2archive and various plugins #1021

Merged
merged 2 commits into from Jan 30, 2020

Conversation

ffesti
Copy link
Contributor

@ffesti ffesti commented Jan 29, 2020

No description provided.

doc/rpm2archive.8 Outdated Show resolved Hide resolved

It can be disabled permanantly by commenting out the
\fI%__transaction_audit\fR macro in main macros file
(typically located at \fI/usr/lib/rpm/macros\fR) or otherwise change
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of things that go for all the plugin manuals:
Editing the main macros file is not good advice as that's supposed to represent the factory configuration and any subsequent updates will overwrite the changes. The right way to disable these is to redefine the macro to %{nil} in a /etc/rpm/macros.* file. It could also mention --noplugins as a means to temporarily disable all plugins.

As for audit, while we're actually documenting this stuff (whee!), lets also document how to actually find the events:
ausearch -m SOFTWARE_UPDATE and if we really get wild, the attatched properties.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a separate rpm-plugins man page that explains all this to avoid copying the same block all over again and again.

rpm-plugin-audit is now a bit more helpful but can probably still be extended.

Copy link
Member

@pmatilai pmatilai Jan 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, if you want to elaborate on the actual messages, here are brief descriptions of the fields:

Field Possible values Description
op install/update/remove package operation
sw <software label> name-version-release.arch of the package
key_enforce 0/1 are signatures being enforced
gpg_res 0/1 result of signature check (0 == fail / 1 == success)
root_dir <root directory path> Root directory of the operation, normally "/"
sw_type rpm package format

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, formatting this was as complicated as I expected...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I didn't really mean putting that table literally in the manual, just presenting it here in that format seemed to make sense.

@pmatilai
Copy link
Member

Oh and BTW, I don't see any benefit from adding these in separate commits. Might just as well merge all into one big "add manuals for xxx, yyy..." commit.

@ffesti
Copy link
Contributor Author

ffesti commented Jan 29, 2020

I kept the changes to the plugin man pages as a separate patch to make them easier to review. Will squash them before them getting merged.

doc/rpm-plugin-syslog.8 Outdated Show resolved Hide resolved
@pmatilai
Copy link
Member

Other than those 1-2 items, looks good to me now.

* rpm-plugins for plugins in general
* selinux plugin
* syslog plugin
* audit plugin
* prioreset plugin
* ima plugin
@pmatilai
Copy link
Member

Okay, works for me.

@pmatilai pmatilai merged commit daec7a9 into rpm-software-management:master Jan 30, 2020
@ffesti ffesti deleted the 1016 branch January 31, 2020 13:54
@rpm-maint
Copy link

rpm-maint commented Mar 30, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants