Method _authenticate

salt/crypt.py:1065–1209

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

(self)

        return future

    async 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
        :returns: A crypticle used for encryption operations
        """
        acceptance_wait_time = self.opts["acceptance_wait_time"]
        acceptance_wait_time_max = self.opts["acceptance_wait_time_max"]
        if not acceptance_wait_time_max:
            acceptance_wait_time_max = acceptance_wait_time
        creds = None

        with salt.channel.client.AsyncReqChannel.factory(
            self.opts, crypt="clear", io_loop=self.io_loop
        ) as channel:
            error = None
            attempts = 0
            # ``auth_retries`` caps the outer retry loop introduced for
            # issue #69442.  It defaults to ``0`` which preserves the
            # pre-3006.26 behavior of retrying forever; set it to a
            # positive integer to bail out with ``SaltClientError`` after
            # that many attempts.  This is intentionally opt-in on the
            # 3006.x LTS branch so an upgrade does not silently change
            # failure modes for long-disconnected minions.
            auth_retries = self.opts.get("auth_retries", 0)
            while True:
                # Give up a little time between connection attempts
                # to allow the IOLoop to run any other scheduled tasks.
                await asyncio.sleep(0.1)
                attempts += 1
                try:
                    creds = await self.sign_in(channel=channel)
                except SaltClientError as exc:
                    error = exc
                    break
                if creds == "retry":
                    if self.opts.get("detect_mode") is True:
                        error = SaltClientError("Detect mode is on")
                        break
                    if auth_retries > 0 and attempts >= auth_retries:
                        error = SaltClientError(
                            f"Failed to authenticate with the master after {attempts} attempts"
                        )
                        break
                    if self.opts.get("caller"):
                        # We have a list of masters, so we should break
                        # and try the next one in the list.
                        if self.opts.get("local_masters", None):
                            error = SaltClientError(
                                "Minion failed to authenticate"
                                " with the master, has the "
                                "minion key been accepted?"
                            )
                            break