# 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 )
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
schemas | Folder | 0755 |
|
|
__init__.py | File | 14 B | 0644 |
|
cc_ansible.py | File | 8.69 KB | 0644 |
|
cc_apk_configure.py | File | 5.66 KB | 0644 |
|
cc_apt_configure.py | File | 41.99 KB | 0644 |
|
cc_apt_pipelining.py | File | 2.71 KB | 0644 |
|
cc_bootcmd.py | File | 2.85 KB | 0644 |
|
cc_byobu.py | File | 3.65 KB | 0644 |
|
cc_ca_certs.py | File | 9.13 KB | 0644 |
|
cc_chef.py | File | 13.77 KB | 0644 |
|
cc_disable_ec2_metadata.py | File | 2.03 KB | 0644 |
|
cc_disk_setup.py | File | 32.36 KB | 0644 |
|
cc_fan.py | File | 3.02 KB | 0644 |
|
cc_final_message.py | File | 3.39 KB | 0644 |
|
cc_growpart.py | File | 21.03 KB | 0644 |
|
cc_grub_dpkg.py | File | 6.65 KB | 0644 |
|
cc_install_hotplug.py | File | 3.81 KB | 0644 |
|
cc_keyboard.py | File | 2.38 KB | 0644 |
|
cc_keys_to_console.py | File | 3.61 KB | 0644 |
|
cc_landscape.py | File | 5.31 KB | 0644 |
|
cc_locale.py | File | 1.86 KB | 0644 |
|
cc_lxd.py | File | 18.14 KB | 0644 |
|
cc_mcollective.py | File | 6.1 KB | 0644 |
|
cc_migrator.py | File | 3.49 KB | 0644 |
|
cc_mounts.py | File | 19.71 KB | 0644 |
|
cc_ntp.py | File | 20.69 KB | 0644 |
|
cc_package_update_upgrade_install.py | File | 4.54 KB | 0644 |
|
cc_phone_home.py | File | 5.48 KB | 0644 |
|
cc_power_state_change.py | File | 7.41 KB | 0644 |
|
cc_puppet.py | File | 14.1 KB | 0644 |
|
cc_reset_rmc.py | File | 4.47 KB | 0644 |
|
cc_resizefs.py | File | 10.73 KB | 0644 |
|
cc_resolv_conf.py | File | 4.98 KB | 0644 |
|
cc_rh_subscription.py | File | 16.97 KB | 0644 |
|
cc_rightscale_userdata.py | File | 4.28 KB | 0644 |
|
cc_rsyslog.py | File | 13.48 KB | 0644 |
|
cc_runcmd.py | File | 2.9 KB | 0644 |
|
cc_salt_minion.py | File | 5.88 KB | 0644 |
|
cc_scripts_per_boot.py | File | 1.66 KB | 0644 |
|
cc_scripts_per_instance.py | File | 1.81 KB | 0644 |
|
cc_scripts_per_once.py | File | 1.76 KB | 0644 |
|
cc_scripts_user.py | File | 1.85 KB | 0644 |
|
cc_scripts_vendor.py | File | 2.29 KB | 0644 |
|
cc_seed_random.py | File | 4.72 KB | 0644 |
|
cc_set_hostname.py | File | 5.13 KB | 0644 |
|
cc_set_passwords.py | File | 10.97 KB | 0644 |
|
cc_snap.py | File | 6.3 KB | 0644 |
|
cc_spacewalk.py | File | 3.43 KB | 0644 |
|
cc_ssh.py | File | 14.86 KB | 0644 |
|
cc_ssh_authkey_fingerprints.py | File | 4.22 KB | 0644 |
|
cc_ssh_import_id.py | File | 6.12 KB | 0644 |
|
cc_timezone.py | File | 1.46 KB | 0644 |
|
cc_ubuntu_advantage.py | File | 17 KB | 0644 |
|
cc_ubuntu_autoinstall.py | File | 4.5 KB | 0644 |
|
cc_ubuntu_drivers.py | File | 4.56 KB | 0644 |
|
cc_update_etc_hosts.py | File | 5.16 KB | 0644 |
|
cc_update_hostname.py | File | 3.87 KB | 0644 |
|
cc_users_groups.py | File | 8.57 KB | 0644 |
|
cc_wireguard.py | File | 9.22 KB | 0644 |
|
cc_write_files.py | File | 6.66 KB | 0644 |
|
cc_write_files_deferred.py | File | 1.68 KB | 0644 |
|
cc_yum_add_repo.py | File | 7.45 KB | 0644 |
|
cc_zypper_add_repo.py | File | 6.59 KB | 0644 |
|
modules.py | File | 11.74 KB | 0644 |
|
schema.py | File | 54.85 KB | 0644 |
|