REDROOM

Navigation

Breadcrumbs

/ / lib / python3.6 / site-packages / cloudinit / config

Create

Create File | Create Folder | Upload Files | Run Command

Preview: cc_phone_home.py Size: 5.48 KB

//lib/python3.6/site-packages/cloudinit/config/cc_phone_home.py

# Copyright (C) 2011 Canonical Ltd.
# Copyright (C) 2012, 2013 Hewlett-Packard Development Company, L.P.
#
# Author: Scott Moser <scott.moser@canonical.com>
# Author: Juerg Haefliger <juerg.haefliger@hp.com>
#
# This file is part of cloud-init. See LICENSE file for license information.

"""Phone Home: Post data to url"""

import logging
from textwrap import dedent

from cloudinit import templater, url_helper, util
from cloudinit.cloud import Cloud
from cloudinit.config import Config
from cloudinit.config.schema import MetaSchema, get_meta_doc
from cloudinit.distros import ALL_DISTROS
from cloudinit.settings import PER_INSTANCE

frequency = PER_INSTANCE

POST_LIST_ALL = [
    "pub_key_dsa",
    "pub_key_rsa",
    "pub_key_ecdsa",
    "pub_key_ed25519",
    "instance_id",
    "hostname",
    "fqdn",
]

MODULE_DESCRIPTION = """\
This module can be used to post data to a remote host after boot is complete.
If the post url contains the string ``$INSTANCE_ID`` it will be replaced with
the id of the current instance. Either all data can be posted or a list of
keys to post. Available keys are:

    - ``pub_key_dsa``
    - ``pub_key_rsa``
    - ``pub_key_ecdsa``
    - ``pub_key_ed25519``
    - ``instance_id``
    - ``hostname``
    - ``fdqn``

Data is sent as ``x-www-form-urlencoded`` arguments.

**Example HTTP POST**:

.. code-block:: http

    POST / HTTP/1.1
    Content-Length: 1337
    User-Agent: Cloud-Init/21.4
    Accept-Encoding: gzip, deflate
    Accept: */*
    Content-Type: application/x-www-form-urlencoded

    pub_key_dsa=dsa_contents&pub_key_rsa=rsa_contents&pub_key_ecdsa=ecdsa_contents&pub_key_ed25519=ed25519_contents&instance_id=i-87018aed&hostname=myhost&fqdn=myhost.internal
"""

meta: MetaSchema = {
    "id": "cc_phone_home",
    "name": "Phone Home",
    "title": "Post data to url",
    "description": MODULE_DESCRIPTION,
    "distros": [ALL_DISTROS],
    "frequency": PER_INSTANCE,
    "examples": [
        dedent(
            """\
            phone_home:
                url: http://example.com/$INSTANCE_ID/
                post: all
            """
        ),
        dedent(
            """\
            phone_home:
                url: http://example.com/$INSTANCE_ID/
                post:
                    - pub_key_dsa
                    - pub_key_rsa
                    - pub_key_ecdsa
                    - pub_key_ed25519
                    - instance_id
                    - hostname
                    - fqdn
                tries: 5
            """
        ),
    ],
    "activate_by_schema_keys": ["phone_home"],
}

__doc__ = get_meta_doc(meta)
LOG = logging.getLogger(__name__)
# phone_home:
#  url: http://my.foo.bar/$INSTANCE/
#  post: all
#  tries: 10
#
# phone_home:
#  url: http://my.foo.bar/$INSTANCE_ID/
#  post: [ pub_key_dsa, pub_key_rsa, pub_key_ecdsa, instance_id, hostname,
#          fqdn ]
#


