Search is not available for this dataset
text
stringlengths
75
104k
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(oldkey, newkey)
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 reasonable default minion = { 'master': 'salt', ...
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 options are Null, let's set a reasonable default master.update( ...
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, default_flow_style=False)
def bootstrap(vm_, opts=None): ''' 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. ''' if opts is None: opts = __opts__ deploy_config = salt.config.get_cloud_conf...
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_cloud_config_value( 'ssh_username', vm_, opts ) if not isinsta...
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(**kwargs) if not isinstance(respo...
def wait_for_port(host, port=22, timeout=900, gateway=None): ''' 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, de...
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-REDACTED-XXX' //{1}".format( username, ...
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) return None, None, ret_code service_name = 'PS-E...
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_count = 0 while True: try_count += 1 ...
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.time() try_count = 0 while True: try_...
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, timeout=timeout) start = time.time() l...
def validate_windows_cred_winexe(host, username='Administrator', password=None, retries=10, retry_delay=1): ''' Check if the windows credentials are valid ''' cmd = "winexe -U '{0}%{1}' //{2} \"hostna...
def validate_windows_cred(host, username='Administrator', password=None, retries=10, retry_delay=1): ''' Check if the windows credentials are valid ''' for i in range(retries): ret_code = 1 ...
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', hard_timeout=None): ''' Wait until ssh connection can be...
def deploy_windows(host, port=445, timeout=900, username='Administrator', password=None, name=None, sock_dir=None, conf_file=None, start_action=None, ...
def deploy_script(host, port=22, timeout=900, username='root', password=None, key_filename=None, script=None, name=None, sock_dir=None, provider=None, ...
def run_inline_script(host, name=None, port=22, timeout=900, username='root', key_filename=None, inline_script=None, ssh_timeout=15, display_ssh...
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 that tag ''' ret = {} keys = [] use_defaults = True for ktag in __opts__.get('filter_events', {}): if tag != kta...
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: # We're using at...
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() os.write(tmpfd, contents) ...
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': return sftp_file(dest_path, contents, kwargs, local_file) return scp_file(d...
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, stderr=subprocess.PIPE, stdout=subprocess.PIP...
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 out session.protocol.transport.build_session() r = session....
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 = 'sudo {0}'.format(command) log...
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 commands ''' event = salt.utils.event.SaltEvent('master', sock_dir, listen=True) starttime = time.mktime(time.localtime...
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
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 return True addr = ip_to_int(ip) if 167772160 < addr < 184549375...
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 characters not supported by this cloud provider. ' '...
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: known_hosts = '{0}/.ssh/known_hos...
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 must be called ' 'with -f or --function.' ) if 'e...
def lock_file(filename, interval=.5, timeout=15): ''' 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. ''' log.trace('Attempting to obtain lock for %s',...
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 lock for %s', filename) lock = filename + '.lock' try: os.remove(lock) except OSError as exc: log...
def cachedir_index_add(minion_id, profile, driver, provider, base=None): ''' 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 ...
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) index_file = os.path.join(base, 'index.p') lock_file(index_file) if os.path.exists(index_file): ...
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, 'requested'), os.path.join(base, 'active')) for dir_ in ...
def request_minion_cachedir( minion_id, opts=None, fingerprint='', pubkey=None, provider=None, base=None, ): ''' 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 no...
def change_minion_cachedir( minion_id, cachedir, data=None, base=None, ): ''' 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. Ex...
def activate_minion_cachedir(minion_id, base=None): ''' 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. ''' if base is None: base = ...
def delete_minion_cachedir(minion_id, provider, opts, base=None): ''' 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. ''' if isinstance(opts, dict): __opts__.update(opts) if ...
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 themselves. This is the cloud cache version of list_nodes_full(). ''' if opts is None: opts = __opts__ if opts.get('update_cachedir', Fal...
def update_bootstrap(config, url=None): ''' 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 ''' default_url = config.get('bootstrap_script_url', ...
def cache_node_list(nodes, provider, opts): ''' 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 ''' if 'update_cachedir' not in opts or not opts['update_cachedir']: ret...
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']: return if not os.path.exists(os.path.join(__opts__['ca...
def missing_node_cache(prov_dir, node_list, provider, opts): ''' 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/s...
def diff_node_cache(prov_dir, node, new_data, opts): ''' 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). .. cod...
def _strip_cache_events(data, opts): ''' 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 ...
def _salt_cloud_force_ascii(exc): ''' 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...
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-error return keyring.get_password(credential_id, username) except ImportError: ...
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 ImportError: log.error('Tried to store...
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 import keyring.errors # pylint: enable=import-error if passw...
def _unwrap_dict(dictionary, index_string): ''' Accepts index in form of a string Returns final value Example: dictionary = {'a': {'b': {'c': 'foobar'}}} index_string = 'a,b,c' returns 'foobar' ''' index = index_string.split(',') for k in index: dictionary =...
def run_func_until_ret_arg(fun, kwargs, fun_call=None, argument_being_watched=None, required_argument_response=None): ''' Waits until the function retrieves some required argument. NOTE: Tested with ec2 describe_volumes and describe_snapshots only. ''' status = None wh...
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_interface', vm_, opts, default=False, search_global=False ) if salt_host is False: ...
def check_key_path_and_mode(provider, key_path): ''' 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 th...
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 = salt.config.get_cloud_config_value( 'userdata_template', vm...
def remove_service(self, wait_timeout=10, sleep_wait=1): ''' 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 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 original. with salt.utils.files.set_umask(0o277): log.info('Rotatin...
def gen_keys(keydir, keyname, keysize, user=None, passphrase=None): ''' 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 ke...
def _get_key_with_evict(path, timestamp, passphrase): ''' 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 resu...
def get_rsa_key(path, passphrase): ''' 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 ...
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.MemoryBuffer(data) key = RSA.loa...
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: Signing message.') if HAS_M2: md = EVP.MessageDigest('sha1') ...
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.verify_signature: Loading public key') pubkey = get_rsa_pub_key(pubkey_path) log.debug('salt.crypt.veri...
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.files.fopen(pub_path) as fp_: mpub_64 = fp_.read() mpub_sig = sign_message(priv_path, mpub_64, ...
def private_encrypt(key, message): ''' 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 ''' if HAS_M2: ...
def public_decrypt(pub, message): ''' 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...
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): log.info('Generating %s keys: %s', name, self....
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') if not os.path.isfile(path): key = self.__get_keys() ...
def authenticate(self, callback=None): ''' 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 ''' # if an auth is in flight-- and not ...
def _authenticate(self): ''' 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 ...
def sign_in(self, timeout=60, safe=True, tries=1, channel=None): ''' 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: Numbe...
def get_keys(self): ''' Return keypair object for the minion. :rtype: Crypto.PublicKey.RSA._RSAobj :return: The RSA keypair ''' # Make sure all key parent directories are accessible user = self.opts.get('user', 'root') salt.utils.verify.check_path_travers...
def minion_sign_in_payload(self): ''' 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 decrypt_aes(self, payload, master_pub=True): ''' 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 ...
def verify_pubkey_sig(self, message, sig): ''' Wraps the verify_signature method so we have additional checks. :rtype: bool :return: Success or failure of public key verification ''' if self.opts['master_sign_key_name']: path = os.path.join(self.opts[...
def check_auth_deps(self, payload): ''' 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 k...
def extract_aes(self, payload, master_pub=True): ''' 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...
def verify_master(self, payload, master_pub=True): ''' 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 t...
def authenticate(self, _=None): # TODO: remove unused var ''' 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 ke...
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 + pad * chr(pad) else: data = data + s...
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 isinstance(data, bytes): data = salt.utils.stringutils...
def dumps(self, obj): ''' Serialize and encrypt a python object ''' return self.encrypt(self.PICKLE_PAD + self.serial.dumps(obj))
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): return {} load = self.serial.loads(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, six.string_types): cm...
def _gluster_output_cleanup(result): ''' 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. ''' ret = '' for line in result.splitlines(): if line.startswith('gluster>'): ...
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 exceeds 128 characters. if _get_version() < (3...
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)
def peer_status(): ''' 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 b...
def peer(name): ''' 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 GLU...
def create_volume(name, bricks, stripe=False, replica=False, device_vg=False, transport='tcp', start=False, force=False, arbiter=False): ''' Create a glusterfs volume name Name of the gluster volume bricks Bricks to create volume from, in <peer>:<brick path> format. F...
def list_volumes(): ''' List configured volumes CLI Example: .. code-block:: bash salt '*' glusterfs.list_volumes ''' root = _gluster_xml('volume list') if not _gluster_ok(root): return None results = [x.text for x in _iter(root, 'volume')] return results
def status(name): ''' Check the status of a gluster volume. name Volume name CLI Example: .. code-block:: bash salt '*' glusterfs.status myvolume ''' # Get volume status root = _gluster_xml('volume status {0}'.format(name)) if not _gluster_ok(root): # Most...
def info(name=None): ''' .. 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 ''' cmd = 'volume info' if name is not None: cmd += ' '...
def start_volume(name, force=False): ''' 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 ''' cmd = 'volu...
def stop_volume(name, force=False): ''' 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 ''' volinfo = info() if name not in v...
def delete_volume(target, stop=True): ''' 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> ''' volinfo = info() if target not in...
def add_volume_bricks(name, bricks): ''' 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> ''' volinfo = info() if name ...
def set_quota_volume(name, path, size, enable_quota=False): ''' 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 r...