Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

DeviceFlags: number
PluginFlags: number
ReleaseFlags: number

Variables

DBUS_INTERFACE: string
DBUS_PATH: string
DBUS_SERVICE: string
DEVICE_FLAG_ADD_COUNTERPART_GUIDS: number
DEVICE_FLAG_ANOTHER_WRITE_REQUIRED: number
DEVICE_FLAG_BACKUP_BEFORE_INSTALL: number
DEVICE_FLAG_CAN_VERIFY: number
DEVICE_FLAG_CAN_VERIFY_IMAGE: number
DEVICE_FLAG_DUAL_IMAGE: number
DEVICE_FLAG_ENSURE_SEMVER: number
DEVICE_FLAG_HAS_MULTIPLE_BRANCHES: number
DEVICE_FLAG_HISTORICAL: number
DEVICE_FLAG_IGNORE_VALIDATION: number
DEVICE_FLAG_INSTALL_ALL_RELEASES: number
DEVICE_FLAG_INSTALL_PARENT_FIRST: number
DEVICE_FLAG_INTERNAL: number
DEVICE_FLAG_IS_BOOTLOADER: number
DEVICE_FLAG_LOCKED: number
DEVICE_FLAG_MD_SET_ICON: number
DEVICE_FLAG_MD_SET_NAME: number
DEVICE_FLAG_MD_SET_NAME_CATEGORY: number
DEVICE_FLAG_MD_SET_VERFMT: number
DEVICE_FLAG_NEEDS_ACTIVATION: number
DEVICE_FLAG_NEEDS_BOOTLOADER: number
DEVICE_FLAG_NEEDS_REBOOT: number
DEVICE_FLAG_NEEDS_SHUTDOWN: number
DEVICE_FLAG_NONE: number
DEVICE_FLAG_NOTIFIED: number
DEVICE_FLAG_NO_AUTO_INSTANCE_IDS: number
DEVICE_FLAG_NO_GUID_MATCHING: number
DEVICE_FLAG_ONLY_OFFLINE: number
DEVICE_FLAG_ONLY_SUPPORTED: number
DEVICE_FLAG_REGISTERED: number
DEVICE_FLAG_REPORTED: number
DEVICE_FLAG_REQUIRE_AC: number
DEVICE_FLAG_SELF_RECOVERY: number
DEVICE_FLAG_SKIPS_RESTART: number
DEVICE_FLAG_SUPPORTED: number
DEVICE_FLAG_TRUSTED: number
DEVICE_FLAG_UPDATABLE: number
DEVICE_FLAG_UPDATABLE_HIDDEN: number
DEVICE_FLAG_USABLE_DURING_UPDATE: number
DEVICE_FLAG_USE_RUNTIME_VERSION: number
DEVICE_FLAG_VERSION_CHECK_REQUIRED: number
DEVICE_FLAG_WAIT_FOR_REPLUG: number
DEVICE_FLAG_WILL_DISAPPEAR: number
DEVICE_ID_ANY: string
PLUGIN_FLAG_CAPSULES_UNSUPPORTED: number
PLUGIN_FLAG_CLEAR_UPDATABLE: number
PLUGIN_FLAG_DISABLED: number
PLUGIN_FLAG_EFIVAR_NOT_MOUNTED: number
PLUGIN_FLAG_ESP_NOT_FOUND: number
PLUGIN_FLAG_FAILED_OPEN: number
PLUGIN_FLAG_LEGACY_BIOS: number
PLUGIN_FLAG_NONE: number
PLUGIN_FLAG_NO_HARDWARE: number
PLUGIN_FLAG_UNLOCK_REQUIRED: number
PLUGIN_FLAG_USER_WARNING: number
RELEASE_FLAG_BLOCKED_APPROVAL: number
RELEASE_FLAG_BLOCKED_VERSION: number
RELEASE_FLAG_IS_ALTERNATE_BRANCH: number
RELEASE_FLAG_IS_DOWNGRADE: number
RELEASE_FLAG_IS_UPGRADE: number
RELEASE_FLAG_NONE: number
RELEASE_FLAG_TRUSTED_METADATA: number
RELEASE_FLAG_TRUSTED_PAYLOAD: number
RESULT_KEY_APPSTREAM_ID: string
RESULT_KEY_BRANCH: string
RESULT_KEY_CATEGORIES: string
RESULT_KEY_CHECKSUM: string
RESULT_KEY_CREATED: string
RESULT_KEY_DESCRIPTION: string
RESULT_KEY_DETACH_CAPTION: string
RESULT_KEY_DETACH_IMAGE: string
RESULT_KEY_DETAILS_URL: string
RESULT_KEY_DEVICE_ID: string
RESULT_KEY_FILENAME: string
RESULT_KEY_FLAGS: string
RESULT_KEY_FLASHES_LEFT: string
RESULT_KEY_GUID: string
RESULT_KEY_HOMEPAGE: string
RESULT_KEY_HSI_LEVEL: string
RESULT_KEY_HSI_RESULT: string
RESULT_KEY_ICON: string
RESULT_KEY_INSTALL_DURATION: string
RESULT_KEY_INSTANCE_IDS: string
RESULT_KEY_ISSUES: string
RESULT_KEY_LICENSE: string
RESULT_KEY_LOCATIONS: string
RESULT_KEY_METADATA: string
RESULT_KEY_MODIFIED: string
RESULT_KEY_NAME: string
RESULT_KEY_NAME_VARIANT_SUFFIX: string
RESULT_KEY_PARENT_DEVICE_ID: string
RESULT_KEY_PLUGIN: string
RESULT_KEY_PROTOCOL: string
RESULT_KEY_RELEASE: string
RESULT_KEY_REMOTE_ID: string
RESULT_KEY_SERIAL: string
RESULT_KEY_SIZE: string
RESULT_KEY_SOURCE_URL: string
RESULT_KEY_STATUS: string
RESULT_KEY_SUMMARY: string
RESULT_KEY_TRUST_FLAGS: string
RESULT_KEY_UPDATE_ERROR: string
RESULT_KEY_UPDATE_IMAGE: string
RESULT_KEY_UPDATE_MESSAGE: string
RESULT_KEY_UPDATE_STATE: string
RESULT_KEY_URGENCY: string
RESULT_KEY_URI: string
RESULT_KEY_VENDOR: string
RESULT_KEY_VENDOR_ID: string
RESULT_KEY_VERSION: string
RESULT_KEY_VERSION_BOOTLOADER: string
RESULT_KEY_VERSION_BOOTLOADER_RAW: string
RESULT_KEY_VERSION_FORMAT: string
RESULT_KEY_VERSION_LOWEST: string
RESULT_KEY_VERSION_LOWEST_RAW: string
RESULT_KEY_VERSION_RAW: string
SECURITY_ATTR_ID_ACPI_DMAR: string
SECURITY_ATTR_ID_ENCRYPTED_RAM: string
SECURITY_ATTR_ID_FWUPD_ATTESTATION: string
SECURITY_ATTR_ID_FWUPD_PLUGINS: string
SECURITY_ATTR_ID_FWUPD_UPDATES: string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_ACM: string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_ENABLED: string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_OTP: string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_POLICY: string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_VERIFIED: string
SECURITY_ATTR_ID_INTEL_CET_ACTIVE: string
SECURITY_ATTR_ID_INTEL_CET_ENABLED: string
SECURITY_ATTR_ID_INTEL_DCI_ENABLED: string
SECURITY_ATTR_ID_INTEL_DCI_LOCKED: string
SECURITY_ATTR_ID_INTEL_SMAP: string
SECURITY_ATTR_ID_IOMMU: string
SECURITY_ATTR_ID_KERNEL_LOCKDOWN: string
SECURITY_ATTR_ID_KERNEL_SWAP: string
SECURITY_ATTR_ID_KERNEL_TAINTED: string
SECURITY_ATTR_ID_MEI_MANUFACTURING_MODE: string
SECURITY_ATTR_ID_MEI_OVERRIDE_STRAP: string
SECURITY_ATTR_ID_MEI_VERSION: string
SECURITY_ATTR_ID_SPI_BIOSWE: string
SECURITY_ATTR_ID_SPI_BLE: string
SECURITY_ATTR_ID_SPI_SMM_BWP: string
SECURITY_ATTR_ID_SUSPEND_TO_IDLE: string
SECURITY_ATTR_ID_SUSPEND_TO_RAM: string
SECURITY_ATTR_ID_TPM_RECONSTRUCTION_PCR0: string
SECURITY_ATTR_ID_TPM_VERSION_20: string
SECURITY_ATTR_ID_UEFI_PK: string
SECURITY_ATTR_ID_UEFI_SECUREBOOT: string

Functions

  • build_history_report_json(devices: Fwupd.Device[]): string
  • Builds a JSON report for the list of devices. No filtering is done on the devices array, and it is expected that the caller will filter to something sane, e.g. %FWUPD_DEVICE_FLAG_REPORTED at the bare minimum.

    Parameters

    Returns string

  • build_machine_id(salt: string): string
  • Gets a salted hash of the /etc/machine-id contents. This can be used to identify a specific machine. It is not possible to recover the original machine-id from the machine-hash.

    Parameters

    • salt: string

      The salt, or %NULL for none

    Returns string

  • build_user_agent(package_name: string, package_version: string): string
  • Builds a user-agent to use for the download.

    Supplying harmless details to the server means it knows more about each client. This allows the web service to respond in a different way, for instance sending a different metadata file for old versions of fwupd, or returning an error for Solaris machines.

    Before freaking out about theoretical privacy implications, much more data than this is sent to each and every website you visit.

    Rather that using this function you should use fwupd_client_set_user_agent_for_package() which uses the runtime version of the daemon rather than the build-time version.

    Parameters

    • package_name: string

      client program name, e.g. "gnome-software"

    • package_version: string

      client program version, e.g. "3.28.1"

    Returns string

  • checksum_format_for_display(checksum: string): string
  • checksum_get_best(checksums: string[]): string
  • checksum_get_by_kind(checksums: string[], kind: ChecksumType): string
  • guid_from_string(guidstr: string, guid: number, flags: GuidFlags): boolean
  • Converts a string GUID into its binary encoding. All string GUIDs are formatted as big endian but on-disk can be encoded in different ways.

    Parameters

    • guidstr: string

      a GUID, e.g. 00112233-4455-6677-8899-aabbccddeeff

    • guid: number

      a #fwupd_guid_t, or NULL to just check the GUID

    • flags: GuidFlags

      some %FwupdGuidFlags, e.g. %FWUPD_GUID_FLAG_MIXED_ENDIAN

    Returns boolean

  • guid_hash_data(data: number, datasz: number, flags: GuidFlags): string
  • Returns a GUID for some data. This uses a hash and so even small differences in the data will produce radically different return values.

    The implementation is taken from RFC4122, Section 4.1.3; specifically using a type-5 SHA-1 hash.

    Parameters

    • data: number

      data to hash

    • datasz: number

      length of data

    • flags: GuidFlags

      some %FwupdGuidFlags, e.g. %FWUPD_GUID_FLAG_NAMESPACE_MICROSOFT

    Returns string

  • guid_hash_string(str: string): string
  • Returns a GUID for a given string. This uses a hash and so even small differences in the str will produce radically different return values.

    The default implementation is taken from RFC4122, Section 4.1.3; specifically using a type-5 SHA-1 hash with a DNS namespace. The same result can be obtained with this simple python program:

    #!/usr/bin/python import uuid print uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')

    Parameters

    • str: string

      A source string to use as a key

    Returns string

  • guid_is_valid(guid: string): boolean
  • Checks the string is a valid GUID.

    Parameters

    • guid: string

      string to check, e.g. 00112233-4455-6677-8899-aabbccddeeff

    Returns boolean

  • guid_to_string(guid: number, flags: GuidFlags): string
  • Returns a text GUID of mixed or BE endian for a packed buffer.

    Parameters

    • guid: number

      a #fwupd_guid_t to read

    • flags: GuidFlags

      some %FwupdGuidFlags, e.g. %FWUPD_GUID_FLAG_MIXED_ENDIAN

    Returns string

  • keyring_kind_from_string(keyring_kind: string): KeyringKind
  • keyring_kind_to_string(keyring_kind: KeyringKind): string
  • trust_flag_from_string(trust_flag: string): TrustFlags
  • trust_flag_to_string(trust_flag: TrustFlags): string
  • update_state_from_string(update_state: string): UpdateState
  • update_state_to_string(update_state: UpdateState): string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method