def handle(name: str, cfg: Config, cloud: Cloud, args: list) -> None:
    if len(args) != 0:
        ph_cfg = util.read_conf(args[0])
    else:
        if "phone_home" not in cfg:
            LOG.debug(
                "Skipping module named %s, "
                "no 'phone_home' configuration found",
                name,
            )
            return
        ph_cfg = cfg["phone_home"]

    if "url" not in ph_cfg:
        LOG.warning(
            "Skipping module named %s, "
            "no 'url' found in 'phone_home' configuration",
            name,
        )
        return

    url = ph_cfg["url"]
    post_list = ph_cfg.get("post", "all")
    tries = ph_cfg.get("tries")
    try:
        tries = int(tries)  # type: ignore
    except (ValueError, TypeError):
        tries = 10
        util.logexc(
            LOG,
            "Configuration entry 'tries' is not an integer, using %s instead",
            tries,
        )

    if post_list == "all":
        post_list = POST_LIST_ALL

    all_keys = {
        "instance_id": cloud.get_instance_id(),
        "hostname": cloud.get_hostname().hostname,
        "fqdn": cloud.get_hostname(fqdn=True).hostname,
    }

    pubkeys = {
        "pub_key_dsa": "/etc/ssh/ssh_host_dsa_key.pub",
        "pub_key_rsa": "/etc/ssh/ssh_host_rsa_key.pub",
        "pub_key_ecdsa": "/etc/ssh/ssh_host_ecdsa_key.pub",
        "pub_key_ed25519": "/etc/ssh/ssh_host_ed25519_key.pub",
    }

    for (n, path) in pubkeys.items():
        try:
            all_keys[n] = util.load_file(path)
        except Exception:
            util.logexc(
                LOG, "%s: failed to open, can not phone home that data!", path
            )

    submit_keys = {}
    for k in post_list:
        if k in all_keys:
            submit_keys[k] = all_keys[k]
        else:
            submit_keys[k] = None
            LOG.warning(
                "Requested key %s from 'post'"
                " configuration list not available",
                k,
            )

    # Get them read to be posted
    real_submit_keys = {}
    for (k, v) in submit_keys.items():
        if v is None:
            real_submit_keys[k] = "N/A"
        else:
            real_submit_keys[k] = str(v)

    # Incase the url is parameterized
    url_params = {
        "INSTANCE_ID": all_keys["instance_id"],
    }
    url = templater.render_string(url, url_params)
    try:
        url_helper.read_file_or_url(
            url,
            data=real_submit_keys,
            retries=tries - 1,
            sec_between=3,
            ssl_details=util.fetch_ssl_details(cloud.paths),
        )
    except Exception:
        util.logexc(
            LOG, "Failed to post phone home data to %s in %s tries", url, tries
        )

Directory Contents

Dirs: 2 × Files: 64

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
schemas DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
__pycache__ DIR	-	drwxr-xr-x	2026-01-24 23:01:14	Edit Download recursive recursive
cc_ansible.py	8.69 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_apk_configure.py	5.66 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_apt_configure.py	41.99 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_apt_pipelining.py	2.71 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_bootcmd.py	2.85 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_byobu.py	3.65 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ca_certs.py	9.13 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_chef.py	13.77 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_disable_ec2_metadata.py	2.03 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_disk_setup.py	32.36 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_fan.py	3.02 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_final_message.py	3.39 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_growpart.py	21.03 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_grub_dpkg.py	6.65 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_install_hotplug.py	3.81 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_keyboard.py	2.38 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_keys_to_console.py	3.61 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_landscape.py	5.31 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_locale.py	1.86 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_lxd.py	18.14 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_mcollective.py	6.10 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_migrator.py	3.49 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_mounts.py	19.71 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ntp.py	20.84 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_package_update_upgrade_install.py	4.54 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_phone_home.py	5.48 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_power_state_change.py	7.41 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_puppet.py	14.10 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_reset_rmc.py	4.47 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_resizefs.py	10.73 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_resolv_conf.py	4.98 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_rh_subscription.py	16.97 KB	lrw-r--r--	2026-01-23 08:56:46	Edit Download recursive recursive
cc_rightscale_userdata.py	4.28 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_rsyslog.py	13.48 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_runcmd.py	2.90 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_salt_minion.py	5.88 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_per_boot.py	1.66 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_per_instance.py	1.81 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_per_once.py	1.76 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_user.py	1.85 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_scripts_vendor.py	2.29 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_seed_random.py	4.72 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_set_hostname.py	5.13 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_set_passwords.py	10.97 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_snap.py	6.30 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_spacewalk.py	3.43 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ssh.py	14.86 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ssh_authkey_fingerprints.py	4.22 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ssh_import_id.py	6.12 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_timezone.py	1.46 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ubuntu_advantage.py	17.00 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ubuntu_autoinstall.py	4.50 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_ubuntu_drivers.py	4.56 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_update_etc_hosts.py	5.16 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_update_hostname.py	3.87 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_users_groups.py	8.57 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_wireguard.py	9.22 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_write_files.py	6.66 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_write_files_deferred.py	1.68 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_yum_add_repo.py	7.45 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
cc_zypper_add_repo.py	6.59 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
modules.py	11.74 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
schema.py	54.85 KB	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive
__init__.py	14 B	lrw-r--r--	2023-12-04 11:47:40	Edit Download recursive recursive