blob: d4984ebaf70af81e8394eb84ea2f7b3787723149 [file] [log] [blame]
# Copyright 2014 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import logging, os
import time
from autotest_lib.client.common_lib import error
_PASSWD_FILE = '/var/tmp/tpm_password'
_RM_FILES = ['/home/chronos/.oobe_completed',
'/home/chronos/Local\ State',
_RM_DIRS = ['/home/.shadow/*',
class NoTPMPasswordException(Exception):
"""No TPM Password could be found."""
def TPMStatus(client):
"""Returns a dictionary with TPM status.
@param client: client object to run commands on.
out ='cryptohome --action=tpm_status').stdout.strip()
out = out.replace('TPM ', '')
lines = out.split('\n')
status = {}
for item in lines:
item = item.split(':')
if not item[0]:
if len(item) == 1:
item = map(lambda x : x.strip(), item)
item[1] = True if item[1] == 'true' else item[1]
item[1] = False if item[1] == 'false' else item[1]
status[item[0]] = item[1]
return status
def IsTPMAvailable(client):
"""Returns True if the TPM is unowned and enabled.
@param client: client object to run commands on.
status = TPMStatus(client)
return status['Enabled'] and not status['Owned']
def ClearTPMServer(client, out_dir):
"""Clears the TPM and reboots from a server-side autotest.
@param client: client object to run commands on.
@param out_dir: temporary directory to store the retrieved password file.
if IsTPMAvailable(client):
logging.debug('TPM is not owned')
return'stop ui')
password = TPMStatus(client)['Password']
if not password:
client.get_file(_PASSWD_FILE, out_dir)
except error.AutoservRunError:
raise NoTPMPasswordException(
'TPM Password file %s doesn\'t exist, falling back on '
'clear_tpm_owner_request to clear the TPM. You may '
'need to have the firmware clear the TPM, for instance '
'by toggling the dev switch.' % _PASSWD_FILE)
with open(os.path.join(out_dir,
os.path.basename(_PASSWD_FILE))) as f:
password =
if not password:
raise NoTPMPasswordException(
'TPM Password file %s empty, falling back on '
'clear_tpm_owner_request to clear the TPM. You may need to '
'have the firmware clear the TPM, for instance by toggling '
'the dev switch.' % _PASSWD_FILE)
res ='tpm_clear --pass ' + password).stdout.strip()
except NoTPMPasswordException as e:
logging.warn(e.args[0])'crossystem clear_tpm_owner_request=1')
def ClearTPMOwnerRequest(client, wait_for_ready=False, timeout=60):
"""Clears the TPM using crossystem command.
@param client: client object to run commands on.
@param wait_for_ready: wait until the TPM status is ready
@param timeout: number of seconds to wait for the TPM to become ready.
if not'crossystem clear_tpm_owner_request=1',
ignore_status=True).exit_status == 0:
raise error.TestFail('Unable to clear TPM.')
if wait_for_ready:
status = ''
end_time = time.time() + timeout
# Wait for cryptohome to send a successful reply.
while 'GetTpmStatus success' not in status and time.time() < end_time:
status ='cryptohome --action=tpm_more_status',
def ClearTPMIfOwned(client):
"""Clear the TPM only if device is already owned.
@param client: client object to run commands on."""
tpm_status = TPMStatus(client)'TPM status: %s', tpm_status)
if tpm_status['Owned']:'Clearing TPM because this device is owned.')
def CleanupAndReboot(client):
"""Cleanup and reboot the device.
@param client: client object to run commands on.
full_rm = 'sudo rm -rf ' + ' '.join(_RM_FILES + _RM_DIRS), ignore_status=True)'sync', ignore_status=True)