- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Community.Crypto Collection Docs

# community.crypto.openssl_publickey_info module – Provide information for OpenSSL public keys

Note

This module is part of the community.crypto collection (version 2.13.1).

To install it, use: `ansible-galaxy collection install community.crypto`. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: `community.crypto.openssl_publickey_info`.

New in community.crypto 1.7.0

## Synopsis

- This module allows one to query information on OpenSSL public keys.

- It uses the cryptography python library to interact with OpenSSL.

## Requirements

The below requirements are needed on the host that executes this module.

- cryptography >= 1.2.3

## Parameters

Parameter | Comments
--- | ---
content string | Content of the public key file. Either path or content must be specified, but not both.
path path | Remote absolute path where the public key file is loaded from.
select_crypto_backend string | Determines which crypto backend to use. The default choice is `auto`, which tries to use `cryptography` if available. If set to `cryptography`, will try to use the cryptography library. Choices: `"auto"` ← (default) `"cryptography"`

## Attributes

Attribute | Support | Description
--- | --- | ---
check_mode | Support: full This action does not modify state. | Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode | Support: N/A This action does not modify state. | Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

## See Also

See also

community.crypto.openssl_publickey

  Generate an OpenSSL public key from its private key.

community.crypto.openssl_privatekey_info

  Provide information for OpenSSL private keys.

community.crypto.openssl_publickey_info filter

  A filter variant of this module.

## Examples

    - name: Generate an OpenSSL private key with the default values (4096 bits, RSA)
      community.crypto.openssl_privatekey:
        path: /etc/ssl/private/ansible.com.pem

    - name: Create public key from private key
      community.crypto.openssl_publickey:
        privatekey_path: /etc/ssl/private/ansible.com.pem
        path: /etc/ssl/ansible.com.pub

    - name: Get information on public key
      community.crypto.openssl_publickey_info:
        path: /etc/ssl/ansible.com.pub
      register: result

    - name: Dump information
      ansible.builtin.debug:
        var: result

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Description
--- | ---
fingerprints dictionary | Fingerprints of public key. For every hash algorithm available, the fingerprint is computed. Returned: success Sample: `"{'sha256': 'd4:b3:aa:6d:c8:04:ce:4e:ba:f6:29:4d:92:a3:94:b0:c2:ff:bd:bf:33:63:11:43:34:0f:51:b0:95:09:2f:63', 'sha512': 'f7:07:4a:f0:b0:f0:e6:8b:95:5f:f9:e6:61:0a:32:68:f1..."`
public_data dictionary | Public key data. Depends on key type. Returned: success
curve string | The curve’s name for ECC. Returned: When `type=ECC`
exponent integer | The RSA key’s public exponent. Returned: When `type=RSA`
exponent_size integer | The maximum number of bits of a private key. This is basically the bit size of the subgroup used. Returned: When `type=ECC`
g integer | The `g` value for DSA. This is the element spanning the subgroup of the multiplicative group of the prime field used. Returned: When `type=DSA`
modulus integer | The RSA key’s modulus. Returned: When `type=RSA`
p integer | The `p` value for DSA. This is the prime modulus upon which arithmetic takes place. Returned: When `type=DSA`
q integer | The `q` value for DSA. This is a prime that divides `p - 1`, and at the same time the order of the subgroup of the multiplicative group of the prime field used. Returned: When `type=DSA`
size integer | Bit size of modulus (RSA) or prime number (DSA). Returned: When `type=RSA` or `type=DSA`
x integer | The `x` coordinate for the public point on the elliptic curve. Returned: When `type=ECC`
y integer | For `type=ECC`, this is the `y` coordinate for the public point on the elliptic curve. For `type=DSA`, this is the publicly known group element whose discrete logarithm w.r.t. `g` is the private key. Returned: When `type=DSA` or `type=ECC`
type string | The key’s type. One of `RSA`, `DSA`, `ECC`, `Ed25519`, `X25519`, `Ed448`, or `X448`. Will start with `unknown` if the key type cannot be determined. Returned: success Sample: `"RSA"`

### Authors

- Felix Fontein (@felixfontein)

### Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication