text
stringlengths
81
112k
Rename a key, when an instance has also been renamed def rename_key(pki_dir, id_, new_id): ''' Rename a key, when an instance has also been renamed ''' oldkey = os.path.join(pki_dir, 'minions', id_) newkey = os.path.join(pki_dir, 'minions', new_id) if os.path.isfile(oldkey): os.rename(o...
Return a minion's configuration for the provided options and VM def minion_config(opts, vm_): ''' Return a minion's configuration for the provided options and VM ''' # Don't start with a copy of the default minion opts; they're not always # what we need. Some default options are Null, let's set a ...
Return a master's configuration for the provided options and VM def master_config(opts, vm_): ''' Return a master's configuration for the provided options and VM ''' # Let's get a copy of the salt master default options master = copy.deepcopy(salt.config.DEFAULT_MASTER_OPTS) # Some default opti...
Return a salt configuration dictionary, master or minion, as a yaml dump def salt_config_to_yaml(configuration, line_break='\n'): ''' Return a salt configuration dictionary, master or minion, as a yaml dump ''' return salt.utils.yaml.safe_dump( configuration, line_break=line_break, ...
This is the primary entry point for logging into any system (POSIX or Windows) to install Salt. It will make the decision on its own as to which deploy function to call. def bootstrap(vm_, opts=None): ''' This is the primary entry point for logging into any system (POSIX or Windows) to install Salt...
Return the ssh_usernames. Defaults to a built-in list of users for trying. def ssh_usernames(vm_, opts, default_users=None): ''' Return the ssh_usernames. Defaults to a built-in list of users for trying. ''' if default_users is None: default_users = ['root'] usernames = salt.config.get_clo...
Wait until a function finishes, or times out def wait_for_fun(fun, timeout=900, **kwargs): ''' Wait until a function finishes, or times out ''' start = time.time() log.debug('Attempting function %s', fun) trycount = 0 while True: trycount += 1 try: response = fun...
Wait until a connection to the specified port can be made on a specified host. This is usually port 22 (for SSH), but in the case of Windows installations, it might be port 445 (for psexec). It may also be an alternate port for SSH, depending on the base image. def wait_for_port(host, port=22, timeout=900,...
Run a command remotly via the winexe executable def run_winexe_command(cmd, args, host, username, password, port=445): ''' Run a command remotly via the winexe executable ''' creds = "-U '{0}%{1}' //{2}".format( username, password, host ) logging_creds = "-U '{0}%XXX-RED...
Run a command remotly using the psexec protocol def run_psexec_command(cmd, args, host, username, password, port=445): ''' Run a command remotly using the psexec protocol ''' if has_winexe() and not HAS_PSEXEC: ret_code = run_winexe_command(cmd, args, host, username, password, port) ret...
Wait until winexe connection can be established. def wait_for_winexe(host, port, username, password, timeout=900): ''' Wait until winexe connection can be established. ''' start = time.time() log.debug( 'Attempting winexe connection to host %s on port %s', host, port ) try_c...
Wait until psexec connection can be established. def wait_for_psexecsvc(host, port, username, password, timeout=900): ''' Wait until psexec connection can be established. ''' if has_winexe() and not HAS_PSEXEC: return wait_for_winexe(host, port, username, password, timeout) start = time.tim...
Wait until WinRM connection can be established. def wait_for_winrm(host, port, username, password, timeout=900, use_ssl=True, verify=True): ''' Wait until WinRM connection can be established. ''' # Ensure the winrm service is listening before attempting to connect wait_for_port(host=host, port=port...
Check if the windows credentials are valid def validate_windows_cred_winexe(host, username='Administrator', password=None, retries=10, retry_delay=1): ''' Check if the windows credentials are valid ''' ...
Check if the windows credentials are valid def validate_windows_cred(host, username='Administrator', password=None, retries=10, retry_delay=1): ''' Check if the windows credentials are valid ''' for ...
Wait until ssh connection can be accessed via password or ssh key def wait_for_passwd(host, port=22, ssh_timeout=15, username='root', password=None, key_filename=None, maxtries=15, trysleep=1, display_ssh_output=True, gateway=None, known_hosts_file='/dev/null...
Copy the install files to a remote Windows box, and execute them def deploy_windows(host, port=445, timeout=900, username='Administrator', password=None, name=None, sock_dir=None, conf_f...
Copy a deploy script to a remote server, execute it, and remove it def deploy_script(host, port=22, timeout=900, username='root', password=None, key_filename=None, script=None, name=None, ...
Run the inline script commands, one by one :**kwargs: catch all other things we may get but don't actually need/use def run_inline_script(host, name=None, port=22, timeout=900, username='root', key_filenam...
Accept a tag, a dict and a list of default keys to return from the dict, and check them against the cloud configuration for that tag def filter_event(tag, data, defaults): ''' Accept a tag, a dict and a list of default keys to return from the dict, and check them against the cloud configuration for tha...
Fire deploy action def fire_event(key, msg, tag, sock_dir, args=None, transport='zeromq'): ''' Fire deploy action ''' event = salt.utils.event.get_event( 'master', sock_dir, transport, listen=False) try: event.fire_event(msg, tag) except ValueError: ...
Use scp or sftp to copy a file to a server def scp_file(dest_path, contents=None, kwargs=None, local_file=None): ''' Use scp or sftp to copy a file to a server ''' file_to_upload = None try: if contents is not None: try: tmpfd, file_to_upload = tempfile.mkstemp()...
Copies a file to the remote SSH target using either sftp or scp, as configured. def ssh_file(opts, dest_path, contents=None, kwargs=None, local_file=None): ''' Copies a file to the remote SSH target using either sftp or scp, as configured. ''' if opts.get('file_transport', 'sftp') == 'sftp': ...
Wrapper for commands to be run against Windows boxes def win_cmd(command, **kwargs): ''' Wrapper for commands to be run against Windows boxes ''' logging_command = kwargs.get('logging_command', None) try: proc = NonBlockingPopen( command, shell=True, std...
Wrapper for commands to be run against Windows boxes using WinRM. def winrm_cmd(session, command, flags, **kwargs): ''' Wrapper for commands to be run against Windows boxes using WinRM. ''' log.debug('Executing WinRM command: %s %s', command, flags) # rebuild the session to ensure we haven't timed ...
Wrapper for commands to be run as root def root_cmd(command, tty, sudo, allow_failure=False, **kwargs): ''' Wrapper for commands to be run as root ''' logging_command = command sudo_password = kwargs.get('sudo_password', None) if sudo: if sudo_password is None: command = 's...
This function is called from a multiprocess instance, to wait for a minion to become available to receive salt commands def check_auth(name, sock_dir=None, queue=None, timeout=300): ''' This function is called from a multiprocess instance, to wait for a minion to become available to receive salt comman...
Converts an IP address to an integer def ip_to_int(ip): ''' Converts an IP address to an integer ''' ret = 0 for octet in ip.split('.'): ret = ret * 256 + int(octet) return ret
Determines whether an IP address falls within one of the private IP ranges def is_public_ip(ip): ''' Determines whether an IP address falls within one of the private IP ranges ''' if ':' in ip: # ipv6 if ip.startswith('fe80:'): # ipv6 link local return False ...
Check whether the specified name contains invalid characters def check_name(name, safe_chars): ''' Check whether the specified name contains invalid characters ''' regexp = re.compile('[^{0}]'.format(safe_chars)) if regexp.search(name): raise SaltCloudException( '{0} contains ch...
Remove a host from the known_hosts file def remove_sshkey(host, known_hosts=None): ''' Remove a host from the known_hosts file ''' if known_hosts is None: if 'HOME' in os.environ: known_hosts = '{0}/.ssh/known_hosts'.format(os.environ['HOME']) else: try: ...
Return a list of the VMs that are on the provider, with select fields def list_nodes_select(nodes, selection, call=None): ''' Return a list of the VMs that are on the provider, with select fields ''' if call == 'action': raise SaltCloudSystemExit( 'The list_nodes_select function mus...
Lock a file; if it is already locked, then wait for it to become available before locking it. Note that these locks are only recognized by Salt Cloud, and not other programs or platforms. def lock_file(filename, interval=.5, timeout=15): ''' Lock a file; if it is already locked, then wait for it t...
Unlock a locked file Note that these locks are only recognized by Salt Cloud, and not other programs or platforms. def unlock_file(filename): ''' Unlock a locked file Note that these locks are only recognized by Salt Cloud, and not other programs or platforms. ''' log.trace('Removing ...
Add an entry to the cachedir index. This generally only needs to happen when a new instance is created. This entry should contain: .. code-block:: yaml - minion_id - profile used to create the instance - provider and driver name The intent of this function is to speed up lookups f...
Delete an entry from the cachedir index. This generally only needs to happen when an instance is deleted. def cachedir_index_del(minion_id, base=None): ''' Delete an entry from the cachedir index. This generally only needs to happen when an instance is deleted. ''' base = init_cachedir(base) ...
Initialize the cachedir needed for Salt Cloud to keep track of minions def init_cachedir(base=None): ''' Initialize the cachedir needed for Salt Cloud to keep track of minions ''' if base is None: base = __opts__['cachedir'] needed_dirs = (base, os.path.join(base, 'reques...
Creates an entry in the requested/ cachedir. This means that Salt Cloud has made a request to a cloud provider to create an instance, but it has not yet verified that the instance properly exists. If the fingerprint is unknown, a raw pubkey can be passed in, and a fingerprint will be calculated. If bot...
Changes the info inside a minion's cachedir entry. The type of cachedir must be specified (i.e., 'requested' or 'active'). A dict is also passed in which contains the data to be changed. Example: change_minion_cachedir( 'myminion', 'requested', {'fingerprint': '...
Moves a minion from the requested/ cachedir into the active/ cachedir. This means that Salt Cloud has verified that a requested instance properly exists, and should be expected to exist from here on out. def activate_minion_cachedir(minion_id, base=None): ''' Moves a minion from the requested/ cachedir...
Deletes a minion's entry from the cloud cachedir. It will search through all cachedirs to find the minion's cache file. Needs `update_cachedir` set to True. def delete_minion_cachedir(minion_id, provider, opts, base=None): ''' Deletes a minion's entry from the cloud cachedir. It will search through ...
Return a list of minion data from the cloud cache, rather from the cloud providers themselves. This is the cloud cache version of list_nodes_full(). def list_cache_nodes_full(opts=None, provider=None, base=None): ''' Return a list of minion data from the cloud cache, rather from the cloud providers the...
Update the salt-bootstrap script url can be one of: - The URL to fetch the bootstrap script from - The absolute path to the bootstrap - The content of the bootstrap script def update_bootstrap(config, url=None): ''' Update the salt-bootstrap script url can be one of: ...
If configured to do so, update the cloud cachedir with the current list of nodes. Also fires configured events pertaining to the node list. .. versionadded:: 2014.7.0 def cache_node_list(nodes, provider, opts): ''' If configured to do so, update the cloud cachedir with the current list of nodes. A...
Cache node individually .. versionadded:: 2014.7.0 def cache_node(node, provider, opts): ''' Cache node individually .. versionadded:: 2014.7.0 ''' if isinstance(opts, dict): __opts__.update(opts) if 'update_cachedir' not in __opts__ or not __opts__['update_cachedir']: re...
Check list of nodes to see if any nodes which were previously known about in the cache have been removed from the node list. This function will only run if configured to do so in the main Salt Cloud configuration file (normally /etc/salt/cloud). .. code-block:: yaml diff_cache_events: True ...
Check new node data against current cache. If data differ, fire an event which consists of the new node data. This function will only run if configured to do so in the main Salt Cloud configuration file (normally /etc/salt/cloud). .. code-block:: yaml diff_cache_events: True .. versionad...
Strip out user-configured sensitive event data. The fields to be stripped are configured in the main Salt Cloud configuration file, usually ``/etc/salt/cloud``. .. code-block: yaml cache_event_strip_fields: - password - priv_key .. versionadded:: 2014.7.0 def _strip_cache...
Helper method to try its best to convert any Unicode text into ASCII without stack tracing since salt internally does not handle Unicode strings This method is not supposed to be used directly. Once `py:module: salt.utils.cloud` is imported this method register's with python's codecs module for proper ...
Retrieve particular user's password for a specified credential set from system keyring. def retrieve_password_from_keyring(credential_id, username): ''' Retrieve particular user's password for a specified credential set from system keyring. ''' try: import keyring # pylint: disable=import-erro...
Saves provider password in system keyring def _save_password_in_keyring(credential_id, username, password): ''' Saves provider password in system keyring ''' try: import keyring # pylint: disable=import-error return keyring.set_password(credential_id, username, password) except Imp...
Interactively prompts user for a password and stores it in system keyring def store_password_in_keyring(credential_id, username, password=None): ''' Interactively prompts user for a password and stores it in system keyring ''' try: # pylint: disable=import-error import keyring i...
Accepts index in form of a string Returns final value Example: dictionary = {'a': {'b': {'c': 'foobar'}}} index_string = 'a,b,c' returns 'foobar' def _unwrap_dict(dictionary, index_string): ''' Accepts index in form of a string Returns final value Example: dictionary =...
Waits until the function retrieves some required argument. NOTE: Tested with ec2 describe_volumes and describe_snapshots only. def run_func_until_ret_arg(fun, kwargs, fun_call=None, argument_being_watched=None, required_argument_response=None): ''' Waits until the function retrie...
Return the salt_interface type to connect to. Either 'public_ips' (default) or 'private_ips'. def get_salt_interface(vm_, opts): ''' Return the salt_interface type to connect to. Either 'public_ips' (default) or 'private_ips'. ''' salt_host = salt.config.get_cloud_config_value( 'salt_in...
Checks that the key_path exists and the key_mode is either 0400 or 0600. Returns True or False. .. versionadded:: 2016.3.0 provider The provider name that the key_path to check belongs to. key_path The key_path to ensure that it exists and to check adequate permissions agains...
Use the configured templating engine to template the userdata file def userdata_template(opts, vm_, userdata): ''' Use the configured templating engine to template the userdata file ''' # No userdata, no need to template anything if userdata is None: return userdata userdata_template =...
Removes the PAExec service and executable that was created as part of the create_service function. This does not remove any older executables or services from previous runs, use cleanup() instead for that purpose. def remove_service(self, wait_timeout=10, sleep_wait=1): ''' Removes the ...
Set an AES dropfile to request the master update the publish session key def dropfile(cachedir, user=None): ''' Set an AES dropfile to request the master update the publish session key ''' dfn = os.path.join(cachedir, '.dfn') # set a mask (to avoid a race condition on file creation) and store origi...
Generate a RSA public keypair for use with salt :param str keydir: The directory to write the keypair to :param str keyname: The type of salt server for whom this key should be written. (i.e. 'master' or 'minion') :param int keysize: The number of bits in the key :param str user: The user on the system...
Load a private key from disk. `timestamp` above is intended to be the timestamp of the file's last modification. This fn is memoized so if it is called with the same path and timestamp (the file's last modified time) the second time the result is returned from the memoiziation. If the file gets modifi...
Read a private key off the disk. Poor man's simple cache in effect here, we memoize the result of calling _get_rsa_with_evict. This means the first time _get_key_with_evict is called with a path and a timestamp the result is cached. If the file (the private key) does not change then its timestamp wil...
Read a public key off the disk. def get_rsa_pub_key(path): ''' Read a public key off the disk. ''' log.debug('salt.crypt.get_rsa_pub_key: Loading public key') if HAS_M2: with salt.utils.files.fopen(path, 'rb') as f: data = f.read().replace(b'RSA ', b'') bio = BIO.MemoryB...
Use Crypto.Signature.PKCS1_v1_5 to sign a message. Returns the signature. def sign_message(privkey_path, message, passphrase=None): ''' Use Crypto.Signature.PKCS1_v1_5 to sign a message. Returns the signature. ''' key = get_rsa_key(privkey_path, passphrase) log.debug('salt.crypt.sign_message: Signi...
Use Crypto.Signature.PKCS1_v1_5 to verify the signature on a message. Returns True for valid signature. def verify_signature(pubkey_path, message, signature): ''' Use Crypto.Signature.PKCS1_v1_5 to verify the signature on a message. Returns True for valid signature. ''' log.debug('salt.crypt.ve...
creates a signature for the given public-key with the given private key and writes it to sign_path def gen_signature(priv_path, pub_path, sign_path, passphrase=None): ''' creates a signature for the given public-key with the given private key and writes it to sign_path ''' with salt.utils.file...
Generate an M2Crypto-compatible signature :param Crypto.PublicKey.RSA._RSAobj key: The RSA key object :param str message: The message to sign :rtype: str :return: The signature, or an empty string if the signature operation failed def private_encrypt(key, message): ''' Generate an M2Crypto-com...
Verify an M2Crypto-compatible signature :param Crypto.PublicKey.RSA._RSAobj key: The RSA public key object :param str message: The signed message to verify :rtype: str :return: The message (or digest) recovered from the signature, or an empty string if the verification failed def public_decryp...
Returns a key object for a key in the pki-dir def __get_keys(self, name='master', passphrase=None): ''' Returns a key object for a key in the pki-dir ''' path = os.path.join(self.opts['pki_dir'], name + '.pem') if not os.path.exists(path): ...
Return the string representation of a public key in the pki-directory def get_pub_str(self, name='master'): ''' Return the string representation of a public key in the pki-directory ''' path = os.path.join(self.opts['pki_dir'], name + '.pub') ...
Ask for this client to reconnect to the origin This function will de-dupe all calls here and return a *single* future for the sign-in-- whis way callers can all assume there aren't others def authenticate(self, callback=None): ''' Ask for this client to reconnect to the origin ...
Authenticate with the master, this method breaks the functional paradigm, it will update the master information from a fresh sign in, signing in can occur as often as needed to keep up with the revolving master AES key. :rtype: Crypticle :returns: A crypticle used for encryption...
Send a sign in request to the master, sets the key information and returns a dict containing the master publish interface to bind to and the decrypted aes key for transport decryption. :param int timeout: Number of seconds to wait before timing out the sign-in request :param bool safe: ...
Return keypair object for the minion. :rtype: Crypto.PublicKey.RSA._RSAobj :return: The RSA keypair def get_keys(self): ''' Return keypair object for the minion. :rtype: Crypto.PublicKey.RSA._RSAobj :return: The RSA keypair ''' # Make sure all key paren...
Generates the payload used to authenticate with the master server. This payload consists of the passed in id_ and the ssh public key to encrypt the AES key sent back from the master. :return: Payload dictionary :rtype: dict def minion_sign_in_payload(self): ''' Generate...
This function is used to decrypt the AES seed phrase returned from the master server. The seed phrase is decrypted with the SSH RSA host key. Pass in the encrypted AES key. Returns the decrypted AES seed key, a string :param dict payload: The incoming payload. This is a diction...
Wraps the verify_signature method so we have additional checks. :rtype: bool :return: Success or failure of public key verification def verify_pubkey_sig(self, message, sig): ''' Wraps the verify_signature method so we have additional checks. :rtype: bool ...
Checks if both master and minion either sign (master) and verify (minion). If one side does not, it should fail. :param dict payload: The incoming payload. This is a dictionary which may have the following keys: 'aes': The shared AES key 'enc': The format of the message. ('clear...
Return the AES key received from the master after the minion has been successfully authenticated. :param dict payload: The incoming payload. This is a dictionary which may have the following keys: 'aes': The shared AES key 'enc': The format of the message. ('clear', 'pub', etc) ...
Verify that the master is the same one that was previously accepted. :param dict payload: The incoming payload. This is a dictionary which may have the following keys: 'aes': The shared AES key 'enc': The format of the message. ('clear', 'pub', etc) 'publish_port': The TCP p...
Authenticate with the master, this method breaks the functional paradigm, it will update the master information from a fresh sign in, signing in can occur as often as needed to keep up with the revolving master AES key. :rtype: Crypticle :returns: A crypticle used for encryption...
encrypt data with AES-CBC and sign it with HMAC-SHA256 def encrypt(self, data): ''' encrypt data with AES-CBC and sign it with HMAC-SHA256 ''' aes_key, hmac_key = self.keys pad = self.AES_BLOCK_SIZE - len(data) % self.AES_BLOCK_SIZE if six.PY2: data = data + ...
verify HMAC-SHA256 signature and decrypt data with AES-CBC def decrypt(self, data): ''' verify HMAC-SHA256 signature and decrypt data with AES-CBC ''' aes_key, hmac_key = self.keys sig = data[-self.SIG_SIZE:] data = data[:-self.SIG_SIZE] if six.PY3 and not isinst...
Serialize and encrypt a python object def dumps(self, obj): ''' Serialize and encrypt a python object ''' return self.encrypt(self.PICKLE_PAD + self.serial.dumps(obj))
Decrypt and un-serialize a python object def loads(self, data, raw=False): ''' Decrypt and un-serialize a python object ''' data = self.decrypt(data) # simple integrity check to verify that we got meaningful data if not data.startswith(self.PICKLE_PAD): retur...
Execute hiera and return the data def ext_pillar(minion_id, # pylint: disable=W0613 pillar, # pylint: disable=W0613 conf): ''' Execute hiera and return the data ''' cmd = 'hiera -c {0}'.format(conf) for key, val in six.iteritems(__grains__): if isinstance(val...
Gluster versions prior to 6 have a bug that requires tricking isatty. This adds "gluster> " to the output. Strip it off and produce clean xml for ElementTree. def _gluster_output_cleanup(result): ''' Gluster versions prior to 6 have a bug that requires tricking isatty. This adds "gluster> " to the ...
Perform a gluster --xml command and log result. def _gluster_xml(cmd): ''' Perform a gluster --xml command and log result. ''' # We will pass the command string as stdin to allow for much longer # command strings. This is especially useful for creating large volumes # where the list of bricks e...
Checks for python2.6 or python2.7 def _iter(root, term): ''' Checks for python2.6 or python2.7 ''' if sys.version_info < (2, 7): return root.getiterator(term) else: return root.iter(term)
Return peer status information The return value is a dictionary with peer UUIDs as keys and dicts of peer information as values. Hostnames are listed in one list. GlusterFS separates one of the hostnames but the only reason for this seems to be which hostname happens to be used first in peering. C...
Add another node into the peer list. name The remote host to probe. CLI Example: .. code-block:: bash salt 'one.gluster.*' glusterfs.peer two GLUSTER direct CLI example (to show what salt is sending to gluster): $ gluster peer probe ftp2 GLUSTER CLI 3.4.4 return exampl...
Create a glusterfs volume name Name of the gluster volume bricks Bricks to create volume from, in <peer>:<brick path> format. For \ multiple bricks use list format: '["<peer1>:<brick1>", \ "<peer2>:<brick2>"]' stripe Stripe count, the number of bricks should be a m...
List configured volumes CLI Example: .. code-block:: bash salt '*' glusterfs.list_volumes def list_volumes(): ''' List configured volumes CLI Example: .. code-block:: bash salt '*' glusterfs.list_volumes ''' root = _gluster_xml('volume list') if not _gluster_o...
Check the status of a gluster volume. name Volume name CLI Example: .. code-block:: bash salt '*' glusterfs.status myvolume def status(name): ''' Check the status of a gluster volume. name Volume name CLI Example: .. code-block:: bash salt '*' glu...
.. versionadded:: 2015.8.4 Return gluster volume info. name Optional name to retrieve only information of one volume CLI Example: .. code-block:: bash salt '*' glusterfs.info def info(name=None): ''' .. versionadded:: 2015.8.4 Return gluster volume info. name ...
Start a gluster volume name Volume name force Force the volume start even if the volume is started .. versionadded:: 2015.8.4 CLI Example: .. code-block:: bash salt '*' glusterfs.start mycluster def start_volume(name, force=False): ''' Start a gluster volume...
Stop a gluster volume name Volume name force Force stop the volume .. versionadded:: 2015.8.4 CLI Example: .. code-block:: bash salt '*' glusterfs.stop_volume mycluster def stop_volume(name, force=False): ''' Stop a gluster volume name Volume n...
Deletes a gluster volume target Volume to delete stop : True If ``True``, stop volume before delete CLI Example: .. code-block:: bash salt '*' glusterfs.delete_volume <volume> def delete_volume(target, stop=True): ''' Deletes a gluster volume target Vol...
Add brick(s) to an existing volume name Volume name bricks List of bricks to add to the volume CLI Example: .. code-block:: bash salt '*' glusterfs.add_volume_bricks <volume> <bricks> def add_volume_bricks(name, bricks): ''' Add brick(s) to an existing volume n...
Set quota to glusterfs volume. name Name of the gluster volume path Folder path for restriction in volume ("/") size Hard-limit size of the volume (MB/GB) enable_quota Enable quota before set up restriction CLI Example: .. code-block:: bash salt '*'...