Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x
- Puppet >= 6.1.0 < 8.0.0
- , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'ploperations-classification', '2.0.0'
Learn more about managing modules with a PuppetfileDocumentation
classification
The classification module is used internally at Puppet to do two key things:
- create facts based on a node's host and domain name
- verify that the facts provided during a puppet run match the values parsed from the node's cert
This helps prevent attacks via fact overrides.
Note: Incorrect facts can still be associated with a node, since facts are sent before compilation.
Description
Unless you have a naming convention that exactly matches what we are using this module will not work out of the box for you. It is provided here in hopes that the underlying ideas will be useful in your own works.
Setup
What classification affects
Classification is intended to be included on all nodes via site.pp
Setup Requirements
Stdlib is required for this module to work.
Beginning with classification
include classification
Usage
facter -p classification
Reference
This module is documented via
pdk bundle exec puppet strings generate --format markdown
.
Please see REFERENCE.md for more info.
Changelog
CHANGELOG.md is generated prior to each release via
pdk bundle exec rake changelog
. This process relies on labels that are applied
to each pull request.
Reference
Table of Contents
Classes
classification
: Determine group, function, etc. for classification based on certname.
Functions
classification::parse_cert_info
: Parse the cert name to determine what values to compare against.classification::parse_hostname
: Parse a hostname into a hash of its parts.classification::split_hostname
: Split a hostname into its consituent parts.classification::test_fact_difference_array
: If the list of differences has any values fail the run and list the issues.classification::validate_facts
: Validate a hash of facts against trusted values calculated from the certname.
Classes
classification
Determine group, function, etc. for classification based on certname. This verifies that untrusted facts match the trusted values found here to prevent attacks via fact overrides. Note that incorrect facts can still be associated with a node since facts are sent before compilation.
This uses the same underlying code as the classification fact:
lib/ploperations/classification.rb
Examples
Automatically include on every node
# in site.pp:
include classification
Functions
classification::parse_cert_info
Type: Puppet Language
Parse the cert name to determine what values to compare against.
Examples
classification::parse_cert_info($trusted['certname'])
classification::parse_cert_info(String $trusted_cert_name)
Parse the cert name to determine what values to compare against.
Returns: Hash
Returns a hash containing certname, cert_hostname, and cert_domain.
Examples
classification::parse_cert_info($trusted['certname'])
trusted_cert_name
Data type: String
The value of $trusted['certname'] to be parsed
classification::parse_hostname
Type: Ruby 4.x API
Parse a hostname into a hash of its parts
Examples
{
hostname => $hostname,
parts => [$group, $function, $number_string, $context, $stage, $id],
group => $group,
function => $function,
number => $number_as_int,
number_string => $number_string,
context => $context,
stage => $stage,
id => $id,
}
classification::parse_hostname(String $hostname_string)
Parse a hostname into a hash of its parts
Returns: Hash
Some or all the values may be nil.
Examples
{
hostname => $hostname,
parts => [$group, $function, $number_string, $context, $stage, $id],
group => $group,
function => $function,
number => $number_as_int,
number_string => $number_string,
context => $context,
stage => $stage,
id => $id,
}
hostname_string
Data type: String
A hostname to parse
classification::split_hostname
Type: Ruby 4.x API
Split a hostname into its consituent parts
Examples
[ $group, $function, $number_string, $context, $stage, $id ]
classification::split_hostname(String $hostname_string)
Split a hostname into its consituent parts
Returns: Array
Returns a 6 element array. Some or all the elements may be nil.
Examples
[ $group, $function, $number_string, $context, $stage, $id ]
hostname_string
Data type: String
A hostname to parse
classification::test_fact_difference_array
Type: Puppet Language
If the list of differences has any values fail the run and list the issues.
Examples
$fact_differences = $root_level_fact_differences + $classification_fact_differences
classification::test_fact_difference_array($fact_differences)
classification::test_fact_difference_array(Array $fact_differences)
If the list of differences has any values fail the run and list the issues.
Returns: Boolean
Examples
$fact_differences = $root_level_fact_differences + $classification_fact_differences
classification::test_fact_difference_array($fact_differences)
fact_differences
Data type: Array
An array of strings.
These strings are generated by classification::validate_facts
classification::validate_facts
Type: Puppet Language
Validate a hash of facts against trusted values calculated from the certname.
Examples
$classification_calculated_trusted = $parsed_classification + {
hostname => $hostname,
}
$classification_facts_to_validate = [
'hostname',
'version',
'group',
'function',
'number',
'number_string',
'context',
'stage',
]
$classification_fact_differences = classification::validate_facts(
$facts['classification'],
$classification_calculated_trusted,
$classification_facts_to_validate,
)
classification::validate_facts(Hash $untrusted_facts, Hash $calculated_facts, Array $fact_names)
Validate a hash of facts against trusted values calculated from the certname.
Returns: Array
An array of strings documenting any facts that don't match their trusted values
Examples
$classification_calculated_trusted = $parsed_classification + {
hostname => $hostname,
}
$classification_facts_to_validate = [
'hostname',
'version',
'group',
'function',
'number',
'number_string',
'context',
'stage',
]
$classification_fact_differences = classification::validate_facts(
$facts['classification'],
$classification_calculated_trusted,
$classification_facts_to_validate,
)
untrusted_facts
Data type: Hash
A hash of untrusted facts
calculated_facts
Data type: Hash
A hash of trusted facts
fact_names
Data type: Array
An array of fact names to validate
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
2.0.0 (2021-09-18)
Changed
Added
- allow digits in function #19 (suckatrash)
1.0.0 (2019-08-02)
0.2.0 (2019-02-08)
Added
Fixed
- Fixing cert validation, update docs #10 (genebean)
- letter-only hostnames shouldn't populate group #8 (genebean)
- Params were reversed from the way it is documented (oops) #7 (genebean)
- We shouldn't be validating parts or id based #2 (genebean)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/stdlib (>= 5.0.0 < 7.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.