- Elasticsearch Guide: other versions:
- Getting Started
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Important System Configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Maximum size virtual memory check
- Max file size check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- G1GC check
- Stopping Elasticsearch
- Upgrade Elasticsearch
- Set up X-Pack
- Breaking changes
- Breaking changes in 6.0
- Aggregations changes
- Analysis changes
- Cat API changes
- Clients changes
- Cluster changes
- Document API changes
- Indices changes
- Ingest changes
- Java API changes
- Mapping changes
- Packaging changes
- Percolator changes
- Plugins changes
- Reindex changes
- REST changes
- Scripting changes
- Search and Query DSL changes
- Settings changes
- Stats and info changes
- Breaking changes in 6.1
- Breaking changes in 6.0
- X-Pack Breaking Changes
- API Conventions
- Document APIs
- Search APIs
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Cardinality Aggregation
- Extended Stats Aggregation
- Geo Bounds Aggregation
- Geo Centroid Aggregation
- Max Aggregation
- Min Aggregation
- Percentiles Aggregation
- Percentile Ranks Aggregation
- Scripted Metric Aggregation
- Stats Aggregation
- Sum Aggregation
- Top Hits Aggregation
- Value Count Aggregation
- Bucket Aggregations
- Adjacency Matrix Aggregation
- Children Aggregation
- Composite Aggregation
- Date Histogram Aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Range Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text Aggregation
- Terms Aggregation
- Pipeline Aggregations
- Avg Bucket Aggregation
- Derivative Aggregation
- Max Bucket Aggregation
- Min Bucket Aggregation
- Sum Bucket Aggregation
- Stats Bucket Aggregation
- Extended Stats Bucket Aggregation
- Percentiles Bucket Aggregation
- Moving Average Aggregation
- Cumulative Sum Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Bucket Sort Aggregation
- Serial Differencing Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Metrics Aggregations
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Shrink Index
- Split Index
- Rollover Index
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Force Merge
- cat APIs
- Cluster APIs
- Query DSL
- Mapping
- Analysis
- Anatomy of an analyzer
- Testing analyzers
- Analyzers
- Normalizers
- Tokenizers
- Token Filters
- Standard Token Filter
- ASCII Folding Token Filter
- Flatten Graph Token Filter
- Length Token Filter
- Lowercase Token Filter
- Uppercase Token Filter
- NGram Token Filter
- Edge NGram Token Filter
- Porter Stem Token Filter
- Shingle Token Filter
- Stop Token Filter
- Word Delimiter Token Filter
- Word Delimiter Graph Token Filter
- Stemmer Token Filter
- Stemmer Override Token Filter
- Keyword Marker Token Filter
- Keyword Repeat Token Filter
- KStem Token Filter
- Snowball Token Filter
- Phonetic Token Filter
- Synonym Token Filter
- Synonym Graph Token Filter
- Compound Word Token Filters
- Reverse Token Filter
- Elision Token Filter
- Truncate Token Filter
- Unique Token Filter
- Pattern Capture Token Filter
- Pattern Replace Token Filter
- Trim Token Filter
- Limit Token Count Token Filter
- Hunspell Token Filter
- Common Grams Token Filter
- Normalization Token Filter
- CJK Width Token Filter
- CJK Bigram Token Filter
- Delimited Payload Token Filter
- Keep Words Token Filter
- Keep Types Token Filter
- Classic Token Filter
- Apostrophe Token Filter
- Decimal Digit Token Filter
- Fingerprint Token Filter
- Minhash Token Filter
- Character Filters
- Modules
- Index Modules
- Ingest Node
- Pipeline Definition
- Ingest APIs
- Accessing Data in Pipelines
- Handling Failures in Pipelines
- Processors
- Append Processor
- Convert Processor
- Date Processor
- Date Index Name Processor
- Fail Processor
- Foreach Processor
- Grok Processor
- Gsub Processor
- Join Processor
- JSON Processor
- KV Processor
- Lowercase Processor
- Remove Processor
- Rename Processor
- Script Processor
- Set Processor
- Split Processor
- Sort Processor
- Trim Processor
- Uppercase Processor
- Dot Expander Processor
- URL Decode Processor
- Monitoring Elasticsearch
- X-Pack APIs
- Info API
- Explore API
- Machine Learning APIs
- Close Jobs
- Create Datafeeds
- Create Jobs
- Delete Datafeeds
- Delete Jobs
- Delete Model Snapshots
- Flush Jobs
- Forecast Jobs
- Get Buckets
- Get Overall Buckets
- Get Categories
- Get Datafeeds
- Get Datafeed Statistics
- Get Influencers
- Get Jobs
- Get Job Statistics
- Get Model Snapshots
- Get Records
- Open Jobs
- Post Data to Jobs
- Preview Datafeeds
- Revert Model Snapshots
- Start Datafeeds
- Stop Datafeeds
- Update Datafeeds
- Update Jobs
- Update Model Snapshots
- Security APIs
- Watcher APIs
- Migration APIs
- Deprecation Info APIs
- Definitions
- X-Pack Commands
- How To
- Testing
- Glossary of terms
- Release Notes
- 6.1.4 Release Notes
- 6.1.3 Release Notes
- 6.1.2 Release Notes
- 6.1.1 Release Notes
- 6.1.0 Release Notes
- 6.0.1 Release Notes
- 6.0.0 Release Notes
- 6.0.0-rc2 Release Notes
- 6.0.0-rc1 Release Notes
- 6.0.0-beta2 Release Notes
- 6.0.0-beta1 Release Notes
- 6.0.0-alpha2 Release Notes
- 6.0.0-alpha1 Release Notes
- 6.0.0-alpha1 Release Notes (Changes previously released in 5.x)
- X-Pack Release Notes
WARNING: Version 6.1 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
The certutil
command simplifies the creation of certificates for use with
Transport Layer Security (TLS) in the Elastic Stack.
bin/x-pack/certutil ( (ca [--ca-dn <name>] [--days <n>] [--pem]) | (cert ([--ca <file_path>] | [--ca-cert <file_path> --ca-key <file_path>]) [--ca-dn <name>] [--ca-pass <password>] [--days <n>] [--dns <domain_name>] [--in <input_file>] [--ip <ip_addresses>] [--keep-ca-key] [--multiple] [--name <file_name>] [--pem]) | (csr [--dns <domain_name>] [--in <input_file>] [--ip <ip_addresses>] [--name <file_name>]) [-E <KeyValuePair>] [--keysize <bits>] [--out <file_path>] [--pass <password>] ) [-h, --help] ([-s, --silent] | [-v, --verbose])
You can specify one of the following modes: ca
, cert
, csr
. The certutil
command also supports a silent mode of operation to enable easier batch
operations.
The ca
mode generates a new certificate authority (CA). By default, it
produces a single PKCS#12 output file, which holds the CA certificate and the
private key for the CA. If you specify the --pem
parameter, the command
generates a zip file, which contains the certificate and private key in PEM
format.
You can subsequently use these files as input for the cert
mode of the command.
The cert
mode generates X.509 certificates and private keys. By default, it
produces a single certificate and key for use on a single instance.
To generate certificates and keys for multiple instances, specify the
--multiple
parameter, which prompts you for details about each instance.
Alternatively, you can use the --in
parameter to specify a YAML file that
contains details about the instances.
An instance is any piece of the Elastic Stack that requires a TLS or SSL
certificate. Depending on your configuration, Elasticsearch, Logstash, Kibana, and Beats
might all require a certificate and private key. The minimum required
information for an instance is its name, which is used as the common name for
the certificate. The instance name can be a hostname value or a full
distinguished name. If the instance name would result in an invalid file or
directory name, you must also specify a file name in the --name
command
parameter or in the filename
field in an input YAML file.
You can optionally provide IP addresses or DNS names for each instance. If
neither IP addresses nor DNS names are specified, the Elastic stack products
cannot perform hostname verification and you might need to configure the
verfication_mode
security setting to certificate
only. For more information
about this setting, see Security settings.
All certificates that are generated by this command are signed by a CA. You can
provide your own CA with the --ca
or --ca-cert
parameters. Otherwise, the
command automatically generates a new CA for you. For more information about
generating a CA, see the CA mode of this command.
By default, the cert
mode produces a single PKCS#12 output file which holds
the instance certificate, the instance private key, and the CA certificate. If
you specify the --pem
parameter, the command generates PEM formatted
certificates and keys and packages them into a zip file. Likewise if you chose
to generate output for multiple instances, the command produces a zip file.
The csr
mode generates certificate signing requests (CSRs) that you can send
to a trusted certificate authority to obtain signed certificates. The signed
certificates must be in PEM or PKCS#12 format to work with X-Pack security.
By default, the command produces a single CSR for a single instance.
To generate CSRs for multiple instances, specify the --multiple
parameter,
which prompts you for details about each instance. Alternatively, you can use
the --in
parameter to specify a YAML file that contains details about the
instances.
The cert
mode produces a single zip file which contains the CSRs and the
private keys for each instance. Each CSR is provided as a standard PEM
encoding of a PKCS#10 CSR. Each key is provided as a PEM encoding of an RSA
private key.
-
ca
-
Specifies to generate a new local certificate authority (CA). This
parameter cannot be used with the
csr
orcert
parameters. -
cert
-
Specifies to generate new X.509 certificates and keys.
This parameter cannot be used with the
csr
orca
parameters. -
csr
-
Specifies to generate certificate signing requests. This parameter
cannot be used with the
ca
orcert
parameters. -
--ca <file_path>
-
Specifies the path to an existing CA key pair
(in PKCS#12 format). This parameter cannot be used with the
ca
orcsr
parameters. -
--ca-cert <file_path>
-
Specifies the path to an existing CA certificate (in
PEM format). You must also specify the
--ca-key
parameter. The--ca-cert
parameter cannot be used with theca
orcsr
parameters. -
--ca-dn <name>
-
Defines the Distinguished Name (DN) that is used for the
generated CA certificate. The default value is
CN=Elastic Certificate Tool Autogenerated CA
. This parameter cannot be used with thecsr
parameter. -
--ca-key <file_path>
-
Specifies the path to an existing CA private key (in
PEM format). You must also specify the
--ca-cert
parameter. The--ca-key
parameter cannot be used with theca
orcsr
parameters. -
--ca-pass <password>
-
Specifies the password for an existing CA private key
or the generated CA private key. This parameter cannot be used with the
ca
orcsr
parameters. -
--days <n>
-
Specifies an integer value that represents the number of days the
generated certificates are valid. The default value is
1095
. This parameter cannot be used with thecsr
parameter. -
--dns <domain_name>
-
Specifies a comma-separated list of DNS names. This
parameter cannot be used with the
ca
parameter. -
-E <KeyValuePair>
- Configures a setting.
-
-h, --help
- Returns all of the command parameters.
-
--in <input_file>
-
Specifies the file that is used to run in silent mode. The
input file must be a YAML file. This parameter cannot be used with the
ca
parameter. -
--ip <IP_addresses>
-
Specifies a comma-separated list of IP addresses. This
parameter cannot be used with the
ca
parameter. -
--keep-ca-key
-
When running in
cert
mode with an automatically-generated CA, specifies to retain the CA private key for future use. -
--keysize <bits>
-
Defines the number of bits that are used in generated RSA keys. The default
value is
2048
. -
--multiple
-
Specifies to generate files for multiple instances. This parameter cannot be
used with the
ca
parameter. -
--name <file_name>
-
Specifies the name of the generated certificate. This parameter cannot be used
with the
ca
parameter. -
--out <file_path>
- Specifies a path for the output files.
-
--pass <password>
- Specifies the password for the generated private keys.
-
--pem
-
Generates certificates and keys in PEM format instead of PKCS#12. This
parameter cannot be used with the
csr
parameter. -
-s, --silent
- Shows minimal output.
-
-v, --verbose
- Shows verbose output.
The following command generates a CA certificate and private key in PKCS#12 format:
bin/x-pack/certutil ca
You are prompted for an output filename and a password. Alternatively, you can
specify the --out
and --pass
parameters.
You can then generate X.509 certificates and private keys by using the new CA. For example:
bin/x-pack/certutil cert --ca elastic-stack-ca.p12
You are prompted for the CA password and for an output filename and password.
Alternatively, you can specify the --ca-pass
, --out
, and --pass
parameters.
By default, this command generates a file called elastic-certificates.p12
,
which you can copy to the relevant configuration directory for each Elastic
product that you want to configure. For more information, see
Setting Up TLS on a Cluster.
To use the silent mode of operation, you must create a YAML file that contains information about the instances. It must match the following format:
instances: - name: "node1" ip: - "192.0.2.1" dns: - "node1.mydomain.com" - name: "node2" ip: - "192.0.2.2" - "198.51.100.1" - name: "node3" - name: "node4" dns: - "node4.mydomain.com" - "node4.internal" - name: "CN=node5,OU=IT,DC=mydomain,DC=com" filename: "node5"
The name of the instance. This can be a simple string value or can be a Distinguished Name (DN). This is the only required field. |
|
An optional array of strings that represent IP Addresses for this instance. Both IPv4 and IPv6 values are allowed. The values are added as Subject Alternative Names. |
|
An optional array of strings that represent DNS names for this instance. The values are added as Subject Alternative Names. |
|
The filename to use for this instance. This name is used as the name of the
directory that contains the instance’s files in the output. It is also used in
the names of the files within the directory. This filename should not have an
extension. Note: If the |
When your YAML file is ready, you can use the certutil
command to generate
certificates or certificate signing requests. Simply use the --in
parameter to
specify the location of the file. For example:
bin/x-pack/certutil cert --silent --in instances.yml --out test1.zip --pass testpassword
This command generates a compressed test1.zip
file. After you decompress the
output file, there is a directory for each instance that was listed in the
instances.yml
file. Each instance directory contains a single PKCS#12 (.p12
)
file, which contains the instance certificate, instance private key, and CA
certificate.
You an also use the YAML file to generate certificate signing requests. For example:
bin/x-pack/certutil csr --silent --in instances.yml --out test2.zip --pass testpassword
This command generates a compressed file, which contains a directory for each
instance. Each instance directory contains a certificate signing request
(*.csr
file) and private key (*.key
file).
On this page