cookbook 'ossec', '~> 3.0.0'
ossec
(31) Versions
3.0.0
-
Follow21
Provides custom resources for managing OSSEC HIDS packages and configuration
cookbook 'ossec', '~> 3.0.0', :supermarket
knife supermarket install ossec
knife supermarket download ossec
ossec cookbook
This cookbook provides custom resources for installing and configuring OSSEC
HIDS from the Atomicorp package archives used by the legacy cookbook.
The package path is constrained by upstream and vendor archive support. Read
[LIMITATIONS.md](LIMITATIONS.md) before expanding platform coverage.
Maintainers
This cookbook is maintained by the Sous Chefs. See
sous-chefs.org.
Requirements
Chef
- Chef Infra Client 15.3+
Supported platforms
- Amazon Linux 2023
- Debian 12 / 13
- Rocky Linux 9
- Ubuntu 22.04 / 24.04
The actual package archive is broader than this list, but the cookbook only
declares currently-supported platforms that align with the documented vendor
support and the maintained Kitchen matrix.
Resources
- [ossec_repository](documentation/ossec_repository.md)
- [ossec_install](documentation/ossec_install.md)
- [ossec_config](documentation/ossec_config.md)
- [ossec_local](documentation/ossec_local.md)
- [ossec_client](documentation/ossec_client.md)
- [ossec_server](documentation/ossec_server.md)
- [ossec_authd](documentation/ossec_authd.md)
- [ossec_agent_auth](documentation/ossec_agent_auth.md)
Data bag
Server and client key distribution uses a data bag item that defaults to
ossec/ssh.
{
"id": "ssh",
"pubkey": "ssh-ed25519 AAAA...",
"privkey": "-----BEGIN OPENSSH PRIVATE KEY-----\n..."
}
If you use encrypted data bags, set encrypted_data_bag true on the resource.
Usage
Local manager
ossec_local 'default'
Agent
ossec_client 'default' do agent_server_ip '192.0.2.10' end
Server
ossec_server 'default'
authd
ossec_authd 'default' do certificate '/var/ossec/etc/sslmanager.cert' key '/var/ossec/etc/sslmanager.key' end
agent-auth registration
ossec_agent_auth 'default' do agent_server_ip '192.0.2.10' end
Configuration
ossec_config, ossec_local, ossec_client, ossec_server, ossec_authd,
and ossec_agent_auth all accept an ossec_conf hash that is rendered to
/var/ossec/etc/ossec.conf via Gyoku.
For server workflows, agent_conf is written to
/var/ossec/etc/shared/agent.conf.
Example:
ossec_server 'default' do ossec_conf( 'global' => { 'email_notification' => true, 'email_to' => 'ossec@example.com', 'smtp_server' => 'smtp.example.com' } ) agent_conf( [ { 'syscheck' => { 'frequency' => 4321 }, 'rootcheck' => { 'disabled' => true } } ] ) end
Testing
berks install cookstyle chef exec rspec --format documentation KITCHEN_LOCAL_YAML=kitchen.dokken.yml kitchen test default-ubuntu-2404 --destroy=always
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Changelog
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Unreleased
- Convert the cookbook to a full custom-resource layout under
resources/ - Remove legacy
recipes/andattributes/content - Modernize supported platforms and align Kitchen and CI with the current matrix
- Add
LIMITATIONS.md, resource documentation, test cookbook recipes, and resource-focused ChefSpec/InSpec coverage
3.0.0 (2026-04-20)
⚠ BREAKING CHANGES
- Migrate to Custom Resources and remove recipes (#194)
Features
Bug Fixes
- ci: Update workflows to use release pipeline (#188) (1cc004a)
- repair release workflow validation (#195) (fb09242)
2.0.18 (2025-10-16)
Bug Fixes
2.0.17 (2025-10-15)
Bug Fixes
2.0.16 - 2025-09-04
Standardise files with files in sous-chefs/repo-management
2.0.14 - 2024-11-18
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
2.0.13 - 2024-07-15
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
Standardise files with files in sous-chefs/repo-management
2.0.8 - 2023-04-07
Standardise files with files in sous-chefs/repo-management
2.0.5 - 2023-04-01
Standardise files with files in sous-chefs/repo-management
2.0.4 - 2023-03-20
Standardise files with files in sous-chefs/repo-management
2.0.3 - 2023-03-15
Standardise files with files in sous-chefs/repo-management
2.0.2 - 2023-02-23
Standardise files with files in sous-chefs/repo-management
2.0.1 - 2023-02-14
Standardise files with files in sous-chefs/repo-management
2.0.0 - 2023-01-12
- Standardise files with files in sous-chefs/repo-management
- Partially modernize cookbook
- Refactor library helper
- Properly set repositories for various supported platforms
- Cleanup and Fix CI
- Add support to various platforms
- Fix idempotency issues
1.2.7 - 2022-02-08
- Standardise files with files in sous-chefs/repo-management
1.2.6 - 2022-02-07
- Remove delivery folder
- Standardise files with files in sous-chefs/repo-management
1.2.5 - 2021-09-08
- resolved cookstyle error: recipes/authd.rb:25:4 refactor:
Chef/Modernize/UseChefLanguageSystemdHelper
1.2.4 - 2021-08-30
- Standardise files with files in sous-chefs/repo-management
1.2.3 - 2021-06-01
- resolved cookstyle error: spec/unit/recipes/agent_spec.rb:5:31 convention:
Style/ExpandPathArguments - resolved cookstyle error: spec/unit/recipes/client_spec.rb:5:31 convention:
Style/ExpandPathArguments - resolved cookstyle error: spec/unit/recipes/server_spec.rb:5:31 convention:
Style/ExpandPathArguments
1.2.2 - 2020-05-14
- resolved cookstyle error: recipes/common.rb:20:35 convention:
Layout/TrailingWhitespace - resolved cookstyle error: recipes/common.rb:20:36 refactor:
ChefModernize/FoodcriticComments - resolved cookstyle error: recipes/common.rb:90:24 convention:
Layout/TrailingWhitespace - resolved cookstyle error: recipes/common.rb:90:25 refactor:
ChefModernize/FoodcriticComments
1.2.1 - 2020-05-05
Added
- Migration to Github Actions
Changed
- Various Cookstyle and foodcritic fixes
- resolved cookstyle error: libraries/helpers.rb:31:18 convention:
Style/HashEachMethods
Deprecated
Removed
[1.2.0] - 2019-05-13
Added
- Add distro based authd service name
Changed
Deprecated
Removed
[1.1.0] - 2018-08-13
- README Updates:
- Fix broken links
- Add reference to Wazzuh
- General updates to cookbook
- Remove EOL distros
- Update for current supported Chef version (13)
[1.0.5] - 2014-04-15
- Avoid node.save to prevent incomplete attribute collections
-
dist-ossec-keys.shshould be sorted for idempotency - Ability to disable ossec configuration template
- Support for encrypted databags
- Support for environment-scoped searches
- Support for multiple email_to addresses
[1.0.4] - 2013-05-14
- [COOK-2740]: Use FQDN for a client name
- [COOK-2739]: Upgrade OSSEC to version 2.7
[1.0.2] - 2012-07-01
- [COOK-1394] - update ossec to version 2.6
1.0.0
- Initial/current release
Collaborator Number Metric
3.0.0 passed this metric
Contributing File Metric
3.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
3.0.0 passed this metric
No Binaries Metric
3.0.0 passed this metric
Testing File Metric
3.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
3.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
3.0.0 passed this metric
3.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
3.0.0 passed this metric
No Binaries Metric
3.0.0 passed this metric
Testing File Metric
3.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
3.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
3.0.0 passed this metric
3.0.0 passed this metric
Testing File Metric
3.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
3.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
3.0.0 failed this metric
3.0.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number