Skip to content

Latest commit

 

History

History
577 lines (315 loc) · 11.1 KB

REFERENCE.md

File metadata and controls

577 lines (315 loc) · 11.1 KB

Reference

Table of Contents

Classes

Defined types

Resource types

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

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
  }]