dbus/login_manager/dbus-constants.h

// Copyright 2015 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SYSTEM_API_DBUS_LOGIN_MANAGER_DBUS_CONSTANTS_H_
#define SYSTEM_API_DBUS_LOGIN_MANAGER_DBUS_CONSTANTS_H_

namespace login_manager {
const char kSessionManagerInterface[] = "org.chromium.SessionManagerInterface";
const char kSessionManagerServicePath[] = "/org/chromium/SessionManager";
const char kSessionManagerServiceName[] = "org.chromium.SessionManager";
// Methods
const char kSessionManagerEmitLoginPromptVisible[] = "EmitLoginPromptVisible";
const char kSessionManagerEmitAshInitialized[] = "EmitAshInitialized";
const char kSessionManagerEnableChromeTesting[] = "EnableChromeTesting";
const char kSessionManagerSaveLoginPassword[] = "SaveLoginPassword";
const char kSessionManagerLoginScreenStorageStore[] = "LoginScreenStorageStore";
const char kSessionManagerLoginScreenStorageRetrieve[] =
    "LoginScreenStorageRetrieve";
const char kSessionManagerLoginScreenStorageListKeys[] =
    "LoginScreenStorageListKeys";
const char kSessionManagerLoginScreenStorageDelete[] =
    "LoginScreenStorageDelete";
const char kSessionManagerStartSession[] = "StartSession";
const char kSessionManagerStartSessionEx[] = "StartSessionEx";
const char kSessionManagerStopSession[] = "StopSession";
const char kSessionManagerStopSessionWithReason[] = "StopSessionWithReason";
const char kSessionManagerLoadShillProfile[] = "LoadShillProfile";
const char kSessionManagerRestartJob[] = "RestartJob";
const char kSessionManagerStorePolicyEx[] = "StorePolicyEx";
const char kSessionManagerRetrievePolicyEx[] = "RetrievePolicyEx";
const char kSessionManagerRetrieveSessionState[] = "RetrieveSessionState";
const char kSessionManagerRetrieveActiveSessions[] = "RetrieveActiveSessions";
const char kSessionManagerRetrievePrimarySession[] = "RetrievePrimarySession";
const char kSessionManagerStartTPMFirmwareUpdate[] = "StartTPMFirmwareUpdate";
const char kSessionManagerStartDeviceWipe[] = "StartDeviceWipe";
const char kSessionManagerStartRemoteDeviceWipe[] = "StartRemoteDeviceWipe";
const char kSessionManagerClearForcedReEnrollmentVpd[] =
    "ClearForcedReEnrollmentVpd";
const char kSessionManagerUnblockDevModeForEnrollment[] =
    "UnblockDevModeForEnrollment";
const char kSessionManagerUnblockDevModeForInitialStateDetermination[] =
    "UnblockDevModeForInitialStateDetermination";
const char kSessionManagerUnblockDevModeForCarrierLock[] =
    "UnblockDevModeForCarrierLock";
const char kSessionManagerLockScreen[] = "LockScreen";
const char kSessionManagerHandleLockScreenShown[] = "HandleLockScreenShown";
const char kSessionManagerHandleLockScreenDismissed[] =
    "HandleLockScreenDismissed";
const char kSessionManagerIsScreenLocked[] = "IsScreenLocked";
const char kSessionManagerSetFlagsForUser[] = "SetFlagsForUser";
const char kSessionManagerSetFeatureFlagsForUser[] = "SetFeatureFlagsForUser";
const char kSessionManagerGetServerBackedStateKeys[] =
    "GetServerBackedStateKeys";
const char kSessionManagerGetPsmDeviceActiveSecret[] =
    "GetPsmDeviceActiveSecret";
const char kSessionManagerInitMachineInfo[] = "InitMachineInfo";
const char kSessionManagerCheckArcAvailability[] = "CheckArcAvailability";
const char kSessionManagerStartArcMiniContainer[] = "StartArcMiniContainer";
const char kSessionManagerUpgradeArcContainer[] = "UpgradeArcContainer";
const char kSessionManagerStopArcInstance[] = "StopArcInstance";
const char kSessionManagerSetArcCpuRestriction[] = "SetArcCpuRestriction";
const char kSessionManagerEmitArcBooted[] = "EmitArcBooted";
const char kSessionManagerGetArcStartTimeTicks[] = "GetArcStartTimeTicks";
const char kSessionManagerStartContainer[] = "StartContainer";
const char kSessionManagerStopContainer[] = "StopContainer";
const char kSessionManagerEnableAdbSideload[] = "EnableAdbSideload";
const char kSessionManagerQueryAdbSideload[] = "QueryAdbSideload";
const char kSessionManagerStartBrowserDataMigration[] =
    "StartBrowserDataMigration";
const char kSessionManagerStartBrowserDataBackwardMigration[] =
    "StartBrowserDataBackwardMigration";
// Signals
const char kLoginPromptVisibleSignal[] = "LoginPromptVisible";
const char kSessionStateChangedSignal[] = "SessionStateChanged";
// ScreenLock signals.
const char kScreenIsLockedSignal[] = "ScreenIsLocked";
const char kScreenIsUnlockedSignal[] = "ScreenIsUnlocked";
// Ownership API signals.
const char kOwnerKeySetSignal[] = "SetOwnerKeyComplete";
const char kPropertyChangeCompleteSignal[] = "PropertyChangeComplete";
// ARC instance signals.
const char kArcInstanceStopped[] = "ArcInstanceStopped";
const char kArcInstanceRebooted[] = "ArcInstanceRebooted";

// D-Bus error codes
namespace dbus_error {
#define INTERFACE "org.chromium.SessionManagerInterface"

const char kNone[] = INTERFACE ".None";
const char kInvalidParameter[] = INTERFACE ".InvalidParameter";
const char kArcCpuCgroupFail[] = INTERFACE ".ArcCpuCgroupFail";
const char kArcInstanceRunning[] = INTERFACE ".ArcInstanceRunning";
const char kArcContainerNotFound[] = INTERFACE ".ArcContainerNotFound";
const char kContainerStartupFail[] = INTERFACE ".ContainerStartupFail";
const char kContainerShutdownFail[] = INTERFACE ".ContainerShutdownFail";
const char kGetPeerCredsFailed[] = INTERFACE ".GetPeerCredsFailed";
const char kDeleteFail[] = INTERFACE ".DeleteFail";
const char kEmitFailed[] = INTERFACE ".EmitFailed";
const char kFwmpRemovalFailed[] = INTERFACE ".FwmpRemovalFailed";
const char kGetServiceFail[] = INTERFACE ".kGetServiceFail";
const char kInitMachineInfoFail[] = INTERFACE ".InitMachineInfoFail";
const char kInvalidAccount[] = INTERFACE ".InvalidAccount";
const char kInvalidArgs[] = INTERFACE ".InvalidArgs";
const char kLowFreeDisk[] = INTERFACE ".LowFreeDisk";
const char kNoOwnerKey[] = INTERFACE ".NoOwnerKey";
const char kNoUserNssDb[] = INTERFACE ".NoUserNssDb";
const char kNotAvailable[] = INTERFACE ".NotAvailable";
const char kNotStarted[] = INTERFACE ".NotStarted";
const char kNvramClearedReadFailed[] = INTERFACE ".NvramClearedReadFailed";
const char kNvramClearedUpdateFailed[] = INTERFACE ".NvramClearedUpdateFailed";
const char kPolicyInitFail[] = INTERFACE ".PolicyInitFail";
const char kPubkeySetIllegal[] = INTERFACE ".PubkeySetIllegal";
const char kPolicySignatureRequired[] = INTERFACE ".PolicySignatureRequired";
const char kSessionDoesNotExist[] = INTERFACE ".SessionDoesNotExist";
const char kSessionExists[] = INTERFACE ".SessionExists";
const char kSigDecodeFail[] = INTERFACE ".SigDecodeFail";
const char kSigEncodeFail[] = INTERFACE ".SigEncodeFail";
const char kStateKeysRequestFail[] = INTERFACE ".StateKeysRequestFail";
const char kSystemPropertyUpdateFailed[] =
    INTERFACE ".SystemPropertyUpdateFailed";
const char kTestingChannelError[] = INTERFACE ".TestingChannelError";
const char kUnknownPid[] = INTERFACE ".UnknownPid";
const char kVerifyFail[] = INTERFACE ".VerifyFail";
const char kVpdUpdateFailed[] = INTERFACE ".VpdUpdateFailed";

#undef INTERFACE
}  // namespace dbus_error

// Values
enum ContainerCpuRestrictionState {
  CONTAINER_CPU_RESTRICTION_FOREGROUND = 0,
  CONTAINER_CPU_RESTRICTION_BACKGROUND = 1,
  NUM_CONTAINER_CPU_RESTRICTION_STATES = 2,
};

enum class ArcContainerStopReason {
  // The ARC container is crashed.
  CRASH = 0,

  // Stopped by the user request, e.g. disabling ARC.
  USER_REQUEST = 1,

  // Session manager is shut down. So, ARC is also shut down along with it.
  SESSION_MANAGER_SHUTDOWN = 2,

  // Browser was shut down. ARC is also shut down along with it.
  BROWSER_SHUTDOWN = 3,

  // Disk space is too small to upgrade ARC.
  LOW_DISK_SPACE = 4,

  // Failed to upgrade ARC mini container into full container.
  // Note that this will be used if the reason is other than low-disk-space.
  UPGRADE_FAILURE = 5,
};

// The reason for stopping the session.
enum class SessionStopReason {
  // Force restart to restore active sessions.
  RESTORE_ACTIVE_SESSIONS = 0,

  // Stopped by user requesting sign out.
  REQUEST_FROM_SESSION_MANAGER = 1,

  // No owner found.
  OWNER_REQUIRED = 2,

  // Terms of service declined.
  TERMS_DECLINED = 3,

  // Failed to lock screen.
  FAILED_TO_LOCK = 4,

  // Suspend after Chrome restart.
  SUSPEND_AFTER_RESTART = 5,

  // ARC_ADB enabled.
  CROSTINI_ENABLE_ARC_ADB_REQUESTED = 6,

  // ARC requests device encryption update.
  ARC_MIGRATION_REQUESTED = 7,

  // ARC provision failed in kiosk mode.
  ARC_KIOSK_PROVISION_FAILED = 8,

  // Request to optimize memory usage.
  BACKGROUND_OPTIMIZATION_REQUESTED = 9,

  // Request to restart to apply updates.
  UPDATE_REQUESTED = 10,

  // Request to synchronize active directory credentials.
  ACTIVE_DIRECTORY_AUTH_REFRESH_REQUESTED = 11,

  // Request to apply new device requisition.
  NEW_DEVICE_REQUISITION_SET = 12,

  // Request to apply supervision.
  SUPERVISION_ENABLED = 13,

  // System locale changed.
  LOCALE_CHANGED = 14,

  // Special URL entered.
  SPECIAL_URL_PROCESSED = 15,

  // Demo app failed to launch.
  DEMO_APP_LAUNCH_FAILED = 16,

  // Browser shutted down or last browser window closed.
  BROWSER_SHUTDOWN = 17,

  // Interrupt signal (e.g. SIGINT) received.
  INTERRUPT_SIGNAL_RECEIVED = 18,

  // Enrollment failed.
  ENROLLMENT_FAILED = 19,

  // Enrollment finished.
  ENROLLMENT_COMPLETED = 20,

  // Failed to restore session.
  SESSION_RESTORE_FAILED = 21,

  // User is not allowed to start session.
  SESSION_USER_IS_NOT_ALLOWED = 22,

  // Session ended due to timeout.
  SESSION_TIMEOUT_REACHED = 23,

  // Request to apply new session flags.
  SESSION_NEW_FLAGS_REQUESTED = 24,

  // Multi-profiles session disabled for user.
  MULTIPROFILES_SESSION_DISABLED = 25,

  // Local account no longer available.
  DEVICE_LOCAL_ACCOUNT_POLICIES_WANISHED = 26,

  // User's policies were not loaded.
  LOAD_POLICIES_FAILED = 27,

  // Failed to lock to single user.
  LOCK_TO_SINGLE_USER_FAILED = 28,

  // Device was disabled.
  DEVICE_DISABLED = 29,

  // Request to start guest session.
  GUEST_LOGIN = 30,

  // Kiosk apps were removed.
  KIOSK_APPS_REMOVED = 31,

  // Kiosk app was closed.
  KIOSK_APP_CLOSED = 32,

  // Kiosk app launch was canceled.
  KIOSK_APP_LAUNCH_CANCELED = 33,

  // Kiosk app failed to start.
  KIOSK_APP_LAUNCH_FAILED = 34,

  // Kiosk app policy was not loaded.
  KIOSK_APP_POLICY_LOAD_FAILED = 35,

  // Kiosk app failed to authenticate.
  KIOSK_APP_AUTH_FAILED = 36,

  // Error received from Google Service.
  GOOGLE_SERVICE_AUTH_FAILED = 37,

  // User was removed.
  USER_REMOVED = 38,

  // User action to stop session.
  USER_REQUESTS_SIGNOUT = 39,

  // User action to stop session.
  USER_REQUESTS_RESTART = 40,

  // User action to stop session.
  USER_REQUESTS_RELAUNCH = 41,

  // User action to stop session.
  USER_REQUESTS_FACTORY_RESET = 42,

  // User action to stop session.
  USER_REQUESTS_TPM_FIRMWARE_UPDATE = 43,

  // Extension action to stop session.
  EXTENSION_REQUESTS = 44,
};

}  // namespace login_manager

#endif  // SYSTEM_API_DBUS_LOGIN_MANAGER_DBUS_CONSTANTS_H_