Nintendo Switch Brew

NIM services: Difference between revisions

← Older editNewer edit →
Roblabla (talk | contribs)
151 edits
Add full interface name (imported from SwIPC)
(35 intermediate revisions by 6 users not shown)
Line 1: Line 1:
=nim=
= nim =
This is "nn::nim::detail::INetworkInstallManager".
This is "nn::nim::detail::INetworkInstallManager".


Line 6: Line 6:
! Cmd || Name
! Cmd || Name
|-
|-
| 1 ||  
| 0 || [[#CreateSystemUpdateTask]]
|-
| 1 || [[#DestroySystemUpdateTask]]
|-
| 2 || [[#ListSystemUpdateTask]]
|-
| 3 || RequestSystemUpdateTaskRun
|-
| 4 || [[#GetSystemUpdateTaskInfo]]
|-
| 5 || [[#CommitSystemUpdateTask]]
|-
| 6 || CreateNetworkInstallTask
|-
| 7 || DestroyNetworkInstallTask
|-
| 8 || ListNetworkInstallTask
|-
| 9 || RequestNetworkInstallTaskRun
|-
| 10 || [[#GetNetworkInstallTaskInfo]]
|-
| 11 || CommitNetworkInstallTask
|-
| 12 || RequestLatestSystemUpdateMeta
|-
| 14 || ListApplicationNetworkInstallTask
|-
| 15 || ListNetworkInstallTaskContentMeta
|-
| 16 || RequestLatestVersion
|-
| 17 || SetNetworkInstallTaskAttribute
|-
| 18 || AddNetworkInstallTaskContentMeta
|-
| 19 || [[#GetDownloadedSystemDataPath]]
|-
| 20 || CalculateNetworkInstallTaskRequiredSize
|-
| 21 || [[#IsExFatDriverIncluded]]
|-
| 22 || GetBackgroundDownloadStressTaskInfo
|-
| 23 || [2.0.0+] RequestDeviceAuthenticationToken
|-
| 24 || [2.0.0+] RequestGameCardRegistrationStatus
|-
| 25 || [2.0.0+] RequestRegisterGameCard
|-
| 26 || [2.0.0+] RequestRegisterNotificationToken
|-
| 27 || [2.0.0+] RequestDownloadTaskList
|-
| 28 || [2.0.0+] RequestApplicationControl
|-
| 29 || [2.0.0+] RequestLatestApplicationControl
|-
| 30 || [2.0.0+] RequestVersionList
|-
| 31 || [2.0.0+] CreateApplyDeltaTask
|-
| 32 || [2.0.0+] DestroyApplyDeltaTask
|-
| 33 || [2.0.0+] ListApplicationApplyDeltaTask
|-
| 34 || [2.0.0+] RequestApplyDeltaTaskRun
|-
| 35 || [2.0.0+] [[#GetApplyDeltaTaskInfo]]
|-
| 36 || [2.0.0+] ListApplyDeltaTask
|-
| 37 || [2.0.0+] CommitApplyDeltaTask
|-
| 38 || [2.0.0+] CalculateApplyDeltaTaskRequiredSize
|-
| 39 || [2.0.0+] PrepareShutdown
|-
| 40 || [2.0.0+] ListApplyDeltaTask2
|-
| 41 || [2.0.0+] ClearNotEnoughSpaceStateOfApplyDeltaTask
|-
| 42 || [3.0.0+]
|-
| 43 || [3.0.0+]
|-
| 44 || [3.0.0+]
|-
| 45 || [3.0.0+]
|-
| 46 || [3.0.0+]
|-
| 47 || [4.0.0+]
|-
| 48 || [4.0.0+]
|-
| 49 || [4.0.0+]
|-
| 50 || [4.0.0+]
|-
| 51 || [4.0.0+]
|-
| 52 || [4.0.0+]
|-
| 53 || [4.0.0+]
|-
| 54 || [4.0.0+]
|-
| 55 || [4.0.0+]
|-
| 56 || [4.0.0+]
|-
| 57 || [4.0.0+]
|-
| 58 || [4.0.0+]
|-
| 59 || [4.0.0+]
|-
| 60 || [4.0.0+]
|-
| 61 || [4.0.0+]
|-
| 62 || [4.0.0+]
|-
| 63 || [4.0.0+]
|-
| 64 || [4.0.0+]
|-
| 65 || [4.0.0+]
|-
| 66 || [4.0.0+]
|-
| 67 || [4.0.0+]
|-
| 68 || [4.0.0+]
|-
| 69 || [4.0.0+]
|-
| 70 || [4.0.0+]
|-
| 71 || [4.0.0+]
|-
| 72 || [4.0.0+]
|-
| 73 || [4.0.0+]
|-
| 74 || [4.0.0+]
|-
| 75 || [4.0.0+]
|-
| 76 || [4.0.0+]
|-
| 77 || [4.0.0+]
|-
| 78 || [4.0.0+]
|-
| 79 || [4.0.0+]
|-
| 80 || [4.0.0+]
|-
| 81 || [4.0.0+]
|-
| 82 || [4.0.0+]
|-
| 83 || [4.0.0+]
|-
| 84 || [5.0.0+]
|-
| 85 || [5.0.0+]
|-
| 86 || [5.0.0+]
|-
| 87 || [6.0.0+]
|-
| 88 || [6.0.0+]
|-
| 89 || [6.0.0+]
|-
| 90 || [6.0.0+]
|-
| 91 || [6.0.0+]
|-
| 92 || [6.0.0+]
|-
| 93 || [6.0.0+]
|-
| 94 || [6.0.0+]
|-
| 95 || [6.0.0+]
|-
| 96 || [6.0.0+]
|-
| 97 || [6.0.0+]
|-
| 98 || [6.0.0+]
|-
| 99 || [7.0.0+]
|-
| 100 || [9.0.0+]
|-
| 101 || [9.0.0+]
|-
| 102 || [9.0.0+]
|-
| 103 || [9.0.0+]
|-
| 104 || [9.0.0+]
|-
| 105 || [9.0.0+]
|-
| 106 || [9.0.0+]
|}
 
[5.0.0+] RequestGameCardRegistrationStatus/RequestRegisterGameCard removed 8-bytes of input, and now takes an additional type-0x5 input buffer.
 
[8.0.0+] Cmd76 now takes an additional 0x8-bytes of input.
 
== CreateSystemUpdateTask ==
Takes an input u32 firmware_variation, an u32 '''unk''', an input 0x10-byte struct, returns an output [[#SystemUpdateTask]].
 
Official sw sets '''unk''' to: <code>unk = inflag & 1 ? 0xC : 0x4</code>.
 
Structure of the input struct:
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || Unknown
|-
| 0x8 || 0x4 || Unknown
|-
| 0x9 || 0x1 || Unknown
|-
| 0xA || 0x1 || Unknown
|-
| 0xB || 0x5 || Padding?
|}
 
== DestroySystemUpdateTask ==
Takes an input [[#SystemUpdateTask]], no output.
 
== ListSystemUpdateTask ==
Takes a type-0x6 output buffer, for an array of [[#SystemUpdateTask]]. Returns an u32 for total output entries.
 
== GetSystemUpdateTaskInfo ==
Takes an input [[#SystemUpdateTask]], returns an output [[#SystemUpdateTaskInfo]].
 
== CommitSystemUpdateTask ==
Takes an input [[#SystemUpdateTask]], no output.
 
== GetNetworkInstallTaskInfo ==
Takes an input [[#NetworkInstallTask]], returns an output [[#NetworkInstallTaskInfo]].
 
== GetDownloadedSystemDataPath ==
Takes an input u64 titleID, a [[#SystemUpdateTask]], and an type-0x16 output buffer containing the [[Filesystem_services|ContentPath]].
 
Gets the FS ContentPath for the specified task and title.
 
== IsExFatDriverIncluded ==
Takes an input [[#SystemUpdateTask]], returns an output u8 bool flag.
 
== GetApplyDeltaTaskInfo ==
Takes an input [[#ApplyDeltaTask]], returns an output [[#ApplyDeltaTaskInfo]].
 
== SystemUpdateTask ==
This is a 0x10-byte struct.
 
== SystemUpdateTaskInfo ==
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x1 || Status
|-
| 0x1 || 0x7 || ?
|-
| 0x8 || 0x8 || Unknown
|-
| 0x10 || 0x8 || DownloadSize
|-
| 0x18 || 0x8 || ContentMetaId
|-
| 0x20 || 0x4 || Version
|-
| 0x24 || 0x4 || ?
|-
| 0x28 || 0x8 || Unknown
|-
| 0x30 || 0x8 || Unknown
|-
|-
| 2 ||  
| 0x38 || 0x8 || ?
|}
|}


==Cmd1==
This is a 0x28-byte struct. [3.0.0+] This is a 0x38-byte struct. [5.0.0+] This is a 0x40-byte struct.
Takes a 0x10-byte input struct, from the output of cmd2.


==Cmd2==
The 0x10-bytes at +0x8 are returned by [[NS_Services#GetDownloadProgress]].
Takes a type-0x6 output buffer, for an array of 0x10-byte entries. Returns an u32 for total output entries.


Doesn't return anything on a v2.1 system where sysupdate domains are blocked.
The two u64s at +0x28/+0x30 are used by [[NS_Services|NS]] to calculate "ThroughputKBps" for a SystemPlayReport.


=nim:shp=
== NetworkInstallTask ==
This is a 0x10-byte struct.
 
== NetworkInstallTaskInfo ==
This is a 0x28-byte struct. [3.0.0+] This is a 0x40-byte struct.
 
== ApplyDeltaTask ==
This is a 0x10-byte struct.
 
== ApplyDeltaTaskInfo ==
This is a 0x20-byte struct. [3.0.0+] This is a 0x30-byte struct.
 
= nim:shp =
This is "nn::nim::detail::IShopServiceManager".
This is "nn::nim::detail::IShopServiceManager".


=ntc=
{| class="wikitable" border="1"
This is "nn::ntc::detail::service::IStaticService".
|-
! Cmd || Name
|-
| 0 || RequestDeviceAuthenticationToken
|-
| 1 || [3.0.0+] RequestCachedDeviceAuthenticationToken
|-
| 100 || RequestRegisterDeviceAccount
|-
| 101 || RequestUnregisterDeviceAccount
|-
| 102 || RequestDeviceAccountStatus
|-
| 103 || GetDeviceAccountInfo
|-
| 104 || RequestDeviceRegistrationInfo
|-
| 105 || RequestTransferDeviceAccount
|-
| 106 || [3.0.0+] RequestSyncRegistration
|-
| 107 || [3.0.0+] IsOwnDeviceId
|-
| 200 || RequestRegisterNotificationToken
|-
| 300 || RequestUnlinkDevice
|-
| 301 || RequestUnlinkDeviceIntegrated
|-
| 302 || RequestLinkDevice
|-
| 303 || HasDeviceLink
|-
| 304 || [4.0.0+] RequestUnlinkDeviceAll
|-
| 305 || [4.0.0+] RequestCreateVirtualAccount
|-
| 306 || [4.0.0+] RequestDeviceLinkStatus
|-
| 400 || GetAccountByVirtualAccount
|-
| 401 || [6.0.0+] GetVirtualAccount
|-
| 500 || RequestSyncTicketLegacy ([1.0.0-8.1.0] RequestSyncTicket)
|-
| 501 || RequestDownloadTicket
|-
| 502 || [4.0.0+] [[#RequestDownloadTicketForPrepurchasedContents]]
|-
| 503 || [9.0.0+] RequestSyncTicket
|-
| 504 || [9.0.0+] RequestDownloadTicketForPrepurchasedContents2
|}
 
== RequestDownloadTicketForPrepurchasedContents ==
[6.0.0+] Now takes an additional 4-bytes of input.
 
= nim:eca =
This is "nn::nim::detail::IShopServiceAccessServerInterface".
 
This was added with [5.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CreateServerInterface
|-
| 1 || [6.0.0+] RefreshDebugAvailability
|-
| 2 || [6.0.0+] ClearDebugResponse
|-
| 3 || [6.0.0+] RegisterDebugResponse
|}
 
== IShopServiceAccessServer ==
This is "nn::nim::detail::IShopServiceAccessServer".
 
This was added with [5.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CreateAccessorInterface
|}
 
=== IShopServiceAccessor ===
This is "nn::nim::detail::IShopServiceAccessor".
 
This was added with [5.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CreateAsyncInterface
|}
 
==== IShopServiceAsync ====
This is "nn::nim::detail::IShopServiceAsync".


Presumably Network Time Sync?
This was added with [5.0.0+].


Network-time-sync uses the "<...>/time" HTTPS URL listed in the below Network section. This just returns an UTC Unix time string.
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Cancel
|-
| 1 || GetSize
|-
| 2 || Read
|-
| 3 || GetErrorCode
|-
| 4 || Request
|-
| 5 || Prepare
|}


=Network=
= nim:ecas =
* <nowiki>https://sun.hac.%%.d4c.nintendo.net/v1/system_update_meta?device_id=%016llx</nowiki>
This is "nn::nim::detail::IShopServiceAccessSystemInterface".
* <nowiki>https://aqua.hac.%%.d4c.nintendo.net/required_system_update_meta?device_id=%016llx</nowiki>
* <nowiki>https://%s.hac.%%.d4c.nintendo.net/t/%c/%016llx/%u?device_id=%016llx</nowiki> Returns content like the below URL. This is the content for [[NCA]]-type0. See below for %c. %016llx is titleID, %u is title-version.
* <nowiki>https://%s.hac.%%.d4c.nintendo.net/c/%c/%s</nowiki> Used for downloading content. First %s is atumn or atum. %c is one of: 'c', 'a', or 's'. %s is just the hex-string NcaId. The server also returns two HTTP headers: "X-Nintendo-Content-Hash: {entire lowercase hex-string of the content SHA256 hash}" and "X-Nintendo-Content-ID: {lowercase hex-string for NcaId}"
* <nowiki>https://superfly.hac.%%.d4c.nintendo.net/v1/t/%016llx/dv</nowiki> %016llx is titleID, only for eShop titles it appears. Returns .json title-info.
* <nowiki>https://superfly.hac.%%.d4c.nintendo.net/v1/a/%016llx/dv</nowiki> %016llx is titleID, only for eShop titles it appears. Output is similar to above URL.
* <nowiki>https://aauth-%.ndas.srv.nintendo.net/v1/time</nowiki>
* <nowiki>https://beach.hac.%.eshop.nintendo.net/v1/rom_cards?application_id=%016llx&rom_card_cert=%s</nowiki>
* <nowiki>https://beach.hac.%.eshop.nintendo.net/v1/rom_cards/register?application_id=%016llx&rom_card_cert=%s&expected_gold_point=%d</nowiki>
* <nowiki>https://beach.hac.%.eshop.nintendo.net/v1/my/devices/hac/link?lang=en</nowiki>
* <nowiki>https://beach.hac.%.eshop.nintendo.net/v1/my/virtual_account?lang=en</nowiki>
* <nowiki>https://tagaya.hac.%.eshop.nintendo.net/tagaya/hac_versionlist</nowiki>
* ...
* <nowiki>"https://dauth-%.ndas.srv.nintendo.net/v1/device_auth_token"</nowiki> CURLOPT_POSTFIELDS is set to the output from: snprintf(..., "system_version=%08x&client_id=%s", <byte-swapped first 3 bytes from [[System_Version_Title]] loaded via [[Settings_services|settings]] cmd>, "<hard-coded hex string>");
* <nowiki>https://ecs-%.hac.shop.nintendo.net/ecs/services/rest/AccountGetETickets</nowiki>
* <nowiki>https://ecs-%.hac.shop.nintendo.net/ecs/services/rest/GetAccountStatus</nowiki>
* <nowiki>https://ias-%.hac.shop.nintendo.net/ias/services/rest/Register</nowiki>
* <nowiki>https://ias-%.hac.shop.nintendo.net/ias/services/rest/GetChallenge</nowiki>
* <nowiki>https://ias-%.hac.shop.nintendo.net/ias/services/rest/Unregister</nowiki>
* <nowiki>https://ias-%.hac.shop.nintendo.net/ias/services/rest/GetRegistrationInfo</nowiki>
* <nowiki>https://ias-%.hac.shop.nintendo.net/ias/services/rest/CompleteETicketSync</nowiki>
* <nowiki>https://ias-%.hac.shop.nintendo.net/ias/services/rest/AccountTransfer</nowiki>
* <nowiki>https://ias-%.hac.shop.nintendo.net/ias/services/rest/SyncRegistration</nowiki>


These are not accessible without the required TLS client cert+privk, minus the time URL which can be accessed without any client cert+privk at all.
This was added with [7.0.0+].


The returned content data from CDN, for both system-titles and eShop-titles, is identical to the data readable by [[Content_Manager_services#ReadEntryRaw]].
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || RegisterSpecialClient
|-
| 1 || UnregisterSpecialClient
|}


While atumn seems to be for system-titles, and atum for eShop titles, the latter titles are accessible fine with atumn(with "/t/" for NCA-type0 at least).
= ntc =
This is "nn::ntc::detail::service::IStaticService".


'a' is used when an input u8 is not 0x3, otherwise 's' is used. This is [[Content_Manager_services#Title_Types|title-type]]? A seperate function using the ".../c/" URL is hard-coded to use 'c'. This appears to match 's' usage attempts: the only URL that returned actual data with 's' was with titleID 0100000000000816.
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenEnsureNetworkClockAvailabilityService
|-
| 100 || [3.0.0+] SuspendAutonomicTimeCorrection
|-
| 101 || [3.0.0+] ResumeAutonomicTimeCorrection
|}


As of June 30, 2017, accessing old content via the atumn "/c/" and "/t/" URLs works fine.
Network-time-sync uses the "<...>/time" HTTPS URL listed in the below Network section. This just returns an UTC Unix time string.


Going by strings in NIM, it appears SOAP isn't used anymore. ecs appears to use REST API?
== IEnsureNetworkClockAvailabilityService ==
This is "nn::ntc::detail::service::IEnsureNetworkClockAvailabilityService".


== User-Agent ==
{| class="wikitable" border="1"
NIM generates two User-Agent strings:
|-
  snprintf(..., "User-Agent: NintendoSDK Firmware/%s-%u (platform:%s; did:%016llx; eid:%s)", <string at [[System_Version_Title|sysver]]+0x68>, {u32 from [[System_Version_Title|sysver]]+4}, "NX", DeviceId, {[[NSD_services|NSD]] cmd11 output});
! Cmd || Name
  snprintf(..., "User-Agent: NintendoSDK Firmware/%s-%u (platform:%s; eid:%s)", <string at [[System_Version_Title|sysver]]+0x68>, {u32 from [[System_Version_Title|sysver]]+4}, "NX", DeviceId, {[[NSD_services|NSD]] cmd11 output});
|-
| 0 || StartTask
|-
| 1 || GetFinishNotificationEvent
|-
| 2 || GetResult
|-
| 3 || Cancel
|-
| 4 || IsProcessing
|-
| 5 || [3.0.0+] GetServerTime
|}


Where the 64bit DeviceId is parsed from the 0x10-bytes at outbuf+0xC6 from [[Settings_services|set:cal]] GetDeviceCert(DeviceCert_certname+2, aka where the hex string for the DeviceId is).
= IAsyncValue =
This is "nn::nim::detail::IAsyncValue".


== sun ==
{| class="wikitable" border="1"
NIM sends a HTTP GET with the sun URL listed above to get the title-listing of the latest system-titles, as .json. The deviceid in the URL is the same one in the above User-Agent section. HTTP header "Accept:application/json" is sent in the request.
|-
! Cmd || Name
|-
| 0 || GetSize
|-
| 1 || Get
|-
| 2 || Cancel
|-
| 3 || [4.0.0+] GetErrorContext
|}


The response is json with a "system_update_metas" block, containing "title_id" and "title_version" entries. The actual server response only contains 1 title.
= IAsyncResult =
This is "nn::nim::detail::IAsyncResult".


Example, from 2.0 system:
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Get
|-
| 1 || Cancel
|-
| 2 || [4.0.0+] GetErrorContext
|}
 
= IAsyncProgressResult =
This is "nn::nim::detail::IAsyncProgressResult".


<code>{"timestamp":REDACTED-TIMESTSAMP,"system_update_metas":[{"title_id":"0100000000000816","title_version":201327002}]}</code>
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Get
|-
| 1 || Cancel
|-
| 2 || GetProgress
|-
| 3 || [4.0.0+] GetErrorContext
|}


== aqua ==
= IAsyncData =
The following response is json from accessing the above aqua URL:
This is "nn::nim::detail::IAsyncData".


<code>{
{| class="wikitable" border="1"
"contents_delivery_required_title_id": "0100000000000816",
|-
"contents_delivery_required_title_version": 0
! Cmd || Name
}</code>
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 || [4.0.0+]
|}


A while after [[3.0.0]] release, the above title-version was changed to the one for v3.0("Last-Modified: Thu, 29 Jun 2017 00:00:04 GMT").
[[Category:Services]]
Retrieved from "https://switchbrew.org/wiki/NIM_services"