Method authenticate

src/spaceandtime/sxtuser.py:425–463

-------------------- Authenticate to the Space and Time network, and store access_token and refresh_token. Returns: bool: Success flag (True/False) indicating the call worked as expected. object: Access_Token if successful, otherwise an error object.

(self)

    def authenticate(self) -> tuple[bool, object]:
        """--------------------
        Authenticate to the Space and Time network, and store access_token and refresh_token.
        
        Returns:
            bool: Success flag (True/False) indicating the call worked as expected.
            object: Access_Token if successful, otherwise an error object.
        """
        if not ((self.user_id and self.private_key) or self.api_key):
            raise SxTArgumentError('Must have valid user_id and either api_key or private_key to authenticate.', logger=self.logger)
        success = False

        try: 
            if self.private_key and self.user_id:
                
                success, response = self.base_api.get_auth_challenge_token(user_id = self.user_id)
                if success:
                    challenge_token = response['authCode']
                    signed_challenge_token = self.key_manager.sign_message(challenge_token)
                    success, response = self.base_api.get_access_token(user_id = self.user_id, 
                                                                    challange_token = challenge_token, 
                                                                    signed_challange_token = signed_challenge_token,
                                                                    public_key = self.public_key)

            if not success and self.api_key:
                success, response = self.base_api.gateway_proxy_auth_apikey(self.api_key)

            # either way, continue on processing tokens
            if not success: raise SxTAuthenticationError(str(response), logger=self.logger)
            
            tokens = response
            if len( [v for v in tokens if v in ['accessToken','refreshToken','accessTokenExpires','refreshTokenExpires']] ) < 4:
                raise SxTAuthenticationError('Authentication produced incorrect / incomplete output', logger=self.logger)
        except SxTAuthenticationError as ex:
            return False, [ex]

        self.__settokens__(tokens['accessToken'], tokens['refreshToken'], tokens['accessTokenExpires'], tokens['refreshTokenExpires'])
        if self.user_id =='': self.get_user_network_info() # will set user_id if missing
        return True, self.access_token 


    def reauthenticate(self) -> str: