Windows.System.Profile: add Remarks to HardwareToken, SystemIdentification, AnalyticsVersionInfo, HardwareIdentification#2524
Open
GrantMeStrength wants to merge 5 commits intodocsfrom
Conversation
prmerger-automator
bot
added
do-not-merge
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses ADO work item #311114 (GitHub issues #1700, #1701, #1743, #1747, #1783).
All additions are sourced from existing official documentation — no engineering SME was required.
Changes
HardwareToken.Signature (#1700)
Added Remarks explaining that the signature verifies the
Idwas generated by Windows, that verification uses the public key from theCertificateproperty, and that a nonce (if provided) protects against replay attacks. Links to the ASHWID guidance for the full cloud-side verification workflow.HardwareToken.Certificate (#1701)
Added Remarks documenting that the buffer is a PKCS#7 formatted certificate chain (not a single certificate), rooted at Microsoft Assurance Designation Root 2011, with leaf EKU OID
1.3.6.1.4.1.311.10.5.40. Notes that revocation checking should be enabled on the cloud service. Source: ASHWID guidance page.SystemIdentification.GetSystemIdForUser (#1743)
Added a note to the existing Remarks clarifying that this method returns a hardware-based identifier for correlation purposes. For accessing current-user properties (display name, account name, etc.), use
Windows.System.User.GetDefault(available from Windows 10, version 2104) instead.AnalyticsVersionInfo.DeviceFamily (#1747)
Added a table of currently defined device family values (
Windows.Desktop,Windows.Holographic,Windows.IoT,Windows.Mobile,Windows.Team,Windows.Universal,Windows.Xbox) with a link to the device families overview. Retained the existing caveat that this property is for analytics only and values may change. Source: Device families overview.HardwareIdentification (#1783)
Added Remarks clarifying that an ASHWID can contain multiple records of the same component type (e.g., three disks produce three disk records; a docked tablet adds extra network and audio records), and describing the 4-byte group format. Source: ASHWID guidance page.