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, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.7.0 < 8.0.0
Start using this module
Add this module to your Puppetfile:
mod 'gerardkok-ejbca', '0.3.0'
Learn more about managing modules with a PuppetfileDocumentation
ejbca
Table of Contents
- Description
- Setup - The basics of getting started with ejbca
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
Description
This module installs. configures, and (partly) manages an EJBCA installation. EJBCA is an open-source Certificate Authority.
The module manages both the installation and configuration EJBCA, and provides a custom type that allows for managing end entities, using the SOAP API.
Setup
What ejbca affects
EJBCA runs on a JEE5 compliant Java application server (see https://www.ejbca.org/docs/Application_Servers.html). This module uses the biemond/wildfly module, which limits the choice to JBoss or Wildfly.
EJBCA stores its data in a database (see the file conf/database.properties.sample
from the distribution for a list). This module can handle installation of the database driver, but does not manage the database.
Setup Requirements
Previous versions of EJBCA required an instance with 2 CPUs. I can't find that requirement anymore, so I'm not sure it still holds. However, if you're having trouble installing EJBCA using this module, consider trying installing it on a bigger instances, with (at least) 2 CPUs.
A Java version that's compatible with EJBCA's version has to be installed before EJBCA can be installed.
Beginning with ejbca
Minimal usage:
include ejbca
This installs the current open-source version of EJBCA with the default configuration:
- database: H2
- organization: 'EJBCA Sample'
- country: 'SE'
Usage
This module does not manage the database.
Reference
See REFERENCE.
Limitations
In general, if you want to change a setting, it's best to start over entirely. Also, this module does not support automatic upgrading from one database to another, or from one application server to another, or to a newer version of EJBCA.
This module had only been tested on Ubuntu 16.04 and 18.04.
Reference
Table of Contents
Classes
ejbca
: Installs and configures EJBCAejbca::api_config
: Configure access to the EJBCA APIejbca::config
: Configure EJBCAejbca::install
: Install EJBCAejbca::wildfly::config
: Configure Wildflyejbca::wildfly::install
: Install Wildfly
Defined types
ejbca::wildfly::interface
: Create a Wildfly interface and socket-binding
Resource types
ejbca_end_entity
: Username
Functions
Data types
Classes
ejbca
Installs and configures EJBCA
Examples
Minimal usage
include ejbca
Parameters
The following parameters are available in the ejbca
class:
wildfly_version
user
group
home
ejbca_source
ejbca_basename
ejbca_install_dir
database_driver
database_driver_params
db
db_user
db_password
database_url
keystore_password
organization
country
superadmin_cn
superadmin_password
api_client_cert_filename
api_client_cert_path
api_client_cert_password
vhost_name
java_home
java_xms
java_xmx
java_opts
add_datasource
wildfly_reload_retries
wildfly_reload_wait
wildfly_version
Data type: String
The version of Wildfly to use.
Default value: '10.1.0'
user
Data type: String
The user Wildfly runs as.
Default value: 'ejbca'
group
Data type: String
The group Wildfly runs as.
Default value: 'ejbca'
home
Data type: Stdlib::Absolutepath
The home directory of user, as an absolute path.
Default value: "/home/${user}"
ejbca_source
Data type: Stdlib::Httpurl
The url to download the EJBCA source from.
Default value: 'https://sourceforge.net/projects/ejbca/files/ejbca6/ejbca_6_15_2_6/ejbca_ce_6_15_2_6.zip'
ejbca_basename
Data type: String
The basename of the source, without extension
Default value: basename($ejbca_source, '.zip')
ejbca_install_dir
Data type: Stdlib::Absolutepath
The absolute path to the directory the EJBCA source is unpacked to.
Default value: "${home}/${ejbca_basename}"
database_driver
Data type: Ejbca::Database_driver
The name of the database driver EJBCA will use.
Default value: 'h2'
database_driver_params
Data type: Ejbca::Database_driver_params
The parameters required to add the database driver to Wildfly, as a hash.
Default value: ejbca::database_driver_params($database_driver)
db
Data type: String
The name of the EJBCA database.
Default value: 'ejbca'
db_user
Data type: String
The database user to access the EJBCA db.
Default value: 'ejbca'
db_password
Data type: String
The password for the database user.
Default value: 'ejbca'
database_url
Data type: String
The url to access the EJBCA database.
Default value: ejbca::database_url($database_driver, $db)
keystore_password
Data type: String
The password protecting the Java keystore.
Default value: 'serverpwd'
organization
Data type: String
Your organization.
Default value: 'EJBCA Sample'
country
Data type: String
Your country.
Default value: 'SE'
superadmin_cn
Data type: String
CN of the EJBCA SuperAdmin end entity.
Default value: 'SuperAdmin'
superadmin_password
Data type: String
Password for the EJBCA SuperAdmin end entity.
Default value: 'ejbca'
api_client_cert_filename
Data type: String
The filename of the certificate that grants access to the EJBCA API.
Default value: downcase($superadmin_cn)
api_client_cert_path
Data type: Stdlib::Absolutepath
Absolute path to a certificate that grants access to the EJBCA API.
Default value: "${ejbca_install_dir}/p12/${api_client_cert_filename}.p12"
api_client_cert_password
Data type: String
Password protecting the certificate that grants access to the EJBCA API.
Default value: 'ejbca'
vhost_name
Data type: Stdlib::Fqdn
Name of the virtual host that EJBCA will use.
Default value: $facts['fqdn']
java_home
Data type: Stdlib::Absolutepath
Absolute path to JAVA_HOME
Default value: '/usr/lib/jvm/java-8-openjdk-amd64'
java_xms
Data type: String
Value of the -Xms Java parameter
Default value: '2048m'
java_xmx
Data type: String
Value of the -Xmx Java parameter
Default value: '2048m'
java_opts
Data type: String
Additional options to use with Java.
Default value: '-Djava.net.preferIPv4Stack=true'
add_datasource
Data type: Boolean
Whether to add the EjbcaDS datasource
Default value: false
wildfly_reload_retries
Data type: Integer
The number of retries to check if wildfly is available after a reload
Default value: 4
wildfly_reload_wait
Data type: Integer
The delay in seconds between consecutive checks if wildfly is available after a reload
Default value: 30
ejbca::api_config
Configure access to the EJBCA API
Examples
include ejbca::api_config
ejbca::config
Configure EJBCA
Examples
include ejbca::config
ejbca::install
Install EJBCA
Examples
include ejbca::install
ejbca::wildfly::config
Configure Wildfly
Examples
include ejbca::wildfly::config
ejbca::wildfly::install
Install Wildfly
Examples
include ejbca::wildfly::install
Defined types
ejbca::wildfly::interface
Create a Wildfly interface and socket-binding
Examples
ejbca::wildfly::interface { 'namevar': }
Parameters
The following parameters are available in the ejbca::wildfly::interface
defined type:
interface
Data type: String
Default value: $title
port
Data type: Integer
Default value: undef
Resource types
ejbca_end_entity
Username
Properties
The following properties are available in the ejbca_end_entity
type.
ca_name
Issueing CA
certificate_profile_name
Certificate Profile
Default value: ENDUSER
email
Email address
end_entity_profile_name
End Entity Profile
Default value: EMPTY
ensure
Valid values: present
, absent
, new
, revoked
Default value: present
subject_alt_name
Subject Alternative Names
Default value: []
subject_dn
Subject DN
token_type
Valid values: USERGENERATED
, P12
, JKS
, PEM
Token type
Default value: USERGENERATED
Parameters
The following parameters are available in the ejbca_end_entity
type.
clear_pwd
Valid values: true
, false
, yes
, no
Store password in clear text?
Default value: false
password
Password or enrollment code
provider
The specific backend to use for this ejbca_end_entity
resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.
revocation_reason
Valid values: aacompromise
, affiliationchanged
, cacompromise
, certificatehold
, cessationofoperation
, keycompromise
, privilegeswithdrawn
, removefromcrl
, superseded
, unspecified
Revocation reason
Default value: unspecified
username
Username
Functions
ejbca::database_driver_params
Type: Puppet Language
The ejbca::database_driver_params function.
ejbca::database_driver_params(Ejbca::Database_driver $driver)
The ejbca::database_driver_params function.
Returns: Ejbca::Database_driver_params
driver
Data type: Ejbca::Database_driver
ejbca::database_url
Type: Puppet Language
The ejbca::database_url function.
ejbca::database_url(Ejbca::Database_driver $driver, String $db)
The ejbca::database_url function.
Returns: String
driver
Data type: Ejbca::Database_driver
db
Data type: String
Data types
Ejbca::Database_driver
The Ejbca::Database_driver data type.
Alias of
Enum['mariadb', 'mysql5', 'mysql8', 'postgresql', 'h2']
Ejbca::Database_driver_params
The Ejbca::Database_driver_params data type.
Alias of
Struct[{
database_name => Enum['db2', 'derby', 'h2', 'informix', 'ingres', 'mssql', 'mysql', 'oracle', 'postgres', 'sybase'],
driver_module_name => String,
driver_module_source => Variant[Pattern[/^\./], Pattern[/^file:\/\//], Pattern[/^puppet:\/\//], Stdlib::Httpurl],
driver_name => String,
driver_xa_datasource_class_name => String
}]
Changelog
All notable changes to this project will be documented in this file.
Release 0.3.0
- support for EJBCA 7
- support for MySQL 8
- remove params.pp
Release 0.2.0
- support for EJBCA 6.15
Release 0.1.2 - 2020-04-05
- updated to PDK 1.17
- fixed driver download url
- applied fix for https://jira.primekey.se/browse/ECA-8667
Release 0.1.1 - 2019-02-03
- added more unit tests
- support for Puppet 6
- PDK updated to 1.9.0
- removed dependencies on puppetlabs/mysql, puppetlabs/postgresql and puppetlabs/java
Release 0.1.0 - 2018-09-23
Initial release.
Dependencies
- biemond/wildfly (>= 2.2.0 < 3.0.0)
- puppet/archive (>= 3.1.1 < 7.0.0)
- puppetlabs/stdlib (>= 4.25.1 < 9.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.