3dbrew - User contributions [en]

BOSSU:GetNsDataIdList

2025-08-30T16:16:47Z

DaniElectra: /* Internals */ Add more info about first type parameter

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0010|4|2}}
{{IPC/RequestEntry|u32, Filter}}
{{IPC/RequestEntry|u32, Number of entries that the list can hold (max entries)}}
{{IPC/RequestEntry|u16, Starting index in the internal NS Data ID list}}
{{IPC/RequestEntry|u32, Starting NS Data ID}}
{{IPC/MapPointerW|Output NS Data ID list}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0010|3|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u16, Actual number of output entries}}
{{IPC/RequestEntry|u16, Last index copied to output in the internal NS Data ID list}}
{{IPC/MapPointerW|Output NS Data ID list}}
{{IPC/RequestEnd}}

=Description=
Writes an array of NS Data ID entries (u32) for the program ID of the current session to the output buffer using the provided filters.

==Internals==
This eventually calls a function with the following type parameters: 0, 1, 1. This function doesn't use the second type parameter. Afterwards another function is called using the program ID.

The first type parameter is a filter based on the new flag of the NsData:

{| class="wikitable" border="1"
! Value !! Description
|-
| 0 || Allow everything. This will also unset the [[BOSS_Savegame#BOSS_A_TitleInfo|arrival flag]]
|-
| 1 || Only allow entries which don't have the new flag set. This will also set the [[BOSS_Savegame#BOSS_A_TitleInfo|arrival flag]]
|-
| 2 || Only allow entries which have the new flag set. This will also set the [[BOSS_Savegame#BOSS_A_TitleInfo|arrival flag]]
|}

The second type parameter represents the session being used for the command:

{| class="wikitable" border="1"
! Value !! Description
|-
| 1 || User
|-
| 2 || Privileged
|}

The third type parameter is a filter based on the program ID of the session:

{| class="wikitable" border="1"
! Value !! Description
|-
| 0 || Allow everything
|-
| 1 || Only allow entries which have a target program ID matching the program ID of the session
|}

Hence, this command only lists entries whose program ID matches the one from this session.

=Filter=
Content filtering is enabled when this word isn't 0xFFFFFFFF. This is only used for the following: <code>if (filterword_u16high != contentdatatype_u16high || (filterword_u16low & contentdatatype_u16low) == 0) continue;</code> Hence, filterword_u16high must match contentdatatype_u16high, and the bitmask specified by filterword_u16low must be non-zero in contentdatatype_u16low. The contentdatatype is extracted from the extdata filename, which originates from the [[SpotPass|BOSS-container]]. The NS Data ID for the content entry is only written to the output when processing isn't skipped due to filtering.

=Start NsDataId=
This field is only used when the starting index is non-zero or when this field is non-zero.

The NS Data ID at the specified starting index must match this field, otherwise error 0xD840F846 is returned. It will then skip normal content entry processing for this matching entry (cur_wordindex is field is increased by 0x1 before starting the content entry processing loop).

BOSS Services

2025-08-21T17:40:06Z

DaniElectra: /* CfgInfoType */

==BOSS User Service "boss:U"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010082
| [[BOSSU:InitializeSession|InitializeSession]]
|-
| 0x00020100
| [[BOSSU:SetStorageInfo|SetStorageInfo]]
|-
| 0x00030000
| [[BOSSU:UnregisterStorage|UnregisterStorage]]
|-
| 0x00040000
| [[BOSSU:GetStorageInfo|GetStorageInfo]]
|-
| 0x00050042
| [[BOSSU:RegisterPrivateRootCa|RegisterPrivateRootCa]]
|-
| 0x00060084
| [[BOSSU:RegisterPrivateClientCert|RegisterPrivateClientCert]] <nowiki>(u32 Size0, u32 Size1, ((Size0<<4) | 10), Buf0, ((Size1<<4) | 10), Buf1)</nowiki> This writes the content of the input buffers into files "bossdb:/%s_CL" and "bossdb:/%s_CLK", where "%s" is generated from the programID.
|-
| 0x00070000
| [[BOSSU:GetNewArrivalFlag|GetNewArrivalFlag]]
|-
| 0x00080002
| [[BOSSU:RegisterNewArrivalEvent|RegisterNewArrivalEvent]]: Used for sending a handle. This is used with a table of programIDs etc with a maximum of 5 entries.
|-
| 0x00090040
| [[BOSSU:SetOptoutFlag|SetOptoutFlag]]
|-
| 0x000A0000
| [[BOSSU:GetOptoutFlag|GetOptoutFlag]]
|-
| 0x000B00C2
| [[BOSSU:RegisterTask|RegisterTask]]
|-
| 0x000C0082
| [[BOSSU:UnregisterTask|UnregisterTask]]
|-
| 0x000D0082
| [[BOSSU:ReconfigureTask|ReconfigureTask]]
|-
| 0x000E0000
| [[BOSSU:GetTaskIdList|GetTaskIdList]]
|-
| 0x000F0042
| [[BOSSU:GetStepIdList|GetStepIdList]]
|-
| 0x00100102
| [[BOSSU:GetNsDataIdList|GetNsDataIdList]]
|-
| 0x00110102
| [[BOSSU:GetNsDataIdList1|GetNsDataIdList1]]
|-
| 0x00120102
| [[BOSSU:GetNsDataIdList2|GetNsDataIdList2]]
|-
| 0x00130102
| [[BOSSU:GetNsDataIdList3|GetNsDataIdList3]]
|-
| 0x00140082
| [[BOSSU:SendProperty|SendProperty]]
|-
| 0x00150042
| [[BOSSU:SendPropertyHandle|SendPropertyHandle]]
|-
| 0x00160082
| [[BOSSU:ReceiveProperty|ReceiveProperty]]
|-
| 0x00170082
| [[BOSSU:UpdateTaskInterval|UpdateTaskInterval]]
|-
| 0x00180082
| [[BOSSU:UpdateTaskCount|UpdateTaskCount]]
|-
| 0x00190042
| [[BOSSU:GetTaskInterval|GetTaskInterval]]
|-
| 0x001A0042
| [[BOSSU:GetTaskCount|GetTaskCount]]
|-
| 0x001B0042
| [[BOSSU:GetTaskServiceStatus|GetTaskServiceStatus]]
|-
| 0x001C0042
| [[BOSSU:StartTask|StartTask]]
|-
| 0x001D0042
| [[BOSSU:StartTaskImmediate|StartTaskImmediate]]
|-
| 0x001E0042
| [[BOSSU:CancelTask|CancelTask]]
|-
| 0x001F0000
| [[BOSSU:GetTaskFinishHandle|GetTaskFinishHandle]]
|-
| 0x00200082
| [[BOSSU:GetTaskState|GetTaskState]]
|-
| 0x00210042
| [[BOSSU:GetTaskResult|GetTaskResult]]
|-
| 0x00220042
| [[BOSSU:GetTaskCommErrorCode|GetTaskCommErrorCode]]
|-
| 0x002300C2
| [[BOSSU:GetTaskStatus|GetTaskStatus]]
|-
| 0x00240082
| [[BOSSU:GetTaskError|GetTaskError]]
|-
| 0x00250082
| [[BOSSU:GetTaskInfo|GetTaskInfo]]
|-
| 0x00260040
| [[BOSSU:DeleteNsData|DeleteNsData]]
|-
| 0x002700C2
| [[BOSSU:GetNsDataHeaderInfo|GetNsDataHeaderInfo]]
|-
| 0x00280102
| [[BOSSU:ReadNsData|ReadNsData]]
|-
| 0x00290080
| [[BOSSU:SetNsDataAdditionalInfo|SetNsDataAdditionalInfo]]
|-
| 0x002A0040
| [[BOSSU:GetNsDataAdditionalInfo|GetNsDataAdditionalInfo]]. Writes an output u32 to cmdreply[2].
|-
| 0x002B0080
| [[BOSSU:SetNsDataNewFlag|SetNsDataNewFlag]]
|-
| 0x002C0040
| [[BOSSU:GetNsDataNewFlag|GetNsDataNewFlag]]
|-
| 0x002D0040
| [[BOSSU:GetNsDataLastUpdate|GetNsDataLastUpdate]] (u32 NsDataId) Writes an output u64 to cmdreply[2-3], from the content file in extdata.
|-
| 0x002E0040
| [[BOSSU:GetErrorCode|GetErrorCode]]
|-
| 0x002F0140
| [[BOSSU:RegisterStorageEntry|RegisterStorageEntry]]
|-
| 0x00300000
| [[BOSSU:GetStorageEntryInfo|GetStorageEntryInfo]]
|-
| 0x00310100
| [[BOSSU:SetStorageOption|SetStorageOption]]
|-
| 0x00320000
| [[BOSSU:GetStorageOption|GetStorageOption]]
|-
| 0x00330042
| [[BOSSU:StartBgImmediate|StartBgImmediate]]
|-
| 0x00340042
| [[BOSSU:GetTaskPriority|GetTaskPriority]]
|-
| 0x003500C2
| [[BOSSU:RegisterImmediateTask|RegisterImmediateTask]]
|-
| 0x00360084
| [[BOSSU:SetTaskQuery|SetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|-
| 0x00370084
| [[BOSSU:GetTaskQuery|GetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|}

==BOSS Privileged Service "boss:P"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x04010082
| [[BOSSP:InitializeSessionPrivileged|InitializeSessionPrivileged]]
|-
| 0x04020000
| ?
|-
| 0x04030000
| ?
|-
| 0x04040080
| [[BOSSP:GetAppNewFlag|GetAppNewFlag]]
|-
| 0x040500C0
| [[BOSSP:SetAppNewFlag|SetAppNewFlag]]
|-
| 0x040600C0
| [[BOSSP:SetOptoutFlagPrivileged|SetOptoutFlagPrivileged]]
|-
| 0x04070080
| [[BOSSP:GetOptoutFlagPrivileged|GetOptoutFlagPrivileged]]
|-
| 0x04080040
| (u8 optout) Sets the optout flag to all apps?
|-
| 0x04090102
| [[BOSSP:UnregisterTaskPrivileged|UnregisterTaskPrivileged]]
|-
| 0x040A0000
| [[BOSSP:GetAppIdList|GetAppIdList]]
|-
| 0x040B0080
| [[BOSSP:GetTaskIdListPrivileged|GetTaskIdListPrivileged]]
|-
| 0x040C00C2
| [[BOSSP:GetStepIdListPrivileged|GetStepIdListPrivileged]]
|-
| 0x040D0182
| [[BOSSP:GetNsDataIdListPrivileged|GetNsDataIdListPrivileged]]
|-
| 0x040E0182
| [[BOSSP:GetNsDataIdListPrivileged1|GetNsDataIdListPrivileged1]]
|-
| 0x040F0102
| [[BOSSP:GetTaskInfoPrivileged|GetTaskInfoPrivileged]]
|-
| 0x04100102
| [[BOSSP:GetTaskStatusPrivileged1|GetTaskStatusPrivileged1]] Same as GetTaskStatusPrivileged, but the input bool is set to false
|-
| 0x04110102
| [[BOSSP:GetTaskErrorPrivileged|GetTaskErrorPrivileged]]
|-
| 0x04120000
| Related to the sysmodule savedata?
|-
| 0x04130082
| [[BOSSP:SendPropertyPrivileged|SendPropertyPrivileged]]
|-
| 0x04140082
| [[BOSSP:ReceivePropertyPrivileged|ReceivePropertyPrivileged]]
|-
| 0x041500C0
| [[BOSSP:DeleteNsDataPrivileged|DeleteNsDataPrivileged]]
|-
| 0x04160142
| [[BOSSP:GetNsDataHeaderInfoPrivileged|GetNsDataHeaderInfoPrivileged]]
|-
| 0x04170182
| [[BOSSP:ReadNsDataPrivileged|ReadNsDataPrivileged]]
|-
| 0x04180100
| [[BOSSP:SetNsDataAdditionalInfoPrivileged|SetNsDataAdditionalInfoPrivileged]]
|-
| 0x041900C0
| [[BOSSP:GetNsDataAdditionalInfoPrivileged|GetNsDataAdditionalInfoPrivileged]]
|-
| 0x041A0100
| [[BOSSP:SetNsDataNewFlagPrivileged|SetNsDataNewFlagPrivileged]]
|-
| 0x041B00C0
| [[BOSSP:GetNsDataNewFlagPrivileged|GetNsDataNewFlagPrivileged]]
|-
| 0x041C00C0
| [[BOSSP:GetNsDataLastUpdatePrivileged|GetNsDataLastUpdatePrivileged]]
|-
| 0x041D0040
| (bool unk_flag1)
|-
| 0x041E0000
| Returns: bool unk_flag1
|-
| 0x041F0040
| [[BOSSP:SetTestModeAvailability|SetTestModeAvailability]] (bool test_mode_flag)
|-
| 0x04200000
| [[BOSSP:GetTestModeAvailability|GetTestModeAvailability]]. Returns: bool test_mode_flag
|-
| 0x04210000?
| Stubbed
|-
| 0x04220000
| ?
|-
| 0x04230000?
| Stubbed
|-
| 0x04240000
| ?
|-
| 0x04250042
| [[BOSSP:SetPolicyListEnvId|SetPolicyListEnvId]]. Sets the policylist env ID (default env ID is "p01"): strncpy("p01", in, 8)
|-
| 0x04260042
| [[BOSSP:GetPolicyListEnvId|GetPolicyListEnvId]]. Gets the policylist env ID (default env ID is "p01"): strcpy(out, "p01")
|-
| 0x04270042
| [[BOSSP:SetPolicyListUrl|SetPolicyListUrl]]. Sets a custom policylist URL. Max of 0x200 chars
|-
| 0x04280042
| [[BOSSP:GetPolicyListUrl|GetPolicyListUrl]]. Gets the custom policylist URL
|-
| 0x04290002
| (Handle unk)
|-
| 0x042A0000
| Closes the previous handle
|-
| 0x042B0000
| Returns: u8 unk
|-
| 0x042C0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>
|-
| 0x042D0000
| Returns: u32 unk
|-
| 0x042E00C2
| [[BOSSP:StartTaskPrivileged|StartTaskPrivileged]]
|-
| 0x042F00C2
| [[BOSSP:StartTaskImmediatePrivileged|StartTaskImmediatePrivileged]]
|-
| 0x043000C2
| [[BOSSP:CancelTaskPrivileged|CancelTaskPrivileged]]
|-
| 0x04310040
| (u32 unk_4) The input is stored in a variable whose default value is 0x70
|-
| 0x04320040
| Returns: u32 unk_4
|-
| 0x04330080
| [[BOSSP:GetStorageOptionPrivileged|GetStorageOptionPrivileged]]
|-
| 0x043400C2
| [[BOSSP:StartBgImmediatePrivileged|StartBgImmediatePrivileged]]
|-
| 0x04350042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x04360042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043700C2
| [[BOSSP:GetTaskPriorityPrivileged|GetTaskPriorityPrivileged]]
|-
| 0x04380000
| ?
|-
| 0x04390104
| [[BOSSP:GetTaskQueryPrivileged|GetTaskQueryPrivileged]]
|-
| 0x043A0042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x043B0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043C0080
| (u64 title_id)
|-
| 0x043D0080
| (u64 title_id)
|-
| 0x043E0042
| [[BOSSP:SetSprelayUrl|SetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Sets the sprelay URL
|-
| 0x043F0042
| [[BOSSP:GetSprelayUrl|GetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Gets the sprelay URL
|-
| 0x04400080
| [[BOSSP:SetSprelayInterval|SetSprelayInterval]] (u32 interval, u32 unk). Sets the sprelay interval, and other things
|-
| 0x04410000
| [[BOSSP:GetSprelayInterval|GetSprelayInterval]] Returns: u32 interval, u32 unk. Gets the sprelay interval, and other things
|-
| 0x04420000
| ?
|-
| 0x04430042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x208
|-
| 0x04440042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x130
|-
| 0x04450040
| (u8 unk_5)
|-
| 0x04460000
| Returns: u8 unk_5
|-
| 0x04470002
| [[BOSSP:RegisterNewArrivalEventPrivileged|RegisterNewArrivalEventPrivileged]]
|-
| 0x04480000?
| Stubbed
|-
| 0x04490142
| [[BOSSP:RegisterTaskPrivileged|RegisterTaskPrivileged]]
|-
| 0x044A0180
| [[BOSSP:SetStorageInfoPrivileged|SetStorageInfoPrivileged]]
|-
| 0x044B01C0
| [[BOSSP:RegisterStorageEntryPrivileged|RegisterStorageEntryPrivileged]]
|-
| 0x044C0080
| [[BOSSP:UnregisterStoragePrivileged|UnregisterStoragePrivileged]]
|-
| 0x044D0080
| [[BOSSP:GetStorageInfoPrivileged|GetStorageInfoPrivileged]]
|-
| 0x044E0080
| [[BOSSP:GetStorageEntryInfoPrivileged|GetStorageEntryInfoPrivileged]]
|-
| 0x044F0102
| [[BOSSP:UpdateTaskIntervalPrivileged|UpdateTaskIntervalPrivileged]]
|-
| 0x04500102
| [[BOSSP:UpdateTaskCountPrivileged|UpdateTaskCountPrivileged]]
|-
| 0x045100C2
| [[BOSSP:GetTaskIntervalPrivileged|GetTaskIntervalPrivileged]]
|-
| 0x045200C2
| [[BOSSP:GetTaskCountPrivileged|GetTaskCountPrivileged]]
|-
| 0x045300C2
| [[BOSSP:GetTaskServiceStatusPrivileged|GetTaskServiceStatusPrivileged]]
|-
| 0x04540102
| [[BOSSP:GetTaskStatePrivileged|GetTaskStatePrivileged]]
|-
| 0x045500C2
| [[BOSSP:GetTaskResultPrivileged|GetTaskResultPrivileged]]
|-
| 0x045600C2
| [[BOSSP:GetTaskCommErrorCodePrivileged|GetTaskCommErrorCodePrivileged]]
|-
| 0x04570142
| [[BOSSP:GetTaskStatusPrivileged|GetTaskStatusPrivileged]]
|-
| 0x04580104
| [[BOSSP:SetTaskQueryPrivileged|SetTaskQueryPrivileged]]
|}

boss:P also contains all of the commands from boss:U.

When Home Menu loads the SpotPass [[CBMD]] with [[Extended_Banner]], it uses bossP command 0x040D0182 first. Then it uses GetNsDataHeaderInfoPrivileged, then ReadNsDataPrivileged for loading the actual banner data.

==BOSS Service "boss:M"==

{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010002
| ?
|-
| 0x00020000
| ?
|-
| 0x00030040
| ?
|-
| 0x00040000
| ?
|-
| 0x00050000
| ?
|-
| 0x00060000
| ?
|-
| 0x00070000
| ?
|}

==programIDs==
BOSS uses programIDs raw without any handling for the New3DS programID-low bitmask. For example, attempting a NsDataId listing with the New3DS bitmask set will fail, if BOSS is only setup for that programID with the New3DS bitmask clear.

When [[BOSSU:InitializeSession|initializing]] BOSS with the default programID, the New3DS programID-low bitmask is always clear for New3DS titles since that's how it was originally registered with [[Filesystem_services|FS]]. Hence, the programID in the [[SpotPass|BOSS-container]] must always have the New3DS bitmask clear. This also means everything using the BOSSP commands with the raw programIDs loaded from AM title-listing are broken with New3DS titles, for example [[Extended_Banner]].

==Content Data Storage==
SpotPass content for each application is stored under the extdata specified by [[BOSS:SetStorageInfo]]. Certain commands verify that the PID associated with the current service session has access to the specified extdata by using [[FS:CheckAuthorityToAccessExtSaveData]], returning an error on failure. This basically renders SpotPass unusable under user-processes(when initialized under those processes) which don't have access to any SD extdata(unless NAND extdata is used instead).

All of these commands using [[FS:CheckAuthorityToAccessExtSaveData]] are: [[BOSS:SetStorageInfo]] and RegisterStorageEntry, for both BOSSU and BOSSP.

BOSS-container content is stored in the extdata registered for the programID specified in the BOSS-container, what task it's associated with / what title registered it is irrelevant with BOSS-container data storage.

==Custom SpotPass content==
SpotPass supports raw content download without using the encrypted+signed SpotPass container(raw content is used by [[Home Menu]] SpotPass VersionList for example). However, this is incompatible with the data-loading method used with SpotPass-container content(NsData commands can't be used with it).

When writing the raw content, it firsts deletes and creates the "<taskID>" file under the data-storage extdata with normal extdata(not the separate boss archive). Once successful, the final filename specified by the task config will be deleted if needed, then the "<taskID>" file will be renamed to the final filename. Afterwards, the user-process can access the final file just like any other extdata file.

For using custom content with the SpotPass container(like official titles), the only known ways to do so is: "CFW" / ARM11-kernelhax with the sigchecks for this patched, or some sort of BOSS-sysmodule exploit if there's any vulns to begin with.

==HTTP upload==
SpotPass tasks can be used for uploading data via HTTP POST. The exact method varies, but the main one is a [[HTTPC:SendPOSTDataRawTimeout|raw]] POST.

The content data is loaded from the following path: snprintf(outpath, outpathsize, "%s/%s%02x.up", archivepath, taskidstr_probably, unk);

The archivepath can be either "bossdb:"(BOSS-sysmodule NAND savedata) or the content-data-storage extdata. Certain other paths in the BOSS savedata can be used too.

==BOSS Tasks==
The TaskID is a 8-byte buffer containing a string including NUL-terminator(taskIDs are compared with: strncmp(str0, str1, 7)).

When disabling SpotPass, applications use [[BOSSU:CancelTask]] then [[BOSSU:UnregisterTask]], to delete each task.

Each process can only access tasks which it created, not other processes' tasks(even when using bossP with [[BOSSP:InitializeSessionPrivileged|init_programID]]=0).

After registration, tasks will not automatically run until they are started using one of the start-task commands.

==NsDataId==
This is an u32 ID for SpotPass content, used with the NsData service commands etc.

==NsDataHeaderInfo==
This type contains information about an NsData, the fields match exactly with the [[SpotPass#Payload_Content_Header|Payload Content Header]] without the hash and signature. When the input type is not one of the below or when the specified output size doesn't match the expected size for this type, an error is returned.

{| class="wikitable" border="1"
! Type !! Size !! Description
|-
| 0x0 || 0x8 || Program ID
|-
| 0x1 || 0x4 || Unknown field
|-
| 0x2 || 0x4 || Content datatype
|-
| 0x3 || 0x4 || Payload size
|-
| 0x4 || 0x4 || NS Data ID
|-
| 0x5 || 0x4 || Version
|-
| 0x6 || 0x20 || Everything:
{| class="wikitable" border="1"
! Offset !! Size !! Description
|-
| 0x0 || 0x8 || Program ID
|-
| 0x8 || 0x4 || Unknown field
|-
| 0xC || 0x4 || Content datatype
|-
| 0x10 || 0x4 || Payload size
|-
| 0x14 || 0x4 || NS Data ID
|-
| 0x18 || 0x4 || Version
|-
| 0x1C || 0x4 || Padding?
|}
|}

==PropertyIDs==
{| class="wikitable" border="1"
! ID !! Size !! Type !! Read !! Write !! Rewritable !! Description
|-
| 0x0 || 0x1 || u8 || Yes || Yes || Yes || [[#PriorityLevel|Priority]]. Represents the priority of a task
|-
| 0x1 || 0x1 || u8 || Yes || Yes || Yes || SchedulingPolicy. Unknown purpose, the API on games force this to 1
|-
| 0x2 || 0x4 || u32 || Yes || Yes || Yes || TaskTargetDuration. Unknown purpose, the API on games require a value below 0x10000 (not inclusive)
|-
| 0x3 || 0x4 || u32 || Yes || Yes || Yes || Interval in seconds of the task
|-
| 0x4 || 0x4 || u32 || Yes || Yes || Yes || Count. Number of times that the task will be run. If zero, the task is persistent
|-
| 0x5 || 0x1 || u8 || Yes || Yes || Yes || TaskPermission. Unknown purpose, the API on games require a value between 0 and 3
|-
| 0x6 || 0x1 || u8 || Yes || Yes || No || [[#ActionCode|ActionCode]]. Represents the action that a task will perform
|-
| 0x7 || 0x200 || char[512] || Yes || Yes || No || URL. Unused for DataStore actions
|-
| 0x8 || 0x4 || || Yes || Yes || No || ?
|-
| 0x9 || 0x1 || || Yes || Yes || No || Controls the action data type? The API on games require a value between 0 and 6
|-
| 0xA || 0x100 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xB and 0x3E
|-
| 0xB || 0x200 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xA and 0x3E
|-
| 0xC || 0x4 || Handle || Yes || Yes || No || Optional file handle with the data to send
|-
| 0xD || 0x360 || HeaderField[3] || Yes || Yes || No || HeaderFields. Additional headers to include in the request sent to the server. Structure:
{| class="wikitable" border="1"
|-
! Offset !! Size !! Description
|-
| 0x0 || 0x20 || char[32] Header name
|-
| 0x20 || 0x100 || char[256] Header value
|}
|-
| 0xE || 0x4 || u32[1] || Yes || Yes || No || ClientCerts. List of [[HTTPC:SetClientCertDefault|cert IDs]] to use as client certs
|-
| 0xF || 0xC || u32[3] || Yes || Yes || No || RootCAs. List of [[HTTPC:AddDefaultCert|cert IDs]] to use as root CAs
|-
| 0x10 || 0x1 || u8 || Yes || Yes || No || FSClientCert. If non-zero, enables the task client certificate to be read from the filesystem. May be a bool?
|-
| 0x11 || 0x1 || u8 || Yes || Yes || No || FSRootCA. If non-zero, enables the task root CA to be read from the filesystem. May be a bool?
|-
| 0x12 || 0x1 || u8 || Yes || Yes || No || [[#ApInfoType|ApInfoType]]
|-
| 0x13 || 0x4 || u32 || Yes || Yes || No || RootCaCount. Amount of root CAs stored in property 0xF
|-
| 0x14 || 0x4 || u32 || Yes || Yes || No || ClientCertCount. Amount of client certificates stored in property 0xE
|-
| 0x15 || 0x40 || || Yes || Yes || No || ?
|-
| 0x16 || 0x4 || || Yes || Yes || No || ?
|-
| 0x17 || || || No || No || No || Reserved
|-
| 0x18 || 0x1 || || Yes || Yes || No || Unknown purpose, the API on games force this to 1
|-
| 0x19 || 0x1 || || Yes || Yes || No || ?
|-
| 0x1A || 0x1 || || Yes || Yes || No || ?
|-
| 0x1B || 0x4 || || Yes || Yes || No || ?
|-
| 0x1C || 0x4 || || Yes || Yes || No || ?
|-
| 0x1D || 0x1 || u8 || Yes || No || No || [[#TaskStateCode|TaskStateCode]]
|-
| 0x1E || 0x1 || || Yes || No || No || ?
|-
| 0x1F || 0x1 || || Yes || No || No || ?
|-
| 0x20 || 0x1 || u8 || Yes || No || No || TaskResultCode. Unknown purpose
|-
| 0x21 || 0x1 || u8 || Yes || No || No || TaskServiceStatus. Unknown purpose
|-
| 0x22 || 0x1 || || Yes || No || No || ?
|-
| 0x23 || 0x4 || u32 || Yes || No || No || CommErrorCode. Received HTTP status code when performing the task. Set to 0 for successful codes
|-
| 0x24 || 0x1 || || Yes || No || No || ?
|-
| 0x25 || 0x4 || || Yes || No || No || ?
|-
| 0x26 || 0x4 || || Yes || No || No || ?
|-
| 0x27 || 0x4 || || Yes || No || No || ?
|-
| 0x28 || 0x8 || u64 || Yes || No || No || LastSuccessfulTimestamp. Number of seconds since the year 2000 of the last successful run of the task
|-
| 0x29 || 0x8 || || Yes || No || No || ?
|-
| 0x2A || 0x4 || || Yes || No || No || ?
|-
| 0x2B || 0x4 || || Yes || No || No || ?
|-
| 0x2C || 0x1 || || Yes || No || No || ?
|-
| 0x2D || 0x2 || || Yes || No || No || ?
|-
| 0x2E || 0x2 || || Yes || No || No || ?
|-
| 0x2F || 0x40 || char[64] || Yes || No || No || LastModifiedHeader. Date string from the Last-Modified HTTP header received when executing the task
|-
| 0x30 || 0x1 || || Yes || No || No || ?
|-
| 0x31 || 0x4 || || Yes || No || No || ?
|-
| 0x32 || 0x100 || || Yes || No || No || ?
|-
| 0x33 || 0x2 || u16 || Yes || No || No || TotalApps. Number of application IDs on the below list
|-
| 0x34 || 0x400 || u64[128] || Yes || No || No || AppIdList. List of application IDs registered in BOSS
|-
| 0x35 || 0x2 || u16 || Yes || No || No || TotalTasks. Number of task IDs on the below list
|-
| 0x36 || 0x400 || char[8][128] || Yes || No || No || TaskIdList. List of task IDs registered by the application
|-
| 0x37 || 0x2 || u16 || Yes || No || No || TotalSteps. Number of step IDs on the below list
|-
| 0x38 || 0x80 || u8[128] || Yes || No || No || StepIdList. List of steps that the task has registered
|-
| 0x39 || || || No || No || No || Reserved
|-
| 0x3A || || || No || No || No || Reserved
|-
| 0x3B || 0x4 || || Yes || Yes || No || ?
|-
| 0x3C || || || No || No || No || Reserved
|-
| 0x3D || || || No || No || No || Reserved
|-
| 0x3E || 0x200 || || Yes || Yes || No || DataStoreDownloadActionData. Shares buffer with properties 0xA and 0xB
|-
| 0x3F || 0x1 || u8 || Yes || Yes || No || [[#CfgInfoType|CfgInfoType]]
|}

The official name for this type is "PropertyType". The read column represents properties which can be obtained with [[BOSSU:ReceiveProperty|ReceiveProperty]], the write column represents properties which can be set with [[BOSSU:SendProperty|SendProperty]], and the rewritable column indicates properties which can be reassigned into an existing task with [[BOSSU:ReconfigureTask|ReconfigureTask]]. If the specified size for the command is larger than the property size, it will use the actual property size instead. When the specified size is less than the actual property size, all of the property data that won't be written to is cleared.

Trying to send a property which doesn't support being sent will give an error 0xC960F84D. Using reserved properties as an argument will give the same error.

==TaskStateCode==
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Last task run was successful?
|-
| 0x2
| Task started.
|-
| 0x5
| Task not started(also the initial state immediately after task creation).
|-
| 0x6
| Unknown
|-
| 0x7
| Task processing failed(such as network error).
|}

This u8 is returned by [[BOSSU:GetTaskState]].

==PriorityLevel==
{| class="wikitable" border="1"
! Value !! Name !! Description
|-
| 0x0 || INVALID? || Probably represents an invalid value
|-
| 0x15 || EXPEDITE1 ||
|-
| 0x16 || EXPEDITE2 ||
|-
| 0x17 || EXPEDITE3 ||
|-
| 0x18 || EXPEDITE4 ||
|-
| 0x19 || EXPEDITE5 ||
|-
| 0x1A || EXPEDITE6 ||
|-
| 0x1B || EXPEDITE7 ||
|-
| 0x1C || EXPEDITE8 ||
|-
| 0x23 || EXPEDITE ||
|-
| 0x50 || HIGH ||
|-
| 0x7D || MEDIUM || This is the default value inside the games API
|-
| 0xAA || LOW ||
|-
| 0xD7 || LOWEST ||
|-
| 0xDD || LOWEST1 ||
|-
| 0xDE || LOWEST2 ||
|-
| 0xDF || LOWEST3 ||
|-
| 0xE0 || LOWEST4 ||
|-
| 0xE1 || LOWEST5 ||
|-
| 0xE2 || LOWEST6 ||
|-
| 0xE3 || LOWEST7 ||
|-
| 0xE4 || LOWEST8 ||
|-
| 0xFF || STOPPED || The task won't be run
|}

Represents the priority of a task. Any values outside the ones listed above are considered invalid.

==ActionCode==
{| class="wikitable" border="1"
! Value !! Description
|-
| 0x1 || FileList? Action code used for listing files on the BOSS server. May be a generic raw download?
|-
| 0x2 || NsaDownload? Action code for downloading data from the given URL, principally an NsData
|-
| 0x3 || Upload? Action code for uploading data to the given URL
|-
| 0x4 || ?
|-
| 0x5 || ?
|-
| 0x6 || Action code used by task ID "pl" from the Home Menu
|-
| 0x7 || Action code used by task ID "phu" from the Home Menu
|-
| 0x8 || Action code used by task ID "tiu" from the Home Menu
|-
| 0x9 || Action code used by task ID "splu" from the Home Menu
|-
| 0xA || Action code used for downloading data from DataStore through an Hpp server. Stores notification data?
|-
| 0xB || Action code related to DataStore?
|-
| 0xC || Action code used for StreetPass Relay
|-
| 0xD || Action code used for downloading the title version list (versionList.dat)
|}

This represents the action that a task will perform.

==ApInfoType==
{| class="wikitable" border="1"
! Flag !! Description
|-
| 0x1 || Adds the "apgroup" parameter to the query
|-
| 0x2 || Adds the "aparea" parameter to the query
|-
| 0x4 || Adds the "ap" parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the access point the console is connected to.

==CfgInfoType==
{| class="wikitable" border="1"
! Flag !! Description
|-
| 0x1 || Adds the "c" (two-letter country code) parameter to the query
|-
| 0x2 || Adds the "l" (two-letter language code) parameter to the query
|-
| 0x4 || Adds the "tm" ([[Cfg:GetSystemModel|target model]]) parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the console configuration.

==Errors==
{| class="wikitable" border="1"
|-
! Error-code
! Description
|-
| 0xC8A0F833
| taskID not found.
|-
| 0xC8A0F836
| taskID already exists, for task creation.
|-
| 0xC8A0F842
| The specified programID is not setup for BOSS.
|-
| 0xC8A0F843
| The specified NsDataId was not found.
|}

[[Category:Services]]

BOSSU:GetTaskQuery

2025-08-21T17:38:36Z

DaniElectra: /* Description */ Link to TaskQueryConfig

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0037|2|4}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|u32, Task query size}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/MapPointerW|Task query}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0037|1|4}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/MapPointerW|Task query}}
{{IPC/RequestEnd}}

=Description=
Gets the task query to the task for the program ID of the current session. The [[BOSS_Savegame#TaskQueryConfig|task query]] is a 0x60-byte structure, so the size is always 0x60.

BOSSU:SetTaskQuery

2025-08-21T17:37:50Z

DaniElectra: Link to TaskQueryConfig

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0036|2|4}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|u32, Task query size}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/MapPointerR|Task query}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0036|1|4}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/MapPointerR|Task query}}
{{IPC/RequestEnd}}

=Description=
Sets a task query to the task for the program ID of the current session. The [[BOSS_Savegame#TaskQueryConfig|task query]] is a 0x60-byte structure, so the size is always 0x60.

BOSS Services

2025-08-21T17:36:39Z

DaniElectra: /* PropertyIDs */ Corrections on TaskStateCode and CommErrorCode

==BOSS User Service "boss:U"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010082
| [[BOSSU:InitializeSession|InitializeSession]]
|-
| 0x00020100
| [[BOSSU:SetStorageInfo|SetStorageInfo]]
|-
| 0x00030000
| [[BOSSU:UnregisterStorage|UnregisterStorage]]
|-
| 0x00040000
| [[BOSSU:GetStorageInfo|GetStorageInfo]]
|-
| 0x00050042
| [[BOSSU:RegisterPrivateRootCa|RegisterPrivateRootCa]]
|-
| 0x00060084
| [[BOSSU:RegisterPrivateClientCert|RegisterPrivateClientCert]] <nowiki>(u32 Size0, u32 Size1, ((Size0<<4) | 10), Buf0, ((Size1<<4) | 10), Buf1)</nowiki> This writes the content of the input buffers into files "bossdb:/%s_CL" and "bossdb:/%s_CLK", where "%s" is generated from the programID.
|-
| 0x00070000
| [[BOSSU:GetNewArrivalFlag|GetNewArrivalFlag]]
|-
| 0x00080002
| [[BOSSU:RegisterNewArrivalEvent|RegisterNewArrivalEvent]]: Used for sending a handle. This is used with a table of programIDs etc with a maximum of 5 entries.
|-
| 0x00090040
| [[BOSSU:SetOptoutFlag|SetOptoutFlag]]
|-
| 0x000A0000
| [[BOSSU:GetOptoutFlag|GetOptoutFlag]]
|-
| 0x000B00C2
| [[BOSSU:RegisterTask|RegisterTask]]
|-
| 0x000C0082
| [[BOSSU:UnregisterTask|UnregisterTask]]
|-
| 0x000D0082
| [[BOSSU:ReconfigureTask|ReconfigureTask]]
|-
| 0x000E0000
| [[BOSSU:GetTaskIdList|GetTaskIdList]]
|-
| 0x000F0042
| [[BOSSU:GetStepIdList|GetStepIdList]]
|-
| 0x00100102
| [[BOSSU:GetNsDataIdList|GetNsDataIdList]]
|-
| 0x00110102
| [[BOSSU:GetNsDataIdList1|GetNsDataIdList1]]
|-
| 0x00120102
| [[BOSSU:GetNsDataIdList2|GetNsDataIdList2]]
|-
| 0x00130102
| [[BOSSU:GetNsDataIdList3|GetNsDataIdList3]]
|-
| 0x00140082
| [[BOSSU:SendProperty|SendProperty]]
|-
| 0x00150042
| [[BOSSU:SendPropertyHandle|SendPropertyHandle]]
|-
| 0x00160082
| [[BOSSU:ReceiveProperty|ReceiveProperty]]
|-
| 0x00170082
| [[BOSSU:UpdateTaskInterval|UpdateTaskInterval]]
|-
| 0x00180082
| [[BOSSU:UpdateTaskCount|UpdateTaskCount]]
|-
| 0x00190042
| [[BOSSU:GetTaskInterval|GetTaskInterval]]
|-
| 0x001A0042
| [[BOSSU:GetTaskCount|GetTaskCount]]
|-
| 0x001B0042
| [[BOSSU:GetTaskServiceStatus|GetTaskServiceStatus]]
|-
| 0x001C0042
| [[BOSSU:StartTask|StartTask]]
|-
| 0x001D0042
| [[BOSSU:StartTaskImmediate|StartTaskImmediate]]
|-
| 0x001E0042
| [[BOSSU:CancelTask|CancelTask]]
|-
| 0x001F0000
| [[BOSSU:GetTaskFinishHandle|GetTaskFinishHandle]]
|-
| 0x00200082
| [[BOSSU:GetTaskState|GetTaskState]]
|-
| 0x00210042
| [[BOSSU:GetTaskResult|GetTaskResult]]
|-
| 0x00220042
| [[BOSSU:GetTaskCommErrorCode|GetTaskCommErrorCode]]
|-
| 0x002300C2
| [[BOSSU:GetTaskStatus|GetTaskStatus]]
|-
| 0x00240082
| [[BOSSU:GetTaskError|GetTaskError]]
|-
| 0x00250082
| [[BOSSU:GetTaskInfo|GetTaskInfo]]
|-
| 0x00260040
| [[BOSSU:DeleteNsData|DeleteNsData]]
|-
| 0x002700C2
| [[BOSSU:GetNsDataHeaderInfo|GetNsDataHeaderInfo]]
|-
| 0x00280102
| [[BOSSU:ReadNsData|ReadNsData]]
|-
| 0x00290080
| [[BOSSU:SetNsDataAdditionalInfo|SetNsDataAdditionalInfo]]
|-
| 0x002A0040
| [[BOSSU:GetNsDataAdditionalInfo|GetNsDataAdditionalInfo]]. Writes an output u32 to cmdreply[2].
|-
| 0x002B0080
| [[BOSSU:SetNsDataNewFlag|SetNsDataNewFlag]]
|-
| 0x002C0040
| [[BOSSU:GetNsDataNewFlag|GetNsDataNewFlag]]
|-
| 0x002D0040
| [[BOSSU:GetNsDataLastUpdate|GetNsDataLastUpdate]] (u32 NsDataId) Writes an output u64 to cmdreply[2-3], from the content file in extdata.
|-
| 0x002E0040
| [[BOSSU:GetErrorCode|GetErrorCode]]
|-
| 0x002F0140
| [[BOSSU:RegisterStorageEntry|RegisterStorageEntry]]
|-
| 0x00300000
| [[BOSSU:GetStorageEntryInfo|GetStorageEntryInfo]]
|-
| 0x00310100
| [[BOSSU:SetStorageOption|SetStorageOption]]
|-
| 0x00320000
| [[BOSSU:GetStorageOption|GetStorageOption]]
|-
| 0x00330042
| [[BOSSU:StartBgImmediate|StartBgImmediate]]
|-
| 0x00340042
| [[BOSSU:GetTaskPriority|GetTaskPriority]]
|-
| 0x003500C2
| [[BOSSU:RegisterImmediateTask|RegisterImmediateTask]]
|-
| 0x00360084
| [[BOSSU:SetTaskQuery|SetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|-
| 0x00370084
| [[BOSSU:GetTaskQuery|GetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|}

==BOSS Privileged Service "boss:P"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x04010082
| [[BOSSP:InitializeSessionPrivileged|InitializeSessionPrivileged]]
|-
| 0x04020000
| ?
|-
| 0x04030000
| ?
|-
| 0x04040080
| [[BOSSP:GetAppNewFlag|GetAppNewFlag]]
|-
| 0x040500C0
| [[BOSSP:SetAppNewFlag|SetAppNewFlag]]
|-
| 0x040600C0
| [[BOSSP:SetOptoutFlagPrivileged|SetOptoutFlagPrivileged]]
|-
| 0x04070080
| [[BOSSP:GetOptoutFlagPrivileged|GetOptoutFlagPrivileged]]
|-
| 0x04080040
| (u8 optout) Sets the optout flag to all apps?
|-
| 0x04090102
| [[BOSSP:UnregisterTaskPrivileged|UnregisterTaskPrivileged]]
|-
| 0x040A0000
| [[BOSSP:GetAppIdList|GetAppIdList]]
|-
| 0x040B0080
| [[BOSSP:GetTaskIdListPrivileged|GetTaskIdListPrivileged]]
|-
| 0x040C00C2
| [[BOSSP:GetStepIdListPrivileged|GetStepIdListPrivileged]]
|-
| 0x040D0182
| [[BOSSP:GetNsDataIdListPrivileged|GetNsDataIdListPrivileged]]
|-
| 0x040E0182
| [[BOSSP:GetNsDataIdListPrivileged1|GetNsDataIdListPrivileged1]]
|-
| 0x040F0102
| [[BOSSP:GetTaskInfoPrivileged|GetTaskInfoPrivileged]]
|-
| 0x04100102
| [[BOSSP:GetTaskStatusPrivileged1|GetTaskStatusPrivileged1]] Same as GetTaskStatusPrivileged, but the input bool is set to false
|-
| 0x04110102
| [[BOSSP:GetTaskErrorPrivileged|GetTaskErrorPrivileged]]
|-
| 0x04120000
| Related to the sysmodule savedata?
|-
| 0x04130082
| [[BOSSP:SendPropertyPrivileged|SendPropertyPrivileged]]
|-
| 0x04140082
| [[BOSSP:ReceivePropertyPrivileged|ReceivePropertyPrivileged]]
|-
| 0x041500C0
| [[BOSSP:DeleteNsDataPrivileged|DeleteNsDataPrivileged]]
|-
| 0x04160142
| [[BOSSP:GetNsDataHeaderInfoPrivileged|GetNsDataHeaderInfoPrivileged]]
|-
| 0x04170182
| [[BOSSP:ReadNsDataPrivileged|ReadNsDataPrivileged]]
|-
| 0x04180100
| [[BOSSP:SetNsDataAdditionalInfoPrivileged|SetNsDataAdditionalInfoPrivileged]]
|-
| 0x041900C0
| [[BOSSP:GetNsDataAdditionalInfoPrivileged|GetNsDataAdditionalInfoPrivileged]]
|-
| 0x041A0100
| [[BOSSP:SetNsDataNewFlagPrivileged|SetNsDataNewFlagPrivileged]]
|-
| 0x041B00C0
| [[BOSSP:GetNsDataNewFlagPrivileged|GetNsDataNewFlagPrivileged]]
|-
| 0x041C00C0
| [[BOSSP:GetNsDataLastUpdatePrivileged|GetNsDataLastUpdatePrivileged]]
|-
| 0x041D0040
| (bool unk_flag1)
|-
| 0x041E0000
| Returns: bool unk_flag1
|-
| 0x041F0040
| [[BOSSP:SetTestModeAvailability|SetTestModeAvailability]] (bool test_mode_flag)
|-
| 0x04200000
| [[BOSSP:GetTestModeAvailability|GetTestModeAvailability]]. Returns: bool test_mode_flag
|-
| 0x04210000?
| Stubbed
|-
| 0x04220000
| ?
|-
| 0x04230000?
| Stubbed
|-
| 0x04240000
| ?
|-
| 0x04250042
| [[BOSSP:SetPolicyListEnvId|SetPolicyListEnvId]]. Sets the policylist env ID (default env ID is "p01"): strncpy("p01", in, 8)
|-
| 0x04260042
| [[BOSSP:GetPolicyListEnvId|GetPolicyListEnvId]]. Gets the policylist env ID (default env ID is "p01"): strcpy(out, "p01")
|-
| 0x04270042
| [[BOSSP:SetPolicyListUrl|SetPolicyListUrl]]. Sets a custom policylist URL. Max of 0x200 chars
|-
| 0x04280042
| [[BOSSP:GetPolicyListUrl|GetPolicyListUrl]]. Gets the custom policylist URL
|-
| 0x04290002
| (Handle unk)
|-
| 0x042A0000
| Closes the previous handle
|-
| 0x042B0000
| Returns: u8 unk
|-
| 0x042C0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>
|-
| 0x042D0000
| Returns: u32 unk
|-
| 0x042E00C2
| [[BOSSP:StartTaskPrivileged|StartTaskPrivileged]]
|-
| 0x042F00C2
| [[BOSSP:StartTaskImmediatePrivileged|StartTaskImmediatePrivileged]]
|-
| 0x043000C2
| [[BOSSP:CancelTaskPrivileged|CancelTaskPrivileged]]
|-
| 0x04310040
| (u32 unk_4) The input is stored in a variable whose default value is 0x70
|-
| 0x04320040
| Returns: u32 unk_4
|-
| 0x04330080
| [[BOSSP:GetStorageOptionPrivileged|GetStorageOptionPrivileged]]
|-
| 0x043400C2
| [[BOSSP:StartBgImmediatePrivileged|StartBgImmediatePrivileged]]
|-
| 0x04350042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x04360042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043700C2
| [[BOSSP:GetTaskPriorityPrivileged|GetTaskPriorityPrivileged]]
|-
| 0x04380000
| ?
|-
| 0x04390104
| [[BOSSP:GetTaskQueryPrivileged|GetTaskQueryPrivileged]]
|-
| 0x043A0042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x043B0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043C0080
| (u64 title_id)
|-
| 0x043D0080
| (u64 title_id)
|-
| 0x043E0042
| [[BOSSP:SetSprelayUrl|SetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Sets the sprelay URL
|-
| 0x043F0042
| [[BOSSP:GetSprelayUrl|GetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Gets the sprelay URL
|-
| 0x04400080
| [[BOSSP:SetSprelayInterval|SetSprelayInterval]] (u32 interval, u32 unk). Sets the sprelay interval, and other things
|-
| 0x04410000
| [[BOSSP:GetSprelayInterval|GetSprelayInterval]] Returns: u32 interval, u32 unk. Gets the sprelay interval, and other things
|-
| 0x04420000
| ?
|-
| 0x04430042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x208
|-
| 0x04440042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x130
|-
| 0x04450040
| (u8 unk_5)
|-
| 0x04460000
| Returns: u8 unk_5
|-
| 0x04470002
| [[BOSSP:RegisterNewArrivalEventPrivileged|RegisterNewArrivalEventPrivileged]]
|-
| 0x04480000?
| Stubbed
|-
| 0x04490142
| [[BOSSP:RegisterTaskPrivileged|RegisterTaskPrivileged]]
|-
| 0x044A0180
| [[BOSSP:SetStorageInfoPrivileged|SetStorageInfoPrivileged]]
|-
| 0x044B01C0
| [[BOSSP:RegisterStorageEntryPrivileged|RegisterStorageEntryPrivileged]]
|-
| 0x044C0080
| [[BOSSP:UnregisterStoragePrivileged|UnregisterStoragePrivileged]]
|-
| 0x044D0080
| [[BOSSP:GetStorageInfoPrivileged|GetStorageInfoPrivileged]]
|-
| 0x044E0080
| [[BOSSP:GetStorageEntryInfoPrivileged|GetStorageEntryInfoPrivileged]]
|-
| 0x044F0102
| [[BOSSP:UpdateTaskIntervalPrivileged|UpdateTaskIntervalPrivileged]]
|-
| 0x04500102
| [[BOSSP:UpdateTaskCountPrivileged|UpdateTaskCountPrivileged]]
|-
| 0x045100C2
| [[BOSSP:GetTaskIntervalPrivileged|GetTaskIntervalPrivileged]]
|-
| 0x045200C2
| [[BOSSP:GetTaskCountPrivileged|GetTaskCountPrivileged]]
|-
| 0x045300C2
| [[BOSSP:GetTaskServiceStatusPrivileged|GetTaskServiceStatusPrivileged]]
|-
| 0x04540102
| [[BOSSP:GetTaskStatePrivileged|GetTaskStatePrivileged]]
|-
| 0x045500C2
| [[BOSSP:GetTaskResultPrivileged|GetTaskResultPrivileged]]
|-
| 0x045600C2
| [[BOSSP:GetTaskCommErrorCodePrivileged|GetTaskCommErrorCodePrivileged]]
|-
| 0x04570142
| [[BOSSP:GetTaskStatusPrivileged|GetTaskStatusPrivileged]]
|-
| 0x04580104
| [[BOSSP:SetTaskQueryPrivileged|SetTaskQueryPrivileged]]
|}

boss:P also contains all of the commands from boss:U.

When Home Menu loads the SpotPass [[CBMD]] with [[Extended_Banner]], it uses bossP command 0x040D0182 first. Then it uses GetNsDataHeaderInfoPrivileged, then ReadNsDataPrivileged for loading the actual banner data.

==BOSS Service "boss:M"==

{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010002
| ?
|-
| 0x00020000
| ?
|-
| 0x00030040
| ?
|-
| 0x00040000
| ?
|-
| 0x00050000
| ?
|-
| 0x00060000
| ?
|-
| 0x00070000
| ?
|}

==programIDs==
BOSS uses programIDs raw without any handling for the New3DS programID-low bitmask. For example, attempting a NsDataId listing with the New3DS bitmask set will fail, if BOSS is only setup for that programID with the New3DS bitmask clear.

When [[BOSSU:InitializeSession|initializing]] BOSS with the default programID, the New3DS programID-low bitmask is always clear for New3DS titles since that's how it was originally registered with [[Filesystem_services|FS]]. Hence, the programID in the [[SpotPass|BOSS-container]] must always have the New3DS bitmask clear. This also means everything using the BOSSP commands with the raw programIDs loaded from AM title-listing are broken with New3DS titles, for example [[Extended_Banner]].

==Content Data Storage==
SpotPass content for each application is stored under the extdata specified by [[BOSS:SetStorageInfo]]. Certain commands verify that the PID associated with the current service session has access to the specified extdata by using [[FS:CheckAuthorityToAccessExtSaveData]], returning an error on failure. This basically renders SpotPass unusable under user-processes(when initialized under those processes) which don't have access to any SD extdata(unless NAND extdata is used instead).

All of these commands using [[FS:CheckAuthorityToAccessExtSaveData]] are: [[BOSS:SetStorageInfo]] and RegisterStorageEntry, for both BOSSU and BOSSP.

BOSS-container content is stored in the extdata registered for the programID specified in the BOSS-container, what task it's associated with / what title registered it is irrelevant with BOSS-container data storage.

==Custom SpotPass content==
SpotPass supports raw content download without using the encrypted+signed SpotPass container(raw content is used by [[Home Menu]] SpotPass VersionList for example). However, this is incompatible with the data-loading method used with SpotPass-container content(NsData commands can't be used with it).

When writing the raw content, it firsts deletes and creates the "<taskID>" file under the data-storage extdata with normal extdata(not the separate boss archive). Once successful, the final filename specified by the task config will be deleted if needed, then the "<taskID>" file will be renamed to the final filename. Afterwards, the user-process can access the final file just like any other extdata file.

For using custom content with the SpotPass container(like official titles), the only known ways to do so is: "CFW" / ARM11-kernelhax with the sigchecks for this patched, or some sort of BOSS-sysmodule exploit if there's any vulns to begin with.

==HTTP upload==
SpotPass tasks can be used for uploading data via HTTP POST. The exact method varies, but the main one is a [[HTTPC:SendPOSTDataRawTimeout|raw]] POST.

The content data is loaded from the following path: snprintf(outpath, outpathsize, "%s/%s%02x.up", archivepath, taskidstr_probably, unk);

The archivepath can be either "bossdb:"(BOSS-sysmodule NAND savedata) or the content-data-storage extdata. Certain other paths in the BOSS savedata can be used too.

==BOSS Tasks==
The TaskID is a 8-byte buffer containing a string including NUL-terminator(taskIDs are compared with: strncmp(str0, str1, 7)).

When disabling SpotPass, applications use [[BOSSU:CancelTask]] then [[BOSSU:UnregisterTask]], to delete each task.

Each process can only access tasks which it created, not other processes' tasks(even when using bossP with [[BOSSP:InitializeSessionPrivileged|init_programID]]=0).

After registration, tasks will not automatically run until they are started using one of the start-task commands.

==NsDataId==
This is an u32 ID for SpotPass content, used with the NsData service commands etc.

==NsDataHeaderInfo==
This type contains information about an NsData, the fields match exactly with the [[SpotPass#Payload_Content_Header|Payload Content Header]] without the hash and signature. When the input type is not one of the below or when the specified output size doesn't match the expected size for this type, an error is returned.

{| class="wikitable" border="1"
! Type !! Size !! Description
|-
| 0x0 || 0x8 || Program ID
|-
| 0x1 || 0x4 || Unknown field
|-
| 0x2 || 0x4 || Content datatype
|-
| 0x3 || 0x4 || Payload size
|-
| 0x4 || 0x4 || NS Data ID
|-
| 0x5 || 0x4 || Version
|-
| 0x6 || 0x20 || Everything:
{| class="wikitable" border="1"
! Offset !! Size !! Description
|-
| 0x0 || 0x8 || Program ID
|-
| 0x8 || 0x4 || Unknown field
|-
| 0xC || 0x4 || Content datatype
|-
| 0x10 || 0x4 || Payload size
|-
| 0x14 || 0x4 || NS Data ID
|-
| 0x18 || 0x4 || Version
|-
| 0x1C || 0x4 || Padding?
|}
|}

==PropertyIDs==
{| class="wikitable" border="1"
! ID !! Size !! Type !! Read !! Write !! Rewritable !! Description
|-
| 0x0 || 0x1 || u8 || Yes || Yes || Yes || [[#PriorityLevel|Priority]]. Represents the priority of a task
|-
| 0x1 || 0x1 || u8 || Yes || Yes || Yes || SchedulingPolicy. Unknown purpose, the API on games force this to 1
|-
| 0x2 || 0x4 || u32 || Yes || Yes || Yes || TaskTargetDuration. Unknown purpose, the API on games require a value below 0x10000 (not inclusive)
|-
| 0x3 || 0x4 || u32 || Yes || Yes || Yes || Interval in seconds of the task
|-
| 0x4 || 0x4 || u32 || Yes || Yes || Yes || Count. Number of times that the task will be run. If zero, the task is persistent
|-
| 0x5 || 0x1 || u8 || Yes || Yes || Yes || TaskPermission. Unknown purpose, the API on games require a value between 0 and 3
|-
| 0x6 || 0x1 || u8 || Yes || Yes || No || [[#ActionCode|ActionCode]]. Represents the action that a task will perform
|-
| 0x7 || 0x200 || char[512] || Yes || Yes || No || URL. Unused for DataStore actions
|-
| 0x8 || 0x4 || || Yes || Yes || No || ?
|-
| 0x9 || 0x1 || || Yes || Yes || No || Controls the action data type? The API on games require a value between 0 and 6
|-
| 0xA || 0x100 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xB and 0x3E
|-
| 0xB || 0x200 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xA and 0x3E
|-
| 0xC || 0x4 || Handle || Yes || Yes || No || Optional file handle with the data to send
|-
| 0xD || 0x360 || HeaderField[3] || Yes || Yes || No || HeaderFields. Additional headers to include in the request sent to the server. Structure:
{| class="wikitable" border="1"
|-
! Offset !! Size !! Description
|-
| 0x0 || 0x20 || char[32] Header name
|-
| 0x20 || 0x100 || char[256] Header value
|}
|-
| 0xE || 0x4 || u32[1] || Yes || Yes || No || ClientCerts. List of [[HTTPC:SetClientCertDefault|cert IDs]] to use as client certs
|-
| 0xF || 0xC || u32[3] || Yes || Yes || No || RootCAs. List of [[HTTPC:AddDefaultCert|cert IDs]] to use as root CAs
|-
| 0x10 || 0x1 || u8 || Yes || Yes || No || FSClientCert. If non-zero, enables the task client certificate to be read from the filesystem. May be a bool?
|-
| 0x11 || 0x1 || u8 || Yes || Yes || No || FSRootCA. If non-zero, enables the task root CA to be read from the filesystem. May be a bool?
|-
| 0x12 || 0x1 || u8 || Yes || Yes || No || [[#ApInfoType|ApInfoType]]
|-
| 0x13 || 0x4 || u32 || Yes || Yes || No || RootCaCount. Amount of root CAs stored in property 0xF
|-
| 0x14 || 0x4 || u32 || Yes || Yes || No || ClientCertCount. Amount of client certificates stored in property 0xE
|-
| 0x15 || 0x40 || || Yes || Yes || No || ?
|-
| 0x16 || 0x4 || || Yes || Yes || No || ?
|-
| 0x17 || || || No || No || No || Reserved
|-
| 0x18 || 0x1 || || Yes || Yes || No || Unknown purpose, the API on games force this to 1
|-
| 0x19 || 0x1 || || Yes || Yes || No || ?
|-
| 0x1A || 0x1 || || Yes || Yes || No || ?
|-
| 0x1B || 0x4 || || Yes || Yes || No || ?
|-
| 0x1C || 0x4 || || Yes || Yes || No || ?
|-
| 0x1D || 0x1 || u8 || Yes || No || No || [[#TaskStateCode|TaskStateCode]]
|-
| 0x1E || 0x1 || || Yes || No || No || ?
|-
| 0x1F || 0x1 || || Yes || No || No || ?
|-
| 0x20 || 0x1 || u8 || Yes || No || No || TaskResultCode. Unknown purpose
|-
| 0x21 || 0x1 || u8 || Yes || No || No || TaskServiceStatus. Unknown purpose
|-
| 0x22 || 0x1 || || Yes || No || No || ?
|-
| 0x23 || 0x4 || u32 || Yes || No || No || CommErrorCode. Received HTTP status code when performing the task. Set to 0 for successful codes
|-
| 0x24 || 0x1 || || Yes || No || No || ?
|-
| 0x25 || 0x4 || || Yes || No || No || ?
|-
| 0x26 || 0x4 || || Yes || No || No || ?
|-
| 0x27 || 0x4 || || Yes || No || No || ?
|-
| 0x28 || 0x8 || u64 || Yes || No || No || LastSuccessfulTimestamp. Number of seconds since the year 2000 of the last successful run of the task
|-
| 0x29 || 0x8 || || Yes || No || No || ?
|-
| 0x2A || 0x4 || || Yes || No || No || ?
|-
| 0x2B || 0x4 || || Yes || No || No || ?
|-
| 0x2C || 0x1 || || Yes || No || No || ?
|-
| 0x2D || 0x2 || || Yes || No || No || ?
|-
| 0x2E || 0x2 || || Yes || No || No || ?
|-
| 0x2F || 0x40 || char[64] || Yes || No || No || LastModifiedHeader. Date string from the Last-Modified HTTP header received when executing the task
|-
| 0x30 || 0x1 || || Yes || No || No || ?
|-
| 0x31 || 0x4 || || Yes || No || No || ?
|-
| 0x32 || 0x100 || || Yes || No || No || ?
|-
| 0x33 || 0x2 || u16 || Yes || No || No || TotalApps. Number of application IDs on the below list
|-
| 0x34 || 0x400 || u64[128] || Yes || No || No || AppIdList. List of application IDs registered in BOSS
|-
| 0x35 || 0x2 || u16 || Yes || No || No || TotalTasks. Number of task IDs on the below list
|-
| 0x36 || 0x400 || char[8][128] || Yes || No || No || TaskIdList. List of task IDs registered by the application
|-
| 0x37 || 0x2 || u16 || Yes || No || No || TotalSteps. Number of step IDs on the below list
|-
| 0x38 || 0x80 || u8[128] || Yes || No || No || StepIdList. List of steps that the task has registered
|-
| 0x39 || || || No || No || No || Reserved
|-
| 0x3A || || || No || No || No || Reserved
|-
| 0x3B || 0x4 || || Yes || Yes || No || ?
|-
| 0x3C || || || No || No || No || Reserved
|-
| 0x3D || || || No || No || No || Reserved
|-
| 0x3E || 0x200 || || Yes || Yes || No || DataStoreDownloadActionData. Shares buffer with properties 0xA and 0xB
|-
| 0x3F || 0x1 || u8 || Yes || Yes || No || [[#CfgInfoType|CfgInfoType]]
|}

The official name for this type is "PropertyType". The read column represents properties which can be obtained with [[BOSSU:ReceiveProperty|ReceiveProperty]], the write column represents properties which can be set with [[BOSSU:SendProperty|SendProperty]], and the rewritable column indicates properties which can be reassigned into an existing task with [[BOSSU:ReconfigureTask|ReconfigureTask]]. If the specified size for the command is larger than the property size, it will use the actual property size instead. When the specified size is less than the actual property size, all of the property data that won't be written to is cleared.

Trying to send a property which doesn't support being sent will give an error 0xC960F84D. Using reserved properties as an argument will give the same error.

==TaskStateCode==
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Last task run was successful?
|-
| 0x2
| Task started.
|-
| 0x5
| Task not started(also the initial state immediately after task creation).
|-
| 0x6
| Unknown
|-
| 0x7
| Task processing failed(such as network error).
|}

This u8 is returned by [[BOSSU:GetTaskState]].

==PriorityLevel==
{| class="wikitable" border="1"
! Value !! Name !! Description
|-
| 0x0 || INVALID? || Probably represents an invalid value
|-
| 0x15 || EXPEDITE1 ||
|-
| 0x16 || EXPEDITE2 ||
|-
| 0x17 || EXPEDITE3 ||
|-
| 0x18 || EXPEDITE4 ||
|-
| 0x19 || EXPEDITE5 ||
|-
| 0x1A || EXPEDITE6 ||
|-
| 0x1B || EXPEDITE7 ||
|-
| 0x1C || EXPEDITE8 ||
|-
| 0x23 || EXPEDITE ||
|-
| 0x50 || HIGH ||
|-
| 0x7D || MEDIUM || This is the default value inside the games API
|-
| 0xAA || LOW ||
|-
| 0xD7 || LOWEST ||
|-
| 0xDD || LOWEST1 ||
|-
| 0xDE || LOWEST2 ||
|-
| 0xDF || LOWEST3 ||
|-
| 0xE0 || LOWEST4 ||
|-
| 0xE1 || LOWEST5 ||
|-
| 0xE2 || LOWEST6 ||
|-
| 0xE3 || LOWEST7 ||
|-
| 0xE4 || LOWEST8 ||
|-
| 0xFF || STOPPED || The task won't be run
|}

Represents the priority of a task. Any values outside the ones listed above are considered invalid.

==ActionCode==
{| class="wikitable" border="1"
! Value !! Description
|-
| 0x1 || FileList? Action code used for listing files on the BOSS server. May be a generic raw download?
|-
| 0x2 || NsaDownload? Action code for downloading data from the given URL, principally an NsData
|-
| 0x3 || Upload? Action code for uploading data to the given URL
|-
| 0x4 || ?
|-
| 0x5 || ?
|-
| 0x6 || Action code used by task ID "pl" from the Home Menu
|-
| 0x7 || Action code used by task ID "phu" from the Home Menu
|-
| 0x8 || Action code used by task ID "tiu" from the Home Menu
|-
| 0x9 || Action code used by task ID "splu" from the Home Menu
|-
| 0xA || Action code used for downloading data from DataStore through an Hpp server. Stores notification data?
|-
| 0xB || Action code related to DataStore?
|-
| 0xC || Action code used for StreetPass Relay
|-
| 0xD || Action code used for downloading the title version list (versionList.dat)
|}

This represents the action that a task will perform.

==ApInfoType==
{| class="wikitable" border="1"
! Flag !! Description
|-
| 0x1 || Adds the "apgroup" parameter to the query
|-
| 0x2 || Adds the "aparea" parameter to the query
|-
| 0x4 || Adds the "ap" parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the access point the console is connected to.

==CfgInfoType==
{| class="wikitable sortable"
! Flag !! Description
|-
| 0x1 || Adds the "c" (two-letter country code) parameter to the query
|-
| 0x2 || Adds the "l" (two-letter language code) parameter to the query
|-
| 0x4 || Adds the "tm" ([[Cfg:GetSystemModel|target model]]) parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the console configuration.

==Errors==
{| class="wikitable" border="1"
|-
! Error-code
! Description
|-
| 0xC8A0F833
| taskID not found.
|-
| 0xC8A0F836
| taskID already exists, for task creation.
|-
| 0xC8A0F842
| The specified programID is not setup for BOSS.
|-
| 0xC8A0F843
| The specified NsDataId was not found.
|}

[[Category:Services]]

BOSS Savegame

2025-08-21T17:34:54Z

DaniElectra: Expand proper documentation

This page describes the content of the [[SpotPass|BOSS]] sysmodule savegame.

The savegame contains the following files with no directories:

==BOSS_A.db==
This file is a database containing information about applications and their session on BOSS.
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x4 || Magic Number (0x12348000)
|}

After that, an array of data entries with a size of 0x800 follow.
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x10 || [[#BOSS_A_EntryHeader|BOSS_A_EntryHeader]]
|-
| 0x10 || 0x120 || [[#BOSS_A_TitleInfo|BOSS_A_TitleInfo]]
|-
| 0x130 || 0x304 || [[#BOSS_A_Certs|BOSS_A_Certs]]
|-
| 0x434 || 0x4 || u32, Unknown. Unused?
|-
| 0x438 || 0x3C8 || Padding
|}

===BOSS_A_EntryHeader===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x8 || u64, Program ID
|-
| 0x8 || 0x1 || bool, Valid
|-
| 0x9 || 0x1 || u8, Version. Latest version is 3
|-
| 0xA || 0x6 || Padding?
|}

===BOSS_A_TitleInfo===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x8 || u64, Program ID
|-
| 0x8 || 0x1 || u8, Session maker (1: User, 2: Privileged)
|-
| 0x9 || 0x1 || bool, Optout flag
|-
| 0xA || 0x1 || bool, Arrival flag
|-
| 0xB || 0x5 || Unknown
|-
| 0x10 || 0x20 || [[#StorageEntry|StorageEntry]]
|-
| 0x30 || 0xF0 || Unknown
|}

===StorageEntry===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x1 || bool, Registered
|-
| 0x1 || 0x1 || u8, MediaType (0: NAND, 1: SD)
|-
| 0x2 || 0x2 || u16, Entry ID
|-
| 0x4 || 0x4 || u32, Storage size
|-
| 0x8 || 0x8 || u64, Extdata ID
|-
| 0x10 || 0x1 || u8, Unknown
|-
| 0x11 || 0x3 || Padding
|-
| 0x14 || 0x4 || u32, Unknown
|-
| 0x18 || 0x2 || u16, Unknown
|-
| 0x1A || 0x2 || u16, Unknown
|-
| 0x1C || 0x4 || Unknown
|}

===BOSS_A_Certs===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x1 || u8, Root CA count (stubbed to 0)
|-
| 0x1 || 0x3 || Padding
|-
| 0x4 || 0x100 || char[256][1], Root CA path
|-
| 0x104 || 0x100 || char[256], Client certificate path
|-
| 0x204 || 0x100 || char[256], Client certificate key path
|}

==BOSS_SS.db==
This file is a database containing static information about tasks.
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x4 || Magic Number (0x12348000)
|}

After that, an array of data entries with a size of 0xC00 follow. An index of this array corresponds to the data with same index in BOSS_SV.db
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x4 || [[#BOSS_SS_EntryHeader|BOSS_SS_EntryHeader]]
|-
| 0x4 || 0x7D4 || [[#TaskActionConfig|TaskActionConfig]]
|-
| 0x7D8 || 0xC || [[#TaskOptionConfig|TaskOptionConfig]]
|-
| 0x7E4 || 0x60 || [[#TaskQueryConfig|TaskQueryConfig]]
|-
| 0x844 || 0x3BC || Padding
|}

===BOSS_SS_EntryHeader===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x1 || u8, Version. Latest version is 3
|-
| 0x1 || 0x3 || Padding
|}

===TaskActionConfig===
Check the matching [[BOSS_Services#PropertyIDs|properties]] for more information about these fields.
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x1 || u8, [[BOSS_Services#ActionCode|ActionCode]]
|-
| 0x1 || 0x1 || u8, FS Root CA
|-
| 0x2 || 0x1 || u8, FS Client Cert
|-
| 0x3 || 0x1 || u8, [[BOSS_Services#ApInfoType|ApInfoType]]
|-
| 0x4 || 0x1 || u8, Property 0x9
|-
| 0x5 || 0x1 || u8, [[BOSS_Services#CfgInfoType|CfgInfoType]]
|-
| 0x6 || 0x2 || Padding
|-
| 0x8 || 0x4 || u32, Property 0x16
|-
| 0xC || 0x4 || u32, Property 0x8
|-
| 0x10 || 0x4 || u32, Property 0x3B
|-
| 0x14 || 0x4 || Handle, File handle
|-
| 0x18 || 0x200 || Action data
|-
| 0x218 || 0x200 || char[512], URL
|-
| 0x418 || 0x360 || HeaderFields
|-
| 0x790 || 0xC || u32[3], Root CAs
|-
| 0x79C || 0x4 || u32[1], Client certificates
|-
| 0x7A0 || 0x4 || u32, Root CA Count
|-
| 0x7A4 || 0x4 || u32, Client certificate count
|-
| 0x7A8 || 0x4 || Unknown
|-
| 0x7AC || 0x40 || Property 0x15
|}

===TaskOptionConfig===
Check the matching [[BOSS_Services#PropertyIDs|properties]] for more information about these fields.
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x1 || u8, Property 0x18
|-
| 0x1 || 0x1 || u8, Property 0x19
|-
| 0x2 || 0x1 || u8, Property 0x1A
|-
| 0x3 || 0x1 || Padding
|-
| 0x4 || 0x4 || u32, Property 0x1B
|-
| 0x8 || 0x4 || u32, Property 0x1C
|}

===TaskQueryConfig===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x60 || QueryField[3]. Structure:
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x1 || bool, Used
|-
| 0x1 || 0xF || char[15], Query name
|-
| 0x10 || 0x10 || char[16], Query value
|}
|}

==BOSS_SV.db==
This file is a database containing variable information about tasks.
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x4 || Magic Number (0x12348000)
|}

After that, an array of data entries with a size of 0xC00 follow. An index of this array corresponds to the data with same index in BOSS_SS.db
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x20 || [[#BOSS_SV_EntryHeader|BOSS_SV_EntryHeader]]
|-
| 0x20 || 0x10 || [[#TaskPolicyConfig|TaskPolicyConfig]]
|-
| 0x30 || 0x78 || [[#TaskStatusInfo|TaskStatusInfo]]
|-
| 0xA8 || 0x1E0 || [[#BOSS_SV_Unk1|BOSS_SV_Unk1]]
|-
| 0x288 || 0x5A8 || [[#BOSS_SV_Unk2|BOSS_SV_Unk2]]
|-
| 0x830 || 0x108 || [[#BOSS_SV_Unk3|BOSS_SV_Unk3]]
|-
| 0x938 || 0x2C8 || Padding
|}

===BOSS_SV_EntryHeader===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x3 || Magic: [0x41, 0x01, 0x01]
|-
| 0x3 || 0x1 || u8, Version. Latest version is 3
|-
| 0x4 || 0xC || Padding?
|-
| 0x10 || 0x8 || u64, Program ID
|-
| 0x18 || 0x8 || char[8], Task ID
|}

===TaskPolicyConfig===
Check the matching [[BOSS_Services#PropertyIDs|properties]] for more information about these fields.
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x1 || u8 [[BOSS_Services#PriorityLevel|PriorityLevel]]
|-
| 0x1 || 0x1 || u8, SchedulingPolicy
|-
| 0x2 || 0x1 || u8, TaskPermission
|-
| 0x3 || 0x1 || Padding?
|-
| 0x4 || 0x4 || u32, TaskTargetDuration
|-
| 0x8 || 0x4 || u32, Interval
|-
| 0xC || 0x4 || u32, Count
|}

===TaskStatusInfo===
Check the matching [[BOSS_Services#PropertyIDs|properties]] for more information about these fields.
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x8 || u64, LastSuccessfulTimestamp
|-
| 0x8 || 0x8 || u64, Property 0x29
|-
| 0x10 || 0x1 || u8, [[BOSS_Services#TaskStateCode|TaskStateCode]]
|-
| 0x11 || 0x1 || u8, Property 0x1E
|-
| 0x12 || 0x1 || u8, property 0x1F
|-
| 0x13 || 0x1 || u8, TaskServiceStatus
|-
| 0x14 || 0x1 || u8, Property 0x22
|-
| 0x15 || 0x1 || u8, TaskResultCode
|-
| 0x16 || 0x2 || Padding
|-
| 0x18 || 0x4 || u32, CommErrorCode
|-
| 0x1C || 0x4 || u32, Property 0x25
|-
| 0x20 || 0x4 || u32, Property 0x26
|-
| 0x24 || 0x4 || u32, Property 0x27
|-
| 0x28 || 0x4 || u32, Property 0x2A
|-
| 0x2C || 0x4 || u32, Property 0x2B
|-
| 0x30 || 0x2 || u16, Property 0x2D
|-
| 0x32 || 0x2 || u16, Property 0x2E
|-
| 0x34 || 0x1 || u8, Property 0x2C
|-
| 0x35 || 0x1 || u8, Property 0x24
|-
| 0x36 || 0x2 || Padding
|-
| 0x38 || 0x40 || char[64], LastModifiedHeader
|}

===BOSS_SV_Unk1===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x3 || Unknown
|-
| 0x3 || 0x1 || u8, Task type (0: Normal, 1: Immediate, 2: Background immediate)
|-
| 0x4 || 0x4 || u32, Unknown
|-
| 0x8 || 0x4 || u32, Unknown
|-
| 0xC || 0x4 || u32, Unknown
|-
| 0x10 || 0x10 || Unknown
|-
| 0x20 || 0x40 || char[64], Timestamp?
|-
| 0x60 || 0x180 || Unknown
|}

===BOSS_SV_Unk2===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x4 || u32, Unknown
|-
| 0x4 || 0x4 || u32, Unknown
|-
| 0x8 || 0x220 || Unknown
|-
| 0x228 || 0x20 || [[#StorageEntry|StorageEntry]]
|-
| 0x248 || 0x360 || Unknown
|}

===BOSS_SV_Unk3===
{| class="wikitable"
! Offset !! Size !! Description
|-
| 0x0 || 0x4 || u32, Unknown
|-
| 0x4 || 0x4 || u32, Unknown result
|-
| 0x8 || 0x4 || u32, Unknown
|-
| 0xC || 0xFC || Unknown
|}

==BOSS_PH_INFO.db==

==BOSS_PM_INFO.db==

==BOSS_SP_INFO.db==

BOSSU:RegisterPrivateClientCert

2025-08-21T14:56:46Z

DaniElectra: /* Description */ Clarify ascii85 encoding

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0006|2|4}}
{{IPC/RequestEntry|u32, Client certificate size}}
{{IPC/RequestEntry|u32, Client certificate key size}}
{{IPC/MapPointerR|Input client certificate buffer}}
{{IPC/MapPointerR|Input client certificate key buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0006|1|4}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Input client certificate buffer}}
{{IPC/MapPointerR|Input client certificate key buffer}}
{{IPC/RequestEnd}}

=Description=

This registers a private client certificate to be used by BOSS for the program ID of the current session. The certificate is saved to the BOSS savedata as: "bossdb:/%s_CL" and the certificate key is saved as: "bossdb:/%s_CLK", where %s goes the program ID Ascii85 encoded.

BOSSU:RegisterPrivateRootCa

2025-08-21T14:56:26Z

DaniElectra: /* Description */ Clarify ascii85 encoding

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0005|1|2}}
{{IPC/RequestEntry|u32, Buffer size}}
{{IPC/MapPointerR|Input root CA buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0005|1|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Input root CA buffer}}
{{IPC/RequestEnd}}

=Description=

This registers a private root certificate to be used by BOSS for the program ID of the current session. The certificate is saved to the BOSS savedata as: "bossdb:/%s_CA%d", where %s goes the program ID Ascii85 encoded and %d is the index of the root certificate.

SpotPass

2025-08-21T14:54:16Z

DaniElectra: /* Payload Content Header */ Expand documentation

'''SpotPass''' is a Nintendo 3DS feature that allows the 3DS to automatically download content, notifications, and software when it's in standby mode.(SpotPass may download/upload some content while the 3DS is in "active" mode, but *only* if the currently active app uses SpotPass) SpotPass can upload content as well. Software downloaded with SpotPass is stored on SD card.

SpotPass Internet communications are mostly HTTPS transfers.

In System Settings, you can disable SpotPass automatic title downloading, but it states that important software will still downloaded.(This only disables downloading of free titles via SpotPass)

'nasc.nintendowifi.net' confirmed usages:(not SpotPass related)

*Friends List applet requires this server to be 'Online' (most likely the reason for regular requests to this server)
*Required for initialization of [[eShop]], (for first time eShop users). Not required for using eShop after first use.

In some cases the BOSS module will add the following URL parameter to HTTPS requests, when connected to a [[Nintendo Zone]] AP: "ap=<NZoneApNum>" or when using a specific [[Cfg:GetSystemModel|system model]]: "tm=<SystemModelNumber>". The Old 3DS and Old 3DS XL don't set this value.

== policylist ==
Every time the system connects to the wifi AP, the BOSS ("Background online storage service" = SpotPass) module itself will download the cleartext xml policylist: "https://nppl.c.app.nintendowifi.net/p01/policylist/3/<countrycode>". This policylist contains a list of SpotPass tasks for certain titles. This policylist can control whether the specified tasks are processed at all.

As of the policylist updated 2017-11-08, this stops the <tt>OlvNotf</tt> (Miiverse notification sync) task for <tt>000400300000bc00</tt>, <tt>000400300000bd00</tt>, <tt>000400300000be00</tt> for all regions and <tt>basho0</tt> for the [[Home Menu]]. Japan also has the <tt>9ER_NTD</tt> task blocked for いつの間にテレビ (<tt>0004000000034700</tt>).

== User Agent ==

The default user-agent used for SpotPass HTTPS requests (including the policylist) has the following format:

<tt><user agent codename>-<user agent version>/<printed hex u64 [[CfgS:GetLocalFriendCodeSeed|LocalFriendCodeSeed]]>-<printed hex u64 [[FRDU:GetMyFriendKey|Friend]] [[FRDU:PrincipalIdToFriendCode|Code]]>/<text [[CVer|system]] [[NVer|version]]>/<CTRSDK version of sysmodule>/<[[Cfg:GetSystemModel|system model number]]></tt>

The codename can be set to either <tt>PBOS</tt> (Production BOSS?) or <tt>DBOS</tt> (Development BOSS?) depending if the console is a [[Configuration_Memory#UNITINFO|retail]] unit. As of system version 11.17, the user agent version is hardcoded to 8.0 and the CTRSDK version is set to 62452 (0xF3F4).

No user-agent is used for plaintext HTTP requests with SpotPass.

== Titles Spotpass usage ==
{| class="wikitable"
|-
! Title
! Description
|-
| [[Home Menu]]
| Home Menu uses SpotPass for system notifications, and for uploading data from home-menu shared extdata.
|-
| [[System Settings]]
| System Settings uses SpotPass for uploading data, with this URL: https://npul.c.app.nintendowifi.net/p01/recv/<RegionID>/sendcfg This RegionID is separate from the RegionIDs home-menu uses.
|-
| ?
| Unknown log data is uploaded with this URL: https://logus-p.est.c.app.nintendowifi.net/LogServer_us_live/Upload
|}

== Automatic System Update Download ==
See [[Automatic System Update Download]].

== BOSS Sysmodule Savegame==
See [[BOSS Savegame]]

== Content Container ==

SpotPass content must use this container to encrypt the payload and sign it, for content downloads. The cleartext content is stored in [[extdata]]. The format of these headers is big-endian.

=== BOSS Header ===
{| class="wikitable"
|-
! Offset
! Length
! Description
|-
| 0x0
| 0x4
| Magic Number "boss"
|-
| 0x4
| 0x4
| Magic Number 0x10001
|-
| 0x8
| 0x4
| Big-endian filesize
|-
| 0xC
| 0x8
| u64 serial number (?)
|-
| 0x14
| 0x2
| Must always be 0x1
|-
| 0x16
| 0x2
| Padding
|-
| 0x18
| 0x2
| Content header hash type, always 0x2 for SHA-256
|-
| 0x1A
| 0x2
| Content header RSA size, always 0x2 for RSA-2048 (X<<7)
|-
| 0x1C
| 0xC
| First 12 bytes of the Initialization Vector (IV)
|}

Data following the BOSS header is encrypted with AES-CTR. The AES key that is used is stored in [[AES_Registers#Keyslots|keyslot 0x38]]. The first 12 bytes of the IV are from offset 0x1C of the header, while the last 32-bit integer of the IV in big-endian is 0x1. The IV from the header is random per file, and an unique random IV is used each time the content is updated. The cleartext data begins with the content header.

The 64-bit number at 0xC may be a serial number which is increased every time someone requested to sign and create a boss container for a file. The 3DS sees the downloaded file as new if this number is different from the previous download (Doesn't matter if the number is bigger or smaller).

The boss system module v13314 begins at address 0x0010eb98 with the function for parsing the BOSS header.

=== Content Header ===
{| class="wikitable"
|-
! Offset
! Length
! Description
|-
| 0x0
| 0x10
| ?
|-
| 0x10
| 0x2
| Number of payload contents (Payload Content Header + Payload)
|-
| 0x12
| 0x20
| SHA-256 hash
|-
| 0x32
| 0x100
| RSA-2048 signature over the above hash
|}

The first 0x10-bytes are all-zero except the first byte. If the 7th bit (0x80) is not set, the arrived flag will only be marked if the session for the target program ID was made with a privileged session. Otherwise, the arrived flag will always be marked.

The 16-bit value at 0x10 tells how many payload contents follow after this the content header. For example there can be a downloaded file for a game followed by a message for the news system module.

The hash at offset 0x12 hashes the 0x12-byte data at offset 0x0 followed by a zero u16. The RSA signature is signed by Nintendo. Following this header is the actual content payload, which is written to a cleartext file under the [[extdata]] /boss directory.

=== Payload Content Header ===
{| class="wikitable"
|-
! Offset
! Length
! Description
|-
| 0x0
| 0x8
| Program ID
|-
| 0x8
| 0x4
| Usually zero?
|-
| 0xC
| 0x4
| Content datatype, used for filtering with [[BOSSU:GetNsDataIdList]].
Usually 0x10001? (observed 0x20001 in eShop strings)
|-
| 0x10
| 0x4
| Size of the payload after this header
|-
| 0x14
| 0x4
| [[BOSS_Services|NsDataId]], used for generating the extdata filepath.
|-
| 0x18
| 0x4
| Probably some version field for the payload
|-
| 0x1C
| 0x20
| SHA-256 hash
|-
| 0x3C
| 0x100
| RSA-2048 signature over the previous SHA-256 hash
|}

This signature is signed by Nintendo with the same key-pair as the content header.

The hash at offset 0x1C hashes the 0x1C-byte data at offset 0x0 followed by a zero u16, followed by all of the remaining cleartext data following this header (the actual content data).

The file name of the downloaded boss data is Ascii85 encoded with the following data:

{| class="wikitable"
! Offset !! Length !! Description
|-
| 0x0 || 0x5 || NS Data ID
|-
| 0x5 || 0x5 || Version
|-
| 0xA || 0x5 || Content datatype
|-
| 0xF || 0x1 || New flag
|}

The downloaded boss data is written in the following format to extdata. First an extdata header in the following format:
{| class="wikitable"
|-
! Offset
! Length
! Description
|-
| 0x0
| 0x1
| Size of header including this field. Always 0x18
|-
| 0x1
| 0x3
| Padding
|-
| 0x4
| 0x4
| [[BOSSU:GetNsDataAdditionalInfo|Additional info]]
|-
| 0x8
| 0x4
| Unknown
|-
| 0xC
| 0x8
| [[BOSSU:GetNsDataLastUpdate|Last update]] in number of seconds since the year 2000
|-
| 0x14
| 0x4
| Padding
|}

Followed by the Payload Content Header without the hash and signature (first 0x1C bytes) and the actual payload.

==Tools==
* [http://wiiucodes.ddnss.eu/tools/BossDecryptor3DS.zip BossDecryptor3DS] Decrypts an encrypted boss container
* [http://wiiucodes.ddnss.eu/tools/BossEncryptor3DS.zip BossEncryptor3DS] Builds and encrypts a file into a boss container

[[Category:Nintendo Software]]

SpotPass

2025-08-21T14:42:21Z

DaniElectra: /* Content Header */ Document meaning of first byte

'''SpotPass''' is a Nintendo 3DS feature that allows the 3DS to automatically download content, notifications, and software when it's in standby mode.(SpotPass may download/upload some content while the 3DS is in "active" mode, but *only* if the currently active app uses SpotPass) SpotPass can upload content as well. Software downloaded with SpotPass is stored on SD card.

SpotPass Internet communications are mostly HTTPS transfers.

In System Settings, you can disable SpotPass automatic title downloading, but it states that important software will still downloaded.(This only disables downloading of free titles via SpotPass)

'nasc.nintendowifi.net' confirmed usages:(not SpotPass related)

*Friends List applet requires this server to be 'Online' (most likely the reason for regular requests to this server)
*Required for initialization of [[eShop]], (for first time eShop users). Not required for using eShop after first use.

In some cases the BOSS module will add the following URL parameter to HTTPS requests, when connected to a [[Nintendo Zone]] AP: "ap=<NZoneApNum>" or when using a specific [[Cfg:GetSystemModel|system model]]: "tm=<SystemModelNumber>". The Old 3DS and Old 3DS XL don't set this value.

== policylist ==
Every time the system connects to the wifi AP, the BOSS ("Background online storage service" = SpotPass) module itself will download the cleartext xml policylist: "https://nppl.c.app.nintendowifi.net/p01/policylist/3/<countrycode>". This policylist contains a list of SpotPass tasks for certain titles. This policylist can control whether the specified tasks are processed at all.

As of the policylist updated 2017-11-08, this stops the <tt>OlvNotf</tt> (Miiverse notification sync) task for <tt>000400300000bc00</tt>, <tt>000400300000bd00</tt>, <tt>000400300000be00</tt> for all regions and <tt>basho0</tt> for the [[Home Menu]]. Japan also has the <tt>9ER_NTD</tt> task blocked for いつの間にテレビ (<tt>0004000000034700</tt>).

== User Agent ==

The default user-agent used for SpotPass HTTPS requests (including the policylist) has the following format:

<tt><user agent codename>-<user agent version>/<printed hex u64 [[CfgS:GetLocalFriendCodeSeed|LocalFriendCodeSeed]]>-<printed hex u64 [[FRDU:GetMyFriendKey|Friend]] [[FRDU:PrincipalIdToFriendCode|Code]]>/<text [[CVer|system]] [[NVer|version]]>/<CTRSDK version of sysmodule>/<[[Cfg:GetSystemModel|system model number]]></tt>

The codename can be set to either <tt>PBOS</tt> (Production BOSS?) or <tt>DBOS</tt> (Development BOSS?) depending if the console is a [[Configuration_Memory#UNITINFO|retail]] unit. As of system version 11.17, the user agent version is hardcoded to 8.0 and the CTRSDK version is set to 62452 (0xF3F4).

No user-agent is used for plaintext HTTP requests with SpotPass.

== Titles Spotpass usage ==
{| class="wikitable"
|-
! Title
! Description
|-
| [[Home Menu]]
| Home Menu uses SpotPass for system notifications, and for uploading data from home-menu shared extdata.
|-
| [[System Settings]]
| System Settings uses SpotPass for uploading data, with this URL: https://npul.c.app.nintendowifi.net/p01/recv/<RegionID>/sendcfg This RegionID is separate from the RegionIDs home-menu uses.
|-
| ?
| Unknown log data is uploaded with this URL: https://logus-p.est.c.app.nintendowifi.net/LogServer_us_live/Upload
|}

== Automatic System Update Download ==
See [[Automatic System Update Download]].

== BOSS Sysmodule Savegame==
See [[BOSS Savegame]]

== Content Container ==

SpotPass content must use this container to encrypt the payload and sign it, for content downloads. The cleartext content is stored in [[extdata]]. The format of these headers is big-endian.

=== BOSS Header ===
{| class="wikitable"
|-
! Offset
! Length
! Description
|-
| 0x0
| 0x4
| Magic Number "boss"
|-
| 0x4
| 0x4
| Magic Number 0x10001
|-
| 0x8
| 0x4
| Big-endian filesize
|-
| 0xC
| 0x8
| u64 serial number (?)
|-
| 0x14
| 0x2
| Must always be 0x1
|-
| 0x16
| 0x2
| Padding
|-
| 0x18
| 0x2
| Content header hash type, always 0x2 for SHA-256
|-
| 0x1A
| 0x2
| Content header RSA size, always 0x2 for RSA-2048 (X<<7)
|-
| 0x1C
| 0xC
| First 12 bytes of the Initialization Vector (IV)
|}

Data following the BOSS header is encrypted with AES-CTR. The AES key that is used is stored in [[AES_Registers#Keyslots|keyslot 0x38]]. The first 12 bytes of the IV are from offset 0x1C of the header, while the last 32-bit integer of the IV in big-endian is 0x1. The IV from the header is random per file, and an unique random IV is used each time the content is updated. The cleartext data begins with the content header.

The 64-bit number at 0xC may be a serial number which is increased every time someone requested to sign and create a boss container for a file. The 3DS sees the downloaded file as new if this number is different from the previous download (Doesn't matter if the number is bigger or smaller).

The boss system module v13314 begins at address 0x0010eb98 with the function for parsing the BOSS header.

=== Content Header ===
{| class="wikitable"
|-
! Offset
! Length
! Description
|-
| 0x0
| 0x10
| ?
|-
| 0x10
| 0x2
| Number of payload contents (Payload Content Header + Payload)
|-
| 0x12
| 0x20
| SHA-256 hash
|-
| 0x32
| 0x100
| RSA-2048 signature over the above hash
|}

The first 0x10-bytes are all-zero except the first byte. If the 7th bit (0x80) is not set, the arrived flag will only be marked if the session for the target program ID was made with a privileged session. Otherwise, the arrived flag will always be marked.

The 16-bit value at 0x10 tells how many payload contents follow after this the content header. For example there can be a downloaded file for a game followed by a message for the news system module.

The hash at offset 0x12 hashes the 0x12-byte data at offset 0x0 followed by a zero u16. The RSA signature is signed by Nintendo. Following this header is the actual content payload, which is written to a cleartext file under the [[extdata]] /boss directory.

=== Payload Content Header ===
{| class="wikitable"
|-
! Offset
! Length
! Description
|-
| 0x0
| 0x8
| ProgramID
|-
| 0x8
| 0x4
| Usually zero?
|-
| 0xC
| 0x4
| Content datatype, used for filtering with [[BOSSU:GetNsDataIdList]].
Usually 0x10001? (observed 0x20001 in eShop strings)
|-
| 0x10
| 0x4
| Size of the payload after this header
|-
| 0x14
| 0x4
| [[BOSS_Services|NsDataId]], used for generating the extdata filepath.
|-
| 0x18
| 0x4
| Probably some version field for the payload
|-
| 0x1C
| 0x20
| SHA-256 hash
|-
| 0x3C
| 0x100
| RSA-2048 signature over the previous SHA-256 hash
|}

This signature is signed by Nintendo with the same key-pair as the content header.

The hash at offset 0x1C hashes the 0x1C-byte data at offset 0x0 followed by a zero u16, followed by all of the remaining cleartext data following this header(the actual content data).

The downloaded boss data is written in the following format to extdata. The file name that is generated might be Base85/Ascii85 encoded.
First an extdata header in the following format
{| class="wikitable"
|-
! Offset
! Length
! Description
|-
| 0x0
| 0x1
| Size of header including this field. Always 0x18
|-
| 0x1
| 0xB
| Usually zero?
|-
| 0xC
| 0x4
| Unknown
|-
| 0x10
| 0x4
| Download date in format: Bit 0-5 = day, Bit 6-9 = month, Bit 10-20 = year
|-
| 0x14
| 0x4
| Usually zero? Padding?
|}
Followed by the Payload Content Header without the hash and signature (first 0x1C bytes) and the actual payload.

==Tools==
* [http://wiiucodes.ddnss.eu/tools/BossDecryptor3DS.zip BossDecryptor3DS] Decrypts an encrypted boss container
* [http://wiiucodes.ddnss.eu/tools/BossEncryptor3DS.zip BossEncryptor3DS] Builds and encrypts a file into a boss container

[[Category:Nintendo Software]]

BOSSU:GetNsDataIdList2

2025-08-21T14:05:43Z

DaniElectra: /* Description */ Link to internals section of GetNsDataIdList

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0012|4|2}}
{{IPC/RequestEntryRange|6|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0012|3|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntryRange|4|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Description=
Identical to [[BOSSU:GetNsDataIdList]], except the called function mentioned [[BOSSU:GetNsDataIdList#Internals|here]] is used with the following type parameters: 1, 1, 1. Thus, this parameter filters by entries which don't have the new flag set and those with a matching program ID of the current session.

BOSSU:GetNsDataIdList3

2025-08-21T14:05:23Z

DaniElectra: /* Description */ Link to internals section of GetNsDataIdList

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0013|4|2}}
{{IPC/RequestEntryRange|6|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0013|3|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntryRange|4|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Description=
Identical to [[BOSSU:GetNsDataIdList]], except the called function mentioned [[BOSSU:GetNsDataIdList#Internals|here]] is used with the following type parameters: 1, 1, 0. Thus, this command filters by entries which don't have the new flag set, and doesn't filter by the program ID.

BOSSU:GetNsDataIdList3

2025-08-21T14:04:19Z

DaniElectra: /* Description */ Explain type parameters

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0013|4|2}}
{{IPC/RequestEntryRange|6|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0013|3|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntryRange|4|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Description=
Identical to [[BOSSU:GetNsDataIdList]], except the called function mentioned [[BOSSU:GetNsDataIdList|here]] is used with the following type parameters: 1, 1, 0. Thus, this command filters by entries which don't have the new flag set, and doesn't filter by the program ID.

BOSSU:GetNsDataIdList2

2025-08-21T14:02:52Z

DaniElectra: /* Description */ Explain type parameters

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0012|4|2}}
{{IPC/RequestEntryRange|6|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0012|3|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntryRange|4|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Description=
Identical to [[BOSSU:GetNsDataIdList]], except the called function mentioned [[BOSSU:GetNsDataIdList|here]] is used with the following type parameters: 1, 1, 1. Thus, this parameter filters by entries which don't have the new flag set and those with a matching program ID of the current session.

BOSSU:GetNsDataIdList1

2025-08-21T14:01:20Z

DaniElectra: Explain type parameters

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0011|4|2}}
{{IPC/RequestEntryRange|6|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0011|3|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntryRange|4|Identical to [[BOSSU:GetNsDataIdList]]}}
{{IPC/RequestEnd}}

=Description=
Identical to [[BOSSU:GetNsDataIdList]], except the called function mentioned [[BOSSU:GetNsDataIdList#Internals|here]] is used with the following type parameters: 0, 1, 0. Thus, this command doesn't filter by either the new flag or the program ID of the current session.

BOSSU:GetNsDataIdList

2025-08-21T13:57:41Z

DaniElectra: /* Description */ Explain type parameters

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0010|4|2}}
{{IPC/RequestEntry|u32, Filter}}
{{IPC/RequestEntry|u32, Number of entries that the list can hold (max entries)}}
{{IPC/RequestEntry|u16, Starting index in the internal NS Data ID list}}
{{IPC/RequestEntry|u32, Starting NS Data ID}}
{{IPC/MapPointerW|Output NS Data ID list}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0010|3|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u16, Actual number of output entries}}
{{IPC/RequestEntry|u16, Last index copied to output in the internal NS Data ID list}}
{{IPC/MapPointerW|Output NS Data ID list}}
{{IPC/RequestEnd}}

=Description=
Writes an array of NS Data ID entries (u32) for the program ID of the current session to the output buffer using the provided filters.

==Internals==
This eventually calls a function with the following type parameters: 0, 1, 1. This function doesn't use the second type parameter. Afterwards another function is called using the program ID.

The first type parameter is a filter based on the new flag of the NsData:

{| class="wikitable" border="1"
! Value !! Description
|-
| 0 || Allow everything
|-
| 1 || Only allow entries which don't have the new flag set
|-
| 2 || Only allow entries which have the new flag set
|}

The second type parameter represents the session being used for the command:

{| class="wikitable" border="1"
! Value !! Description
|-
| 1 || User
|-
| 2 || Privileged
|}

The third type parameter is a filter based on the program ID of the session:

{| class="wikitable" border="1"
! Value !! Description
|-
| 0 || Allow everything
|-
| 1 || Only allow entries which have a target program ID matching the program ID of the session
|}

Hence, this command only lists entries whose program ID matches the one from this session.

=Filter=
Content filtering is enabled when this word isn't 0xFFFFFFFF. This is only used for the following: <code>if (filterword_u16high != contentdatatype_u16high || (filterword_u16low & contentdatatype_u16low) == 0) continue;</code> Hence, filterword_u16high must match contentdatatype_u16high, and the bitmask specified by filterword_u16low must be non-zero in contentdatatype_u16low. The contentdatatype is extracted from the extdata filename, which originates from the [[SpotPass|BOSS-container]]. The NS Data ID for the content entry is only written to the output when processing isn't skipped due to filtering.

=Start NsDataId=
This field is only used when the starting index is non-zero or when this field is non-zero.

The NS Data ID at the specified starting index must match this field, otherwise error 0xD840F846 is returned. It will then skip normal content entry processing for this matching entry (cur_wordindex is field is increased by 0x1 before starting the content entry processing loop).

BOSS Services

2025-08-21T11:55:59Z

DaniElectra: /* NsDataHeaderInfo */ Clarify information

==BOSS User Service "boss:U"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010082
| [[BOSSU:InitializeSession|InitializeSession]]
|-
| 0x00020100
| [[BOSSU:SetStorageInfo|SetStorageInfo]]
|-
| 0x00030000
| [[BOSSU:UnregisterStorage|UnregisterStorage]]
|-
| 0x00040000
| [[BOSSU:GetStorageInfo|GetStorageInfo]]
|-
| 0x00050042
| [[BOSSU:RegisterPrivateRootCa|RegisterPrivateRootCa]]
|-
| 0x00060084
| [[BOSSU:RegisterPrivateClientCert|RegisterPrivateClientCert]] <nowiki>(u32 Size0, u32 Size1, ((Size0<<4) | 10), Buf0, ((Size1<<4) | 10), Buf1)</nowiki> This writes the content of the input buffers into files "bossdb:/%s_CL" and "bossdb:/%s_CLK", where "%s" is generated from the programID.
|-
| 0x00070000
| [[BOSSU:GetNewArrivalFlag|GetNewArrivalFlag]]
|-
| 0x00080002
| [[BOSSU:RegisterNewArrivalEvent|RegisterNewArrivalEvent]]: Used for sending a handle. This is used with a table of programIDs etc with a maximum of 5 entries.
|-
| 0x00090040
| [[BOSSU:SetOptoutFlag|SetOptoutFlag]]
|-
| 0x000A0000
| [[BOSSU:GetOptoutFlag|GetOptoutFlag]]
|-
| 0x000B00C2
| [[BOSSU:RegisterTask|RegisterTask]]
|-
| 0x000C0082
| [[BOSSU:UnregisterTask|UnregisterTask]]
|-
| 0x000D0082
| [[BOSSU:ReconfigureTask|ReconfigureTask]]
|-
| 0x000E0000
| [[BOSSU:GetTaskIdList|GetTaskIdList]]
|-
| 0x000F0042
| [[BOSSU:GetStepIdList|GetStepIdList]]
|-
| 0x00100102
| [[BOSSU:GetNsDataIdList|GetNsDataIdList]]
|-
| 0x00110102
| [[BOSSU:GetNsDataIdList1|GetNsDataIdList1]]
|-
| 0x00120102
| [[BOSSU:GetNsDataIdList2|GetNsDataIdList2]]
|-
| 0x00130102
| [[BOSSU:GetNsDataIdList3|GetNsDataIdList3]]
|-
| 0x00140082
| [[BOSSU:SendProperty|SendProperty]]
|-
| 0x00150042
| [[BOSSU:SendPropertyHandle|SendPropertyHandle]]
|-
| 0x00160082
| [[BOSSU:ReceiveProperty|ReceiveProperty]]
|-
| 0x00170082
| [[BOSSU:UpdateTaskInterval|UpdateTaskInterval]]
|-
| 0x00180082
| [[BOSSU:UpdateTaskCount|UpdateTaskCount]]
|-
| 0x00190042
| [[BOSSU:GetTaskInterval|GetTaskInterval]]
|-
| 0x001A0042
| [[BOSSU:GetTaskCount|GetTaskCount]]
|-
| 0x001B0042
| [[BOSSU:GetTaskServiceStatus|GetTaskServiceStatus]]
|-
| 0x001C0042
| [[BOSSU:StartTask|StartTask]]
|-
| 0x001D0042
| [[BOSSU:StartTaskImmediate|StartTaskImmediate]]
|-
| 0x001E0042
| [[BOSSU:CancelTask|CancelTask]]
|-
| 0x001F0000
| [[BOSSU:GetTaskFinishHandle|GetTaskFinishHandle]]
|-
| 0x00200082
| [[BOSSU:GetTaskState|GetTaskState]]
|-
| 0x00210042
| [[BOSSU:GetTaskResult|GetTaskResult]]
|-
| 0x00220042
| [[BOSSU:GetTaskCommErrorCode|GetTaskCommErrorCode]]
|-
| 0x002300C2
| [[BOSSU:GetTaskStatus|GetTaskStatus]]
|-
| 0x00240082
| [[BOSSU:GetTaskError|GetTaskError]]
|-
| 0x00250082
| [[BOSSU:GetTaskInfo|GetTaskInfo]]
|-
| 0x00260040
| [[BOSSU:DeleteNsData|DeleteNsData]]
|-
| 0x002700C2
| [[BOSSU:GetNsDataHeaderInfo|GetNsDataHeaderInfo]]
|-
| 0x00280102
| [[BOSSU:ReadNsData|ReadNsData]]
|-
| 0x00290080
| [[BOSSU:SetNsDataAdditionalInfo|SetNsDataAdditionalInfo]]
|-
| 0x002A0040
| [[BOSSU:GetNsDataAdditionalInfo|GetNsDataAdditionalInfo]]. Writes an output u32 to cmdreply[2].
|-
| 0x002B0080
| [[BOSSU:SetNsDataNewFlag|SetNsDataNewFlag]]
|-
| 0x002C0040
| [[BOSSU:GetNsDataNewFlag|GetNsDataNewFlag]]
|-
| 0x002D0040
| [[BOSSU:GetNsDataLastUpdate|GetNsDataLastUpdate]] (u32 NsDataId) Writes an output u64 to cmdreply[2-3], from the content file in extdata.
|-
| 0x002E0040
| [[BOSSU:GetErrorCode|GetErrorCode]]
|-
| 0x002F0140
| [[BOSSU:RegisterStorageEntry|RegisterStorageEntry]]
|-
| 0x00300000
| [[BOSSU:GetStorageEntryInfo|GetStorageEntryInfo]]
|-
| 0x00310100
| [[BOSSU:SetStorageOption|SetStorageOption]]
|-
| 0x00320000
| [[BOSSU:GetStorageOption|GetStorageOption]]
|-
| 0x00330042
| [[BOSSU:StartBgImmediate|StartBgImmediate]]
|-
| 0x00340042
| [[BOSSU:GetTaskPriority|GetTaskPriority]]
|-
| 0x003500C2
| [[BOSSU:RegisterImmediateTask|RegisterImmediateTask]]
|-
| 0x00360084
| [[BOSSU:SetTaskQuery|SetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|-
| 0x00370084
| [[BOSSU:GetTaskQuery|GetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|}

==BOSS Privileged Service "boss:P"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x04010082
| [[BOSSP:InitializeSessionPrivileged|InitializeSessionPrivileged]]
|-
| 0x04020000
| ?
|-
| 0x04030000
| ?
|-
| 0x04040080
| [[BOSSP:GetAppNewFlag|GetAppNewFlag]]
|-
| 0x040500C0
| [[BOSSP:SetAppNewFlag|SetAppNewFlag]]
|-
| 0x040600C0
| [[BOSSP:SetOptoutFlagPrivileged|SetOptoutFlagPrivileged]]
|-
| 0x04070080
| [[BOSSP:GetOptoutFlagPrivileged|GetOptoutFlagPrivileged]]
|-
| 0x04080040
| (u8 optout) Sets the optout flag to all apps?
|-
| 0x04090102
| [[BOSSP:UnregisterTaskPrivileged|UnregisterTaskPrivileged]]
|-
| 0x040A0000
| [[BOSSP:GetAppIdList|GetAppIdList]]
|-
| 0x040B0080
| [[BOSSP:GetTaskIdListPrivileged|GetTaskIdListPrivileged]]
|-
| 0x040C00C2
| [[BOSSP:GetStepIdListPrivileged|GetStepIdListPrivileged]]
|-
| 0x040D0182
| [[BOSSP:GetNsDataIdListPrivileged|GetNsDataIdListPrivileged]]
|-
| 0x040E0182
| [[BOSSP:GetNsDataIdListPrivileged1|GetNsDataIdListPrivileged1]]
|-
| 0x040F0102
| [[BOSSP:GetTaskInfoPrivileged|GetTaskInfoPrivileged]]
|-
| 0x04100102
| [[BOSSP:GetTaskStatusPrivileged1|GetTaskStatusPrivileged1]] Same as GetTaskStatusPrivileged, but the input bool is set to false
|-
| 0x04110102
| [[BOSSP:GetTaskErrorPrivileged|GetTaskErrorPrivileged]]
|-
| 0x04120000
| Related to the sysmodule savedata?
|-
| 0x04130082
| [[BOSSP:SendPropertyPrivileged|SendPropertyPrivileged]]
|-
| 0x04140082
| [[BOSSP:ReceivePropertyPrivileged|ReceivePropertyPrivileged]]
|-
| 0x041500C0
| [[BOSSP:DeleteNsDataPrivileged|DeleteNsDataPrivileged]]
|-
| 0x04160142
| [[BOSSP:GetNsDataHeaderInfoPrivileged|GetNsDataHeaderInfoPrivileged]]
|-
| 0x04170182
| [[BOSSP:ReadNsDataPrivileged|ReadNsDataPrivileged]]
|-
| 0x04180100
| [[BOSSP:SetNsDataAdditionalInfoPrivileged|SetNsDataAdditionalInfoPrivileged]]
|-
| 0x041900C0
| [[BOSSP:GetNsDataAdditionalInfoPrivileged|GetNsDataAdditionalInfoPrivileged]]
|-
| 0x041A0100
| [[BOSSP:SetNsDataNewFlagPrivileged|SetNsDataNewFlagPrivileged]]
|-
| 0x041B00C0
| [[BOSSP:GetNsDataNewFlagPrivileged|GetNsDataNewFlagPrivileged]]
|-
| 0x041C00C0
| [[BOSSP:GetNsDataLastUpdatePrivileged|GetNsDataLastUpdatePrivileged]]
|-
| 0x041D0040
| (bool unk_flag1)
|-
| 0x041E0000
| Returns: bool unk_flag1
|-
| 0x041F0040
| [[BOSSP:SetTestModeAvailability|SetTestModeAvailability]] (bool test_mode_flag)
|-
| 0x04200000
| [[BOSSP:GetTestModeAvailability|GetTestModeAvailability]]. Returns: bool test_mode_flag
|-
| 0x04210000?
| Stubbed
|-
| 0x04220000
| ?
|-
| 0x04230000?
| Stubbed
|-
| 0x04240000
| ?
|-
| 0x04250042
| [[BOSSP:SetPolicyListEnvId|SetPolicyListEnvId]]. Sets the policylist env ID (default env ID is "p01"): strncpy("p01", in, 8)
|-
| 0x04260042
| [[BOSSP:GetPolicyListEnvId|GetPolicyListEnvId]]. Gets the policylist env ID (default env ID is "p01"): strcpy(out, "p01")
|-
| 0x04270042
| [[BOSSP:SetPolicyListUrl|SetPolicyListUrl]]. Sets a custom policylist URL. Max of 0x200 chars
|-
| 0x04280042
| [[BOSSP:GetPolicyListUrl|GetPolicyListUrl]]. Gets the custom policylist URL
|-
| 0x04290002
| (Handle unk)
|-
| 0x042A0000
| Closes the previous handle
|-
| 0x042B0000
| Returns: u8 unk
|-
| 0x042C0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>
|-
| 0x042D0000
| Returns: u32 unk
|-
| 0x042E00C2
| [[BOSSP:StartTaskPrivileged|StartTaskPrivileged]]
|-
| 0x042F00C2
| [[BOSSP:StartTaskImmediatePrivileged|StartTaskImmediatePrivileged]]
|-
| 0x043000C2
| [[BOSSP:CancelTaskPrivileged|CancelTaskPrivileged]]
|-
| 0x04310040
| (u32 unk_4) The input is stored in a variable whose default value is 0x70
|-
| 0x04320040
| Returns: u32 unk_4
|-
| 0x04330080
| [[BOSSP:GetStorageOptionPrivileged|GetStorageOptionPrivileged]]
|-
| 0x043400C2
| [[BOSSP:StartBgImmediatePrivileged|StartBgImmediatePrivileged]]
|-
| 0x04350042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x04360042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043700C2
| [[BOSSP:GetTaskPriorityPrivileged|GetTaskPriorityPrivileged]]
|-
| 0x04380000
| ?
|-
| 0x04390104
| [[BOSSP:GetTaskQueryPrivileged|GetTaskQueryPrivileged]]
|-
| 0x043A0042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x043B0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043C0080
| (u64 title_id)
|-
| 0x043D0080
| (u64 title_id)
|-
| 0x043E0042
| [[BOSSP:SetSprelayUrl|SetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Sets the sprelay URL
|-
| 0x043F0042
| [[BOSSP:GetSprelayUrl|GetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Gets the sprelay URL
|-
| 0x04400080
| [[BOSSP:SetSprelayInterval|SetSprelayInterval]] (u32 interval, u32 unk). Sets the sprelay interval, and other things
|-
| 0x04410000
| [[BOSSP:GetSprelayInterval|GetSprelayInterval]] Returns: u32 interval, u32 unk. Gets the sprelay interval, and other things
|-
| 0x04420000
| ?
|-
| 0x04430042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x208
|-
| 0x04440042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x130
|-
| 0x04450040
| (u8 unk_5)
|-
| 0x04460000
| Returns: u8 unk_5
|-
| 0x04470002
| [[BOSSP:RegisterNewArrivalEventPrivileged|RegisterNewArrivalEventPrivileged]]
|-
| 0x04480000?
| Stubbed
|-
| 0x04490142
| [[BOSSP:RegisterTaskPrivileged|RegisterTaskPrivileged]]
|-
| 0x044A0180
| [[BOSSP:SetStorageInfoPrivileged|SetStorageInfoPrivileged]]
|-
| 0x044B01C0
| [[BOSSP:RegisterStorageEntryPrivileged|RegisterStorageEntryPrivileged]]
|-
| 0x044C0080
| [[BOSSP:UnregisterStoragePrivileged|UnregisterStoragePrivileged]]
|-
| 0x044D0080
| [[BOSSP:GetStorageInfoPrivileged|GetStorageInfoPrivileged]]
|-
| 0x044E0080
| [[BOSSP:GetStorageEntryInfoPrivileged|GetStorageEntryInfoPrivileged]]
|-
| 0x044F0102
| [[BOSSP:UpdateTaskIntervalPrivileged|UpdateTaskIntervalPrivileged]]
|-
| 0x04500102
| [[BOSSP:UpdateTaskCountPrivileged|UpdateTaskCountPrivileged]]
|-
| 0x045100C2
| [[BOSSP:GetTaskIntervalPrivileged|GetTaskIntervalPrivileged]]
|-
| 0x045200C2
| [[BOSSP:GetTaskCountPrivileged|GetTaskCountPrivileged]]
|-
| 0x045300C2
| [[BOSSP:GetTaskServiceStatusPrivileged|GetTaskServiceStatusPrivileged]]
|-
| 0x04540102
| [[BOSSP:GetTaskStatePrivileged|GetTaskStatePrivileged]]
|-
| 0x045500C2
| [[BOSSP:GetTaskResultPrivileged|GetTaskResultPrivileged]]
|-
| 0x045600C2
| [[BOSSP:GetTaskCommErrorCodePrivileged|GetTaskCommErrorCodePrivileged]]
|-
| 0x04570142
| [[BOSSP:GetTaskStatusPrivileged|GetTaskStatusPrivileged]]
|-
| 0x04580104
| [[BOSSP:SetTaskQueryPrivileged|SetTaskQueryPrivileged]]
|}

boss:P also contains all of the commands from boss:U.

When Home Menu loads the SpotPass [[CBMD]] with [[Extended_Banner]], it uses bossP command 0x040D0182 first. Then it uses GetNsDataHeaderInfoPrivileged, then ReadNsDataPrivileged for loading the actual banner data.

==BOSS Service "boss:M"==

{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010002
| ?
|-
| 0x00020000
| ?
|-
| 0x00030040
| ?
|-
| 0x00040000
| ?
|-
| 0x00050000
| ?
|-
| 0x00060000
| ?
|-
| 0x00070000
| ?
|}

==programIDs==
BOSS uses programIDs raw without any handling for the New3DS programID-low bitmask. For example, attempting a NsDataId listing with the New3DS bitmask set will fail, if BOSS is only setup for that programID with the New3DS bitmask clear.

When [[BOSSU:InitializeSession|initializing]] BOSS with the default programID, the New3DS programID-low bitmask is always clear for New3DS titles since that's how it was originally registered with [[Filesystem_services|FS]]. Hence, the programID in the [[SpotPass|BOSS-container]] must always have the New3DS bitmask clear. This also means everything using the BOSSP commands with the raw programIDs loaded from AM title-listing are broken with New3DS titles, for example [[Extended_Banner]].

==Content Data Storage==
SpotPass content for each application is stored under the extdata specified by [[BOSS:SetStorageInfo]]. Certain commands verify that the PID associated with the current service session has access to the specified extdata by using [[FS:CheckAuthorityToAccessExtSaveData]], returning an error on failure. This basically renders SpotPass unusable under user-processes(when initialized under those processes) which don't have access to any SD extdata(unless NAND extdata is used instead).

All of these commands using [[FS:CheckAuthorityToAccessExtSaveData]] are: [[BOSS:SetStorageInfo]] and RegisterStorageEntry, for both BOSSU and BOSSP.

BOSS-container content is stored in the extdata registered for the programID specified in the BOSS-container, what task it's associated with / what title registered it is irrelevant with BOSS-container data storage.

==Custom SpotPass content==
SpotPass supports raw content download without using the encrypted+signed SpotPass container(raw content is used by [[Home Menu]] SpotPass VersionList for example). However, this is incompatible with the data-loading method used with SpotPass-container content(NsData commands can't be used with it).

When writing the raw content, it firsts deletes and creates the "<taskID>" file under the data-storage extdata with normal extdata(not the separate boss archive). Once successful, the final filename specified by the task config will be deleted if needed, then the "<taskID>" file will be renamed to the final filename. Afterwards, the user-process can access the final file just like any other extdata file.

For using custom content with the SpotPass container(like official titles), the only known ways to do so is: "CFW" / ARM11-kernelhax with the sigchecks for this patched, or some sort of BOSS-sysmodule exploit if there's any vulns to begin with.

==HTTP upload==
SpotPass tasks can be used for uploading data via HTTP POST. The exact method varies, but the main one is a [[HTTPC:SendPOSTDataRawTimeout|raw]] POST.

The content data is loaded from the following path: snprintf(outpath, outpathsize, "%s/%s%02x.up", archivepath, taskidstr_probably, unk);

The archivepath can be either "bossdb:"(BOSS-sysmodule NAND savedata) or the content-data-storage extdata. Certain other paths in the BOSS savedata can be used too.

==BOSS Tasks==
The TaskID is a 8-byte buffer containing a string including NUL-terminator(taskIDs are compared with: strncmp(str0, str1, 7)).

When disabling SpotPass, applications use [[BOSSU:CancelTask]] then [[BOSSU:UnregisterTask]], to delete each task.

Each process can only access tasks which it created, not other processes' tasks(even when using bossP with [[BOSSP:InitializeSessionPrivileged|init_programID]]=0).

After registration, tasks will not automatically run until they are started using one of the start-task commands.

==NsDataId==
This is an u32 ID for SpotPass content, used with the NsData service commands etc.

==NsDataHeaderInfo==
This type contains information about an NsData, the fields match exactly with the [[SpotPass#Payload_Content_Header|Payload Content Header]] without the hash and signature. When the input type is not one of the below or when the specified output size doesn't match the expected size for this type, an error is returned.

{| class="wikitable" border="1"
! Type !! Size !! Description
|-
| 0x0 || 0x8 || Program ID
|-
| 0x1 || 0x4 || Unknown field
|-
| 0x2 || 0x4 || Content datatype
|-
| 0x3 || 0x4 || Payload size
|-
| 0x4 || 0x4 || NS Data ID
|-
| 0x5 || 0x4 || Version
|-
| 0x6 || 0x20 || Everything:
{| class="wikitable" border="1"
! Offset !! Size !! Description
|-
| 0x0 || 0x8 || Program ID
|-
| 0x8 || 0x4 || Unknown field
|-
| 0xC || 0x4 || Content datatype
|-
| 0x10 || 0x4 || Payload size
|-
| 0x14 || 0x4 || NS Data ID
|-
| 0x18 || 0x4 || Version
|-
| 0x1C || 0x4 || Padding?
|}
|}

==PropertyIDs==
{| class="wikitable" border="1"
! ID !! Size !! Type !! Read !! Write !! Rewritable !! Description
|-
| 0x0 || 0x1 || u8 || Yes || Yes || Yes || [[#PriorityLevel|Priority]]. Represents the priority of a task
|-
| 0x1 || 0x1 || u8 || Yes || Yes || Yes || SchedulingPolicy. Unknown purpose, the API on games force this to 1
|-
| 0x2 || 0x4 || u32 || Yes || Yes || Yes || TaskTargetDuration. Unknown purpose, the API on games require a value below 0x10000 (not inclusive)
|-
| 0x3 || 0x4 || u32 || Yes || Yes || Yes || Interval in seconds of the task
|-
| 0x4 || 0x4 || u32 || Yes || Yes || Yes || Count. Number of times that the task will be run. If zero, the task is persistent
|-
| 0x5 || 0x1 || u8 || Yes || Yes || Yes || TaskPermission. Unknown purpose, the API on games require a value between 0 and 3
|-
| 0x6 || 0x1 || u8 || Yes || Yes || No || [[#ActionCode|ActionCode]]. Represents the action that a task will perform
|-
| 0x7 || 0x200 || char[512] || Yes || Yes || No || URL. Unused for DataStore actions
|-
| 0x8 || 0x4 || || Yes || Yes || No || ?
|-
| 0x9 || 0x1 || || Yes || Yes || No || Controls the action data type? The API on games require a value between 0 and 6
|-
| 0xA || 0x100 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xB and 0x3E
|-
| 0xB || 0x200 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xA and 0x3E
|-
| 0xC || 0x4 || Handle || Yes || Yes || No || Optional file handle with the data to send
|-
| 0xD || 0x360 || HeaderField[3] || Yes || Yes || No || HeaderFields. Additional headers to include in the request sent to the server. Structure:
{| class="wikitable" border="1"
|-
! Offset !! Size !! Description
|-
| 0x0 || 0x20 || char[32] Header name
|-
| 0x20 || 0x100 || char[256] Header value
|}
|-
| 0xE || 0x4 || u32[1] || Yes || Yes || No || ClientCerts. List of [[HTTPC:SetClientCertDefault|cert IDs]] to use as client certs
|-
| 0xF || 0xC || u32[3] || Yes || Yes || No || RootCAs. List of [[HTTPC:AddDefaultCert|cert IDs]] to use as root CAs
|-
| 0x10 || 0x1 || u8 || Yes || Yes || No || FSClientCert. If non-zero, enables the task client certificate to be read from the filesystem. May be a bool?
|-
| 0x11 || 0x1 || u8 || Yes || Yes || No || FSRootCA. If non-zero, enables the task root CA to be read from the filesystem. May be a bool?
|-
| 0x12 || 0x1 || u8 || Yes || Yes || No || [[#ApInfoType|ApInfoType]]
|-
| 0x13 || 0x4 || u32 || Yes || Yes || No || RootCaCount. Amount of root CAs stored in property 0xF
|-
| 0x14 || 0x4 || u32 || Yes || Yes || No || ClientCertCount. Amount of client certificates stored in property 0xE
|-
| 0x15 || 0x40 || || Yes || Yes || No || ?
|-
| 0x16 || 0x4 || || Yes || Yes || No || ?
|-
| 0x17 || || || No || No || No || Reserved
|-
| 0x18 || 0x1 || || Yes || Yes || No || Unknown purpose, the API on games force this to 1
|-
| 0x19 || 0x1 || || Yes || Yes || No || ?
|-
| 0x1A || 0x1 || || Yes || Yes || No || ?
|-
| 0x1B || 0x4 || || Yes || Yes || No || ?
|-
| 0x1C || 0x4 || || Yes || Yes || No || ?
|-
| 0x1D || 0x1 || u8 || Yes || No || No || [[#TaskStateCode|TaskStateCode]]. Unknown purpose
|-
| 0x1E || 0x1 || || Yes || No || No || ?
|-
| 0x1F || 0x1 || || Yes || No || No || ?
|-
| 0x20 || 0x1 || u8 || Yes || No || No || TaskResultCode. Unknown purpose
|-
| 0x21 || 0x1 || u8 || Yes || No || No || TaskServiceStatus. Unknown purpose
|-
| 0x22 || 0x1 || || Yes || No || No || ?
|-
| 0x23 || 0x4 || u32 || Yes || No || No || CommErrorCode. Unknown purpose
|-
| 0x24 || 0x1 || || Yes || No || No || ?
|-
| 0x25 || 0x4 || || Yes || No || No || ?
|-
| 0x26 || 0x4 || || Yes || No || No || ?
|-
| 0x27 || 0x4 || || Yes || No || No || ?
|-
| 0x28 || 0x8 || u64 || Yes || No || No || LastSuccessfulTimestamp. Number of seconds since the year 2000 of the last successful run of the task
|-
| 0x29 || 0x8 || || Yes || No || No || ?
|-
| 0x2A || 0x4 || || Yes || No || No || ?
|-
| 0x2B || 0x4 || || Yes || No || No || ?
|-
| 0x2C || 0x1 || || Yes || No || No || ?
|-
| 0x2D || 0x2 || || Yes || No || No || ?
|-
| 0x2E || 0x2 || || Yes || No || No || ?
|-
| 0x2F || 0x40 || char[64] || Yes || No || No || LastModifiedHeader. Date string from the Last-Modified HTTP header received when executing the task
|-
| 0x30 || 0x1 || || Yes || No || No || ?
|-
| 0x31 || 0x4 || || Yes || No || No || ?
|-
| 0x32 || 0x100 || || Yes || No || No || ?
|-
| 0x33 || 0x2 || u16 || Yes || No || No || TotalApps. Number of application IDs on the below list
|-
| 0x34 || 0x400 || u64[128] || Yes || No || No || AppIdList. List of application IDs registered in BOSS
|-
| 0x35 || 0x2 || u16 || Yes || No || No || TotalTasks. Number of task IDs on the below list
|-
| 0x36 || 0x400 || char[8][128] || Yes || No || No || TaskIdList. List of task IDs registered by the application
|-
| 0x37 || 0x2 || u16 || Yes || No || No || TotalSteps. Number of step IDs on the below list
|-
| 0x38 || 0x80 || u8[128] || Yes || No || No || StepIdList. List of steps that the task has registered
|-
| 0x39 || || || No || No || No || Reserved
|-
| 0x3A || || || No || No || No || Reserved
|-
| 0x3B || 0x4 || || Yes || Yes || No || ?
|-
| 0x3C || || || No || No || No || Reserved
|-
| 0x3D || || || No || No || No || Reserved
|-
| 0x3E || 0x200 || || Yes || Yes || No || DataStoreDownloadActionData. Shares buffer with properties 0xA and 0xB
|-
| 0x3F || 0x1 || u8 || Yes || Yes || No || [[#CfgInfoType|CfgInfoType]]
|}

The official name for this type is "PropertyType". The read column represents properties which can be obtained with [[BOSSU:ReceiveProperty|ReceiveProperty]], the write column represents properties which can be set with [[BOSSU:SendProperty|SendProperty]], and the rewritable column indicates properties which can be reassigned into an existing task with [[BOSSU:ReconfigureTask|ReconfigureTask]]. If the specified size for the command is larger than the property size, it will use the actual property size instead. When the specified size is less than the actual property size, all of the property data that won't be written to is cleared.

Trying to send a property which doesn't support being sent will give an error 0xC960F84D. Using reserved properties as an argument will give the same error.

==TaskStateCode==
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Last task run was successful?
|-
| 0x2
| Task started.
|-
| 0x5
| Task not started(also the initial state immediately after task creation).
|-
| 0x6
| Unknown
|-
| 0x7
| Task processing failed(such as network error).
|}

This u8 is returned by [[BOSSU:GetTaskState]].

==PriorityLevel==
{| class="wikitable" border="1"
! Value !! Name !! Description
|-
| 0x0 || INVALID? || Probably represents an invalid value
|-
| 0x15 || EXPEDITE1 ||
|-
| 0x16 || EXPEDITE2 ||
|-
| 0x17 || EXPEDITE3 ||
|-
| 0x18 || EXPEDITE4 ||
|-
| 0x19 || EXPEDITE5 ||
|-
| 0x1A || EXPEDITE6 ||
|-
| 0x1B || EXPEDITE7 ||
|-
| 0x1C || EXPEDITE8 ||
|-
| 0x23 || EXPEDITE ||
|-
| 0x50 || HIGH ||
|-
| 0x7D || MEDIUM || This is the default value inside the games API
|-
| 0xAA || LOW ||
|-
| 0xD7 || LOWEST ||
|-
| 0xDD || LOWEST1 ||
|-
| 0xDE || LOWEST2 ||
|-
| 0xDF || LOWEST3 ||
|-
| 0xE0 || LOWEST4 ||
|-
| 0xE1 || LOWEST5 ||
|-
| 0xE2 || LOWEST6 ||
|-
| 0xE3 || LOWEST7 ||
|-
| 0xE4 || LOWEST8 ||
|-
| 0xFF || STOPPED || The task won't be run
|}

Represents the priority of a task. Any values outside the ones listed above are considered invalid.

==ActionCode==
{| class="wikitable" border="1"
! Value !! Description
|-
| 0x1 || FileList? Action code used for listing files on the BOSS server. May be a generic raw download?
|-
| 0x2 || NsaDownload? Action code for downloading data from the given URL, principally an NsData
|-
| 0x3 || Upload? Action code for uploading data to the given URL
|-
| 0x4 || ?
|-
| 0x5 || ?
|-
| 0x6 || Action code used by task ID "pl" from the Home Menu
|-
| 0x7 || Action code used by task ID "phu" from the Home Menu
|-
| 0x8 || Action code used by task ID "tiu" from the Home Menu
|-
| 0x9 || Action code used by task ID "splu" from the Home Menu
|-
| 0xA || Action code used for downloading data from DataStore through an Hpp server. Stores notification data?
|-
| 0xB || Action code related to DataStore?
|-
| 0xC || Action code used for StreetPass Relay
|-
| 0xD || Action code used for downloading the title version list (versionList.dat)
|}

This represents the action that a task will perform.

==ApInfoType==
{| class="wikitable" border="1"
! Flag !! Description
|-
| 0x1 || Adds the "apgroup" parameter to the query
|-
| 0x2 || Adds the "aparea" parameter to the query
|-
| 0x4 || Adds the "ap" parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the access point the console is connected to.

==CfgInfoType==
{| class="wikitable sortable"
! Flag !! Description
|-
| 0x1 || Adds the "c" (two-letter country code) parameter to the query
|-
| 0x2 || Adds the "l" (two-letter language code) parameter to the query
|-
| 0x4 || Adds the "tm" ([[Cfg:GetSystemModel|target model]]) parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the console configuration.

==Errors==
{| class="wikitable" border="1"
|-
! Error-code
! Description
|-
| 0xC8A0F833
| taskID not found.
|-
| 0xC8A0F836
| taskID already exists, for task creation.
|-
| 0xC8A0F842
| The specified programID is not setup for BOSS.
|-
| 0xC8A0F843
| The specified NsDataId was not found.
|}

[[Category:Services]]

BOSS Services

2025-08-21T11:34:52Z

DaniElectra: /* CfgInfoType */ Format update

==BOSS User Service "boss:U"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010082
| [[BOSSU:InitializeSession|InitializeSession]]
|-
| 0x00020100
| [[BOSSU:SetStorageInfo|SetStorageInfo]]
|-
| 0x00030000
| [[BOSSU:UnregisterStorage|UnregisterStorage]]
|-
| 0x00040000
| [[BOSSU:GetStorageInfo|GetStorageInfo]]
|-
| 0x00050042
| [[BOSSU:RegisterPrivateRootCa|RegisterPrivateRootCa]]
|-
| 0x00060084
| [[BOSSU:RegisterPrivateClientCert|RegisterPrivateClientCert]] <nowiki>(u32 Size0, u32 Size1, ((Size0<<4) | 10), Buf0, ((Size1<<4) | 10), Buf1)</nowiki> This writes the content of the input buffers into files "bossdb:/%s_CL" and "bossdb:/%s_CLK", where "%s" is generated from the programID.
|-
| 0x00070000
| [[BOSSU:GetNewArrivalFlag|GetNewArrivalFlag]]
|-
| 0x00080002
| [[BOSSU:RegisterNewArrivalEvent|RegisterNewArrivalEvent]]: Used for sending a handle. This is used with a table of programIDs etc with a maximum of 5 entries.
|-
| 0x00090040
| [[BOSSU:SetOptoutFlag|SetOptoutFlag]]
|-
| 0x000A0000
| [[BOSSU:GetOptoutFlag|GetOptoutFlag]]
|-
| 0x000B00C2
| [[BOSSU:RegisterTask|RegisterTask]]
|-
| 0x000C0082
| [[BOSSU:UnregisterTask|UnregisterTask]]
|-
| 0x000D0082
| [[BOSSU:ReconfigureTask|ReconfigureTask]]
|-
| 0x000E0000
| [[BOSSU:GetTaskIdList|GetTaskIdList]]
|-
| 0x000F0042
| [[BOSSU:GetStepIdList|GetStepIdList]]
|-
| 0x00100102
| [[BOSSU:GetNsDataIdList|GetNsDataIdList]]
|-
| 0x00110102
| [[BOSSU:GetNsDataIdList1|GetNsDataIdList1]]
|-
| 0x00120102
| [[BOSSU:GetNsDataIdList2|GetNsDataIdList2]]
|-
| 0x00130102
| [[BOSSU:GetNsDataIdList3|GetNsDataIdList3]]
|-
| 0x00140082
| [[BOSSU:SendProperty|SendProperty]]
|-
| 0x00150042
| [[BOSSU:SendPropertyHandle|SendPropertyHandle]]
|-
| 0x00160082
| [[BOSSU:ReceiveProperty|ReceiveProperty]]
|-
| 0x00170082
| [[BOSSU:UpdateTaskInterval|UpdateTaskInterval]]
|-
| 0x00180082
| [[BOSSU:UpdateTaskCount|UpdateTaskCount]]
|-
| 0x00190042
| [[BOSSU:GetTaskInterval|GetTaskInterval]]
|-
| 0x001A0042
| [[BOSSU:GetTaskCount|GetTaskCount]]
|-
| 0x001B0042
| [[BOSSU:GetTaskServiceStatus|GetTaskServiceStatus]]
|-
| 0x001C0042
| [[BOSSU:StartTask|StartTask]]
|-
| 0x001D0042
| [[BOSSU:StartTaskImmediate|StartTaskImmediate]]
|-
| 0x001E0042
| [[BOSSU:CancelTask|CancelTask]]
|-
| 0x001F0000
| [[BOSSU:GetTaskFinishHandle|GetTaskFinishHandle]]
|-
| 0x00200082
| [[BOSSU:GetTaskState|GetTaskState]]
|-
| 0x00210042
| [[BOSSU:GetTaskResult|GetTaskResult]]
|-
| 0x00220042
| [[BOSSU:GetTaskCommErrorCode|GetTaskCommErrorCode]]
|-
| 0x002300C2
| [[BOSSU:GetTaskStatus|GetTaskStatus]]
|-
| 0x00240082
| [[BOSSU:GetTaskError|GetTaskError]]
|-
| 0x00250082
| [[BOSSU:GetTaskInfo|GetTaskInfo]]
|-
| 0x00260040
| [[BOSSU:DeleteNsData|DeleteNsData]]
|-
| 0x002700C2
| [[BOSSU:GetNsDataHeaderInfo|GetNsDataHeaderInfo]]
|-
| 0x00280102
| [[BOSSU:ReadNsData|ReadNsData]]
|-
| 0x00290080
| [[BOSSU:SetNsDataAdditionalInfo|SetNsDataAdditionalInfo]]
|-
| 0x002A0040
| [[BOSSU:GetNsDataAdditionalInfo|GetNsDataAdditionalInfo]]. Writes an output u32 to cmdreply[2].
|-
| 0x002B0080
| [[BOSSU:SetNsDataNewFlag|SetNsDataNewFlag]]
|-
| 0x002C0040
| [[BOSSU:GetNsDataNewFlag|GetNsDataNewFlag]]
|-
| 0x002D0040
| [[BOSSU:GetNsDataLastUpdate|GetNsDataLastUpdate]] (u32 NsDataId) Writes an output u64 to cmdreply[2-3], from the content file in extdata.
|-
| 0x002E0040
| [[BOSSU:GetErrorCode|GetErrorCode]]
|-
| 0x002F0140
| [[BOSSU:RegisterStorageEntry|RegisterStorageEntry]]
|-
| 0x00300000
| [[BOSSU:GetStorageEntryInfo|GetStorageEntryInfo]]
|-
| 0x00310100
| [[BOSSU:SetStorageOption|SetStorageOption]]
|-
| 0x00320000
| [[BOSSU:GetStorageOption|GetStorageOption]]
|-
| 0x00330042
| [[BOSSU:StartBgImmediate|StartBgImmediate]]
|-
| 0x00340042
| [[BOSSU:GetTaskPriority|GetTaskPriority]]
|-
| 0x003500C2
| [[BOSSU:RegisterImmediateTask|RegisterImmediateTask]]
|-
| 0x00360084
| [[BOSSU:SetTaskQuery|SetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|-
| 0x00370084
| [[BOSSU:GetTaskQuery|GetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|}

==BOSS Privileged Service "boss:P"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x04010082
| [[BOSSP:InitializeSessionPrivileged|InitializeSessionPrivileged]]
|-
| 0x04020000
| ?
|-
| 0x04030000
| ?
|-
| 0x04040080
| [[BOSSP:GetAppNewFlag|GetAppNewFlag]]
|-
| 0x040500C0
| [[BOSSP:SetAppNewFlag|SetAppNewFlag]]
|-
| 0x040600C0
| [[BOSSP:SetOptoutFlagPrivileged|SetOptoutFlagPrivileged]]
|-
| 0x04070080
| [[BOSSP:GetOptoutFlagPrivileged|GetOptoutFlagPrivileged]]
|-
| 0x04080040
| (u8 optout) Sets the optout flag to all apps?
|-
| 0x04090102
| [[BOSSP:UnregisterTaskPrivileged|UnregisterTaskPrivileged]]
|-
| 0x040A0000
| [[BOSSP:GetAppIdList|GetAppIdList]]
|-
| 0x040B0080
| [[BOSSP:GetTaskIdListPrivileged|GetTaskIdListPrivileged]]
|-
| 0x040C00C2
| [[BOSSP:GetStepIdListPrivileged|GetStepIdListPrivileged]]
|-
| 0x040D0182
| [[BOSSP:GetNsDataIdListPrivileged|GetNsDataIdListPrivileged]]
|-
| 0x040E0182
| [[BOSSP:GetNsDataIdListPrivileged1|GetNsDataIdListPrivileged1]]
|-
| 0x040F0102
| [[BOSSP:GetTaskInfoPrivileged|GetTaskInfoPrivileged]]
|-
| 0x04100102
| [[BOSSP:GetTaskStatusPrivileged1|GetTaskStatusPrivileged1]] Same as GetTaskStatusPrivileged, but the input bool is set to false
|-
| 0x04110102
| [[BOSSP:GetTaskErrorPrivileged|GetTaskErrorPrivileged]]
|-
| 0x04120000
| Related to the sysmodule savedata?
|-
| 0x04130082
| [[BOSSP:SendPropertyPrivileged|SendPropertyPrivileged]]
|-
| 0x04140082
| [[BOSSP:ReceivePropertyPrivileged|ReceivePropertyPrivileged]]
|-
| 0x041500C0
| [[BOSSP:DeleteNsDataPrivileged|DeleteNsDataPrivileged]]
|-
| 0x04160142
| [[BOSSP:GetNsDataHeaderInfoPrivileged|GetNsDataHeaderInfoPrivileged]]
|-
| 0x04170182
| [[BOSSP:ReadNsDataPrivileged|ReadNsDataPrivileged]]
|-
| 0x04180100
| [[BOSSP:SetNsDataAdditionalInfoPrivileged|SetNsDataAdditionalInfoPrivileged]]
|-
| 0x041900C0
| [[BOSSP:GetNsDataAdditionalInfoPrivileged|GetNsDataAdditionalInfoPrivileged]]
|-
| 0x041A0100
| [[BOSSP:SetNsDataNewFlagPrivileged|SetNsDataNewFlagPrivileged]]
|-
| 0x041B00C0
| [[BOSSP:GetNsDataNewFlagPrivileged|GetNsDataNewFlagPrivileged]]
|-
| 0x041C00C0
| [[BOSSP:GetNsDataLastUpdatePrivileged|GetNsDataLastUpdatePrivileged]]
|-
| 0x041D0040
| (bool unk_flag1)
|-
| 0x041E0000
| Returns: bool unk_flag1
|-
| 0x041F0040
| [[BOSSP:SetTestModeAvailability|SetTestModeAvailability]] (bool test_mode_flag)
|-
| 0x04200000
| [[BOSSP:GetTestModeAvailability|GetTestModeAvailability]]. Returns: bool test_mode_flag
|-
| 0x04210000?
| Stubbed
|-
| 0x04220000
| ?
|-
| 0x04230000?
| Stubbed
|-
| 0x04240000
| ?
|-
| 0x04250042
| [[BOSSP:SetPolicyListEnvId|SetPolicyListEnvId]]. Sets the policylist env ID (default env ID is "p01"): strncpy("p01", in, 8)
|-
| 0x04260042
| [[BOSSP:GetPolicyListEnvId|GetPolicyListEnvId]]. Gets the policylist env ID (default env ID is "p01"): strcpy(out, "p01")
|-
| 0x04270042
| [[BOSSP:SetPolicyListUrl|SetPolicyListUrl]]. Sets a custom policylist URL. Max of 0x200 chars
|-
| 0x04280042
| [[BOSSP:GetPolicyListUrl|GetPolicyListUrl]]. Gets the custom policylist URL
|-
| 0x04290002
| (Handle unk)
|-
| 0x042A0000
| Closes the previous handle
|-
| 0x042B0000
| Returns: u8 unk
|-
| 0x042C0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>
|-
| 0x042D0000
| Returns: u32 unk
|-
| 0x042E00C2
| [[BOSSP:StartTaskPrivileged|StartTaskPrivileged]]
|-
| 0x042F00C2
| [[BOSSP:StartTaskImmediatePrivileged|StartTaskImmediatePrivileged]]
|-
| 0x043000C2
| [[BOSSP:CancelTaskPrivileged|CancelTaskPrivileged]]
|-
| 0x04310040
| (u32 unk_4) The input is stored in a variable whose default value is 0x70
|-
| 0x04320040
| Returns: u32 unk_4
|-
| 0x04330080
| [[BOSSP:GetStorageOptionPrivileged|GetStorageOptionPrivileged]]
|-
| 0x043400C2
| [[BOSSP:StartBgImmediatePrivileged|StartBgImmediatePrivileged]]
|-
| 0x04350042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x04360042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043700C2
| [[BOSSP:GetTaskPriorityPrivileged|GetTaskPriorityPrivileged]]
|-
| 0x04380000
| ?
|-
| 0x04390104
| [[BOSSP:GetTaskQueryPrivileged|GetTaskQueryPrivileged]]
|-
| 0x043A0042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x043B0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043C0080
| (u64 title_id)
|-
| 0x043D0080
| (u64 title_id)
|-
| 0x043E0042
| [[BOSSP:SetSprelayUrl|SetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Sets the sprelay URL
|-
| 0x043F0042
| [[BOSSP:GetSprelayUrl|GetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Gets the sprelay URL
|-
| 0x04400080
| [[BOSSP:SetSprelayInterval|SetSprelayInterval]] (u32 interval, u32 unk). Sets the sprelay interval, and other things
|-
| 0x04410000
| [[BOSSP:GetSprelayInterval|GetSprelayInterval]] Returns: u32 interval, u32 unk. Gets the sprelay interval, and other things
|-
| 0x04420000
| ?
|-
| 0x04430042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x208
|-
| 0x04440042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x130
|-
| 0x04450040
| (u8 unk_5)
|-
| 0x04460000
| Returns: u8 unk_5
|-
| 0x04470002
| [[BOSSP:RegisterNewArrivalEventPrivileged|RegisterNewArrivalEventPrivileged]]
|-
| 0x04480000?
| Stubbed
|-
| 0x04490142
| [[BOSSP:RegisterTaskPrivileged|RegisterTaskPrivileged]]
|-
| 0x044A0180
| [[BOSSP:SetStorageInfoPrivileged|SetStorageInfoPrivileged]]
|-
| 0x044B01C0
| [[BOSSP:RegisterStorageEntryPrivileged|RegisterStorageEntryPrivileged]]
|-
| 0x044C0080
| [[BOSSP:UnregisterStoragePrivileged|UnregisterStoragePrivileged]]
|-
| 0x044D0080
| [[BOSSP:GetStorageInfoPrivileged|GetStorageInfoPrivileged]]
|-
| 0x044E0080
| [[BOSSP:GetStorageEntryInfoPrivileged|GetStorageEntryInfoPrivileged]]
|-
| 0x044F0102
| [[BOSSP:UpdateTaskIntervalPrivileged|UpdateTaskIntervalPrivileged]]
|-
| 0x04500102
| [[BOSSP:UpdateTaskCountPrivileged|UpdateTaskCountPrivileged]]
|-
| 0x045100C2
| [[BOSSP:GetTaskIntervalPrivileged|GetTaskIntervalPrivileged]]
|-
| 0x045200C2
| [[BOSSP:GetTaskCountPrivileged|GetTaskCountPrivileged]]
|-
| 0x045300C2
| [[BOSSP:GetTaskServiceStatusPrivileged|GetTaskServiceStatusPrivileged]]
|-
| 0x04540102
| [[BOSSP:GetTaskStatePrivileged|GetTaskStatePrivileged]]
|-
| 0x045500C2
| [[BOSSP:GetTaskResultPrivileged|GetTaskResultPrivileged]]
|-
| 0x045600C2
| [[BOSSP:GetTaskCommErrorCodePrivileged|GetTaskCommErrorCodePrivileged]]
|-
| 0x04570142
| [[BOSSP:GetTaskStatusPrivileged|GetTaskStatusPrivileged]]
|-
| 0x04580104
| [[BOSSP:SetTaskQueryPrivileged|SetTaskQueryPrivileged]]
|}

boss:P also contains all of the commands from boss:U.

When Home Menu loads the SpotPass [[CBMD]] with [[Extended_Banner]], it uses bossP command 0x040D0182 first. Then it uses GetNsDataHeaderInfoPrivileged, then ReadNsDataPrivileged for loading the actual banner data.

==BOSS Service "boss:M"==

{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010002
| ?
|-
| 0x00020000
| ?
|-
| 0x00030040
| ?
|-
| 0x00040000
| ?
|-
| 0x00050000
| ?
|-
| 0x00060000
| ?
|-
| 0x00070000
| ?
|}

==programIDs==
BOSS uses programIDs raw without any handling for the New3DS programID-low bitmask. For example, attempting a NsDataId listing with the New3DS bitmask set will fail, if BOSS is only setup for that programID with the New3DS bitmask clear.

When [[BOSSU:InitializeSession|initializing]] BOSS with the default programID, the New3DS programID-low bitmask is always clear for New3DS titles since that's how it was originally registered with [[Filesystem_services|FS]]. Hence, the programID in the [[SpotPass|BOSS-container]] must always have the New3DS bitmask clear. This also means everything using the BOSSP commands with the raw programIDs loaded from AM title-listing are broken with New3DS titles, for example [[Extended_Banner]].

==Content Data Storage==
SpotPass content for each application is stored under the extdata specified by [[BOSS:SetStorageInfo]]. Certain commands verify that the PID associated with the current service session has access to the specified extdata by using [[FS:CheckAuthorityToAccessExtSaveData]], returning an error on failure. This basically renders SpotPass unusable under user-processes(when initialized under those processes) which don't have access to any SD extdata(unless NAND extdata is used instead).

All of these commands using [[FS:CheckAuthorityToAccessExtSaveData]] are: [[BOSS:SetStorageInfo]] and RegisterStorageEntry, for both BOSSU and BOSSP.

BOSS-container content is stored in the extdata registered for the programID specified in the BOSS-container, what task it's associated with / what title registered it is irrelevant with BOSS-container data storage.

==Custom SpotPass content==
SpotPass supports raw content download without using the encrypted+signed SpotPass container(raw content is used by [[Home Menu]] SpotPass VersionList for example). However, this is incompatible with the data-loading method used with SpotPass-container content(NsData commands can't be used with it).

When writing the raw content, it firsts deletes and creates the "<taskID>" file under the data-storage extdata with normal extdata(not the separate boss archive). Once successful, the final filename specified by the task config will be deleted if needed, then the "<taskID>" file will be renamed to the final filename. Afterwards, the user-process can access the final file just like any other extdata file.

For using custom content with the SpotPass container(like official titles), the only known ways to do so is: "CFW" / ARM11-kernelhax with the sigchecks for this patched, or some sort of BOSS-sysmodule exploit if there's any vulns to begin with.

==HTTP upload==
SpotPass tasks can be used for uploading data via HTTP POST. The exact method varies, but the main one is a [[HTTPC:SendPOSTDataRawTimeout|raw]] POST.

The content data is loaded from the following path: snprintf(outpath, outpathsize, "%s/%s%02x.up", archivepath, taskidstr_probably, unk);

The archivepath can be either "bossdb:"(BOSS-sysmodule NAND savedata) or the content-data-storage extdata. Certain other paths in the BOSS savedata can be used too.

==BOSS Tasks==
The TaskID is a 8-byte buffer containing a string including NUL-terminator(taskIDs are compared with: strncmp(str0, str1, 7)).

When disabling SpotPass, applications use [[BOSSU:CancelTask]] then [[BOSSU:UnregisterTask]], to delete each task.

Each process can only access tasks which it created, not other processes' tasks(even when using bossP with [[BOSSP:InitializeSessionPrivileged|init_programID]]=0).

After registration, tasks will not automatically run until they are started using one of the start-task commands.

==NsDataId==
This is an u32 ID for SpotPass content, used with the NsData service commands etc.

==NsDataHeaderInfo==
When the input type is not one of the below or when the specified output size doesn't match the expected size for this type, an error is returned.

===Type0===
Total size is 0x8-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| programID
|}

===Type1===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ?
|}

===Type2===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Content data-type, originally from the [[SpotPass|BOSS-container]].
|}

===Type3===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Content size
|}

===Type4===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ?
|}

===Type5===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ?
|}

===Type6===
Total size is 0x20-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| programID. Same data as Type0.
|-
| 0x8
| 0x4
| Same data as Type1.
|-
| 0xC
| 0x4
| ?
|-
| 0x10
| 0x4
| Same data as Type3.
|-
| 0x14
| 0xC
| ?
|}

==PropertyIDs==
{| class="wikitable" border="1"
! ID !! Size !! Type !! Read !! Write !! Rewritable !! Description
|-
| 0x0 || 0x1 || u8 || Yes || Yes || Yes || [[#PriorityLevel|Priority]]. Represents the priority of a task
|-
| 0x1 || 0x1 || u8 || Yes || Yes || Yes || SchedulingPolicy. Unknown purpose, the API on games force this to 1
|-
| 0x2 || 0x4 || u32 || Yes || Yes || Yes || TaskTargetDuration. Unknown purpose, the API on games require a value below 0x10000 (not inclusive)
|-
| 0x3 || 0x4 || u32 || Yes || Yes || Yes || Interval in seconds of the task
|-
| 0x4 || 0x4 || u32 || Yes || Yes || Yes || Count. Number of times that the task will be run. If zero, the task is persistent
|-
| 0x5 || 0x1 || u8 || Yes || Yes || Yes || TaskPermission. Unknown purpose, the API on games require a value between 0 and 3
|-
| 0x6 || 0x1 || u8 || Yes || Yes || No || [[#ActionCode|ActionCode]]. Represents the action that a task will perform
|-
| 0x7 || 0x200 || char[512] || Yes || Yes || No || URL. Unused for DataStore actions
|-
| 0x8 || 0x4 || || Yes || Yes || No || ?
|-
| 0x9 || 0x1 || || Yes || Yes || No || Controls the action data type? The API on games require a value between 0 and 6
|-
| 0xA || 0x100 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xB and 0x3E
|-
| 0xB || 0x200 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xA and 0x3E
|-
| 0xC || 0x4 || Handle || Yes || Yes || No || Optional file handle with the data to send
|-
| 0xD || 0x360 || HeaderField[3] || Yes || Yes || No || HeaderFields. Additional headers to include in the request sent to the server. Structure:
{| class="wikitable" border="1"
|-
! Offset !! Size !! Description
|-
| 0x0 || 0x20 || char[32] Header name
|-
| 0x20 || 0x100 || char[256] Header value
|}
|-
| 0xE || 0x4 || u32[1] || Yes || Yes || No || ClientCerts. List of [[HTTPC:SetClientCertDefault|cert IDs]] to use as client certs
|-
| 0xF || 0xC || u32[3] || Yes || Yes || No || RootCAs. List of [[HTTPC:AddDefaultCert|cert IDs]] to use as root CAs
|-
| 0x10 || 0x1 || u8 || Yes || Yes || No || FSClientCert. If non-zero, enables the task client certificate to be read from the filesystem. May be a bool?
|-
| 0x11 || 0x1 || u8 || Yes || Yes || No || FSRootCA. If non-zero, enables the task root CA to be read from the filesystem. May be a bool?
|-
| 0x12 || 0x1 || u8 || Yes || Yes || No || [[#ApInfoType|ApInfoType]]
|-
| 0x13 || 0x4 || u32 || Yes || Yes || No || RootCaCount. Amount of root CAs stored in property 0xF
|-
| 0x14 || 0x4 || u32 || Yes || Yes || No || ClientCertCount. Amount of client certificates stored in property 0xE
|-
| 0x15 || 0x40 || || Yes || Yes || No || ?
|-
| 0x16 || 0x4 || || Yes || Yes || No || ?
|-
| 0x17 || || || No || No || No || Reserved
|-
| 0x18 || 0x1 || || Yes || Yes || No || Unknown purpose, the API on games force this to 1
|-
| 0x19 || 0x1 || || Yes || Yes || No || ?
|-
| 0x1A || 0x1 || || Yes || Yes || No || ?
|-
| 0x1B || 0x4 || || Yes || Yes || No || ?
|-
| 0x1C || 0x4 || || Yes || Yes || No || ?
|-
| 0x1D || 0x1 || u8 || Yes || No || No || [[#TaskStateCode|TaskStateCode]]. Unknown purpose
|-
| 0x1E || 0x1 || || Yes || No || No || ?
|-
| 0x1F || 0x1 || || Yes || No || No || ?
|-
| 0x20 || 0x1 || u8 || Yes || No || No || TaskResultCode. Unknown purpose
|-
| 0x21 || 0x1 || u8 || Yes || No || No || TaskServiceStatus. Unknown purpose
|-
| 0x22 || 0x1 || || Yes || No || No || ?
|-
| 0x23 || 0x4 || u32 || Yes || No || No || CommErrorCode. Unknown purpose
|-
| 0x24 || 0x1 || || Yes || No || No || ?
|-
| 0x25 || 0x4 || || Yes || No || No || ?
|-
| 0x26 || 0x4 || || Yes || No || No || ?
|-
| 0x27 || 0x4 || || Yes || No || No || ?
|-
| 0x28 || 0x8 || u64 || Yes || No || No || LastSuccessfulTimestamp. Number of seconds since the year 2000 of the last successful run of the task
|-
| 0x29 || 0x8 || || Yes || No || No || ?
|-
| 0x2A || 0x4 || || Yes || No || No || ?
|-
| 0x2B || 0x4 || || Yes || No || No || ?
|-
| 0x2C || 0x1 || || Yes || No || No || ?
|-
| 0x2D || 0x2 || || Yes || No || No || ?
|-
| 0x2E || 0x2 || || Yes || No || No || ?
|-
| 0x2F || 0x40 || char[64] || Yes || No || No || LastModifiedHeader. Date string from the Last-Modified HTTP header received when executing the task
|-
| 0x30 || 0x1 || || Yes || No || No || ?
|-
| 0x31 || 0x4 || || Yes || No || No || ?
|-
| 0x32 || 0x100 || || Yes || No || No || ?
|-
| 0x33 || 0x2 || u16 || Yes || No || No || TotalApps. Number of application IDs on the below list
|-
| 0x34 || 0x400 || u64[128] || Yes || No || No || AppIdList. List of application IDs registered in BOSS
|-
| 0x35 || 0x2 || u16 || Yes || No || No || TotalTasks. Number of task IDs on the below list
|-
| 0x36 || 0x400 || char[8][128] || Yes || No || No || TaskIdList. List of task IDs registered by the application
|-
| 0x37 || 0x2 || u16 || Yes || No || No || TotalSteps. Number of step IDs on the below list
|-
| 0x38 || 0x80 || u8[128] || Yes || No || No || StepIdList. List of steps that the task has registered
|-
| 0x39 || || || No || No || No || Reserved
|-
| 0x3A || || || No || No || No || Reserved
|-
| 0x3B || 0x4 || || Yes || Yes || No || ?
|-
| 0x3C || || || No || No || No || Reserved
|-
| 0x3D || || || No || No || No || Reserved
|-
| 0x3E || 0x200 || || Yes || Yes || No || DataStoreDownloadActionData. Shares buffer with properties 0xA and 0xB
|-
| 0x3F || 0x1 || u8 || Yes || Yes || No || [[#CfgInfoType|CfgInfoType]]
|}

The official name for this type is "PropertyType". The read column represents properties which can be obtained with [[BOSSU:ReceiveProperty|ReceiveProperty]], the write column represents properties which can be set with [[BOSSU:SendProperty|SendProperty]], and the rewritable column indicates properties which can be reassigned into an existing task with [[BOSSU:ReconfigureTask|ReconfigureTask]]. If the specified size for the command is larger than the property size, it will use the actual property size instead. When the specified size is less than the actual property size, all of the property data that won't be written to is cleared.

Trying to send a property which doesn't support being sent will give an error 0xC960F84D. Using reserved properties as an argument will give the same error.

==TaskStateCode==
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Last task run was successful?
|-
| 0x2
| Task started.
|-
| 0x5
| Task not started(also the initial state immediately after task creation).
|-
| 0x6
| Unknown
|-
| 0x7
| Task processing failed(such as network error).
|}

This u8 is returned by [[BOSSU:GetTaskState]].

==PriorityLevel==
{| class="wikitable" border="1"
! Value !! Name !! Description
|-
| 0x0 || INVALID? || Probably represents an invalid value
|-
| 0x15 || EXPEDITE1 ||
|-
| 0x16 || EXPEDITE2 ||
|-
| 0x17 || EXPEDITE3 ||
|-
| 0x18 || EXPEDITE4 ||
|-
| 0x19 || EXPEDITE5 ||
|-
| 0x1A || EXPEDITE6 ||
|-
| 0x1B || EXPEDITE7 ||
|-
| 0x1C || EXPEDITE8 ||
|-
| 0x23 || EXPEDITE ||
|-
| 0x50 || HIGH ||
|-
| 0x7D || MEDIUM || This is the default value inside the games API
|-
| 0xAA || LOW ||
|-
| 0xD7 || LOWEST ||
|-
| 0xDD || LOWEST1 ||
|-
| 0xDE || LOWEST2 ||
|-
| 0xDF || LOWEST3 ||
|-
| 0xE0 || LOWEST4 ||
|-
| 0xE1 || LOWEST5 ||
|-
| 0xE2 || LOWEST6 ||
|-
| 0xE3 || LOWEST7 ||
|-
| 0xE4 || LOWEST8 ||
|-
| 0xFF || STOPPED || The task won't be run
|}

Represents the priority of a task. Any values outside the ones listed above are considered invalid.

==ActionCode==
{| class="wikitable" border="1"
! Value !! Description
|-
| 0x1 || FileList? Action code used for listing files on the BOSS server. May be a generic raw download?
|-
| 0x2 || NsaDownload? Action code for downloading data from the given URL, principally an NsData
|-
| 0x3 || Upload? Action code for uploading data to the given URL
|-
| 0x4 || ?
|-
| 0x5 || ?
|-
| 0x6 || Action code used by task ID "pl" from the Home Menu
|-
| 0x7 || Action code used by task ID "phu" from the Home Menu
|-
| 0x8 || Action code used by task ID "tiu" from the Home Menu
|-
| 0x9 || Action code used by task ID "splu" from the Home Menu
|-
| 0xA || Action code used for downloading data from DataStore through an Hpp server. Stores notification data?
|-
| 0xB || Action code related to DataStore?
|-
| 0xC || Action code used for StreetPass Relay
|-
| 0xD || Action code used for downloading the title version list (versionList.dat)
|}

This represents the action that a task will perform.

==ApInfoType==
{| class="wikitable" border="1"
! Flag !! Description
|-
| 0x1 || Adds the "apgroup" parameter to the query
|-
| 0x2 || Adds the "aparea" parameter to the query
|-
| 0x4 || Adds the "ap" parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the access point the console is connected to.

==CfgInfoType==
{| class="wikitable sortable"
! Flag !! Description
|-
| 0x1 || Adds the "c" (two-letter country code) parameter to the query
|-
| 0x2 || Adds the "l" (two-letter language code) parameter to the query
|-
| 0x4 || Adds the "tm" ([[Cfg:GetSystemModel|target model]]) parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the console configuration.

==Errors==
{| class="wikitable" border="1"
|-
! Error-code
! Description
|-
| 0xC8A0F833
| taskID not found.
|-
| 0xC8A0F836
| taskID already exists, for task creation.
|-
| 0xC8A0F842
| The specified programID is not setup for BOSS.
|-
| 0xC8A0F843
| The specified NsDataId was not found.
|}

[[Category:Services]]

BOSSU:GetTaskState

2025-08-21T11:33:52Z

DaniElectra: Update link

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0020|2|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|bool, Unknown}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0020|4|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u8, [[BOSS_Services#TaskStateCode|TaskStateCode]]}}
{{IPC/RequestEntry|u32, Count}}
{{IPC/RequestEntry|u8, Current step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Gets the state of the given task on the program ID of the current session.

BOSS Services

2025-08-21T11:07:40Z

DaniElectra: Add details about some properties

==BOSS User Service "boss:U"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010082
| [[BOSSU:InitializeSession|InitializeSession]]
|-
| 0x00020100
| [[BOSSU:SetStorageInfo|SetStorageInfo]]
|-
| 0x00030000
| [[BOSSU:UnregisterStorage|UnregisterStorage]]
|-
| 0x00040000
| [[BOSSU:GetStorageInfo|GetStorageInfo]]
|-
| 0x00050042
| [[BOSSU:RegisterPrivateRootCa|RegisterPrivateRootCa]]
|-
| 0x00060084
| [[BOSSU:RegisterPrivateClientCert|RegisterPrivateClientCert]] <nowiki>(u32 Size0, u32 Size1, ((Size0<<4) | 10), Buf0, ((Size1<<4) | 10), Buf1)</nowiki> This writes the content of the input buffers into files "bossdb:/%s_CL" and "bossdb:/%s_CLK", where "%s" is generated from the programID.
|-
| 0x00070000
| [[BOSSU:GetNewArrivalFlag|GetNewArrivalFlag]]
|-
| 0x00080002
| [[BOSSU:RegisterNewArrivalEvent|RegisterNewArrivalEvent]]: Used for sending a handle. This is used with a table of programIDs etc with a maximum of 5 entries.
|-
| 0x00090040
| [[BOSSU:SetOptoutFlag|SetOptoutFlag]]
|-
| 0x000A0000
| [[BOSSU:GetOptoutFlag|GetOptoutFlag]]
|-
| 0x000B00C2
| [[BOSSU:RegisterTask|RegisterTask]]
|-
| 0x000C0082
| [[BOSSU:UnregisterTask|UnregisterTask]]
|-
| 0x000D0082
| [[BOSSU:ReconfigureTask|ReconfigureTask]]
|-
| 0x000E0000
| [[BOSSU:GetTaskIdList|GetTaskIdList]]
|-
| 0x000F0042
| [[BOSSU:GetStepIdList|GetStepIdList]]
|-
| 0x00100102
| [[BOSSU:GetNsDataIdList|GetNsDataIdList]]
|-
| 0x00110102
| [[BOSSU:GetNsDataIdList1|GetNsDataIdList1]]
|-
| 0x00120102
| [[BOSSU:GetNsDataIdList2|GetNsDataIdList2]]
|-
| 0x00130102
| [[BOSSU:GetNsDataIdList3|GetNsDataIdList3]]
|-
| 0x00140082
| [[BOSSU:SendProperty|SendProperty]]
|-
| 0x00150042
| [[BOSSU:SendPropertyHandle|SendPropertyHandle]]
|-
| 0x00160082
| [[BOSSU:ReceiveProperty|ReceiveProperty]]
|-
| 0x00170082
| [[BOSSU:UpdateTaskInterval|UpdateTaskInterval]]
|-
| 0x00180082
| [[BOSSU:UpdateTaskCount|UpdateTaskCount]]
|-
| 0x00190042
| [[BOSSU:GetTaskInterval|GetTaskInterval]]
|-
| 0x001A0042
| [[BOSSU:GetTaskCount|GetTaskCount]]
|-
| 0x001B0042
| [[BOSSU:GetTaskServiceStatus|GetTaskServiceStatus]]
|-
| 0x001C0042
| [[BOSSU:StartTask|StartTask]]
|-
| 0x001D0042
| [[BOSSU:StartTaskImmediate|StartTaskImmediate]]
|-
| 0x001E0042
| [[BOSSU:CancelTask|CancelTask]]
|-
| 0x001F0000
| [[BOSSU:GetTaskFinishHandle|GetTaskFinishHandle]]
|-
| 0x00200082
| [[BOSSU:GetTaskState|GetTaskState]]
|-
| 0x00210042
| [[BOSSU:GetTaskResult|GetTaskResult]]
|-
| 0x00220042
| [[BOSSU:GetTaskCommErrorCode|GetTaskCommErrorCode]]
|-
| 0x002300C2
| [[BOSSU:GetTaskStatus|GetTaskStatus]]
|-
| 0x00240082
| [[BOSSU:GetTaskError|GetTaskError]]
|-
| 0x00250082
| [[BOSSU:GetTaskInfo|GetTaskInfo]]
|-
| 0x00260040
| [[BOSSU:DeleteNsData|DeleteNsData]]
|-
| 0x002700C2
| [[BOSSU:GetNsDataHeaderInfo|GetNsDataHeaderInfo]]
|-
| 0x00280102
| [[BOSSU:ReadNsData|ReadNsData]]
|-
| 0x00290080
| [[BOSSU:SetNsDataAdditionalInfo|SetNsDataAdditionalInfo]]
|-
| 0x002A0040
| [[BOSSU:GetNsDataAdditionalInfo|GetNsDataAdditionalInfo]]. Writes an output u32 to cmdreply[2].
|-
| 0x002B0080
| [[BOSSU:SetNsDataNewFlag|SetNsDataNewFlag]]
|-
| 0x002C0040
| [[BOSSU:GetNsDataNewFlag|GetNsDataNewFlag]]
|-
| 0x002D0040
| [[BOSSU:GetNsDataLastUpdate|GetNsDataLastUpdate]] (u32 NsDataId) Writes an output u64 to cmdreply[2-3], from the content file in extdata.
|-
| 0x002E0040
| [[BOSSU:GetErrorCode|GetErrorCode]]
|-
| 0x002F0140
| [[BOSSU:RegisterStorageEntry|RegisterStorageEntry]]
|-
| 0x00300000
| [[BOSSU:GetStorageEntryInfo|GetStorageEntryInfo]]
|-
| 0x00310100
| [[BOSSU:SetStorageOption|SetStorageOption]]
|-
| 0x00320000
| [[BOSSU:GetStorageOption|GetStorageOption]]
|-
| 0x00330042
| [[BOSSU:StartBgImmediate|StartBgImmediate]]
|-
| 0x00340042
| [[BOSSU:GetTaskPriority|GetTaskPriority]]
|-
| 0x003500C2
| [[BOSSU:RegisterImmediateTask|RegisterImmediateTask]]
|-
| 0x00360084
| [[BOSSU:SetTaskQuery|SetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|-
| 0x00370084
| [[BOSSU:GetTaskQuery|GetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|}

==BOSS Privileged Service "boss:P"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x04010082
| [[BOSSP:InitializeSessionPrivileged|InitializeSessionPrivileged]]
|-
| 0x04020000
| ?
|-
| 0x04030000
| ?
|-
| 0x04040080
| [[BOSSP:GetAppNewFlag|GetAppNewFlag]]
|-
| 0x040500C0
| [[BOSSP:SetAppNewFlag|SetAppNewFlag]]
|-
| 0x040600C0
| [[BOSSP:SetOptoutFlagPrivileged|SetOptoutFlagPrivileged]]
|-
| 0x04070080
| [[BOSSP:GetOptoutFlagPrivileged|GetOptoutFlagPrivileged]]
|-
| 0x04080040
| (u8 optout) Sets the optout flag to all apps?
|-
| 0x04090102
| [[BOSSP:UnregisterTaskPrivileged|UnregisterTaskPrivileged]]
|-
| 0x040A0000
| [[BOSSP:GetAppIdList|GetAppIdList]]
|-
| 0x040B0080
| [[BOSSP:GetTaskIdListPrivileged|GetTaskIdListPrivileged]]
|-
| 0x040C00C2
| [[BOSSP:GetStepIdListPrivileged|GetStepIdListPrivileged]]
|-
| 0x040D0182
| [[BOSSP:GetNsDataIdListPrivileged|GetNsDataIdListPrivileged]]
|-
| 0x040E0182
| [[BOSSP:GetNsDataIdListPrivileged1|GetNsDataIdListPrivileged1]]
|-
| 0x040F0102
| [[BOSSP:GetTaskInfoPrivileged|GetTaskInfoPrivileged]]
|-
| 0x04100102
| [[BOSSP:GetTaskStatusPrivileged1|GetTaskStatusPrivileged1]] Same as GetTaskStatusPrivileged, but the input bool is set to false
|-
| 0x04110102
| [[BOSSP:GetTaskErrorPrivileged|GetTaskErrorPrivileged]]
|-
| 0x04120000
| Related to the sysmodule savedata?
|-
| 0x04130082
| [[BOSSP:SendPropertyPrivileged|SendPropertyPrivileged]]
|-
| 0x04140082
| [[BOSSP:ReceivePropertyPrivileged|ReceivePropertyPrivileged]]
|-
| 0x041500C0
| [[BOSSP:DeleteNsDataPrivileged|DeleteNsDataPrivileged]]
|-
| 0x04160142
| [[BOSSP:GetNsDataHeaderInfoPrivileged|GetNsDataHeaderInfoPrivileged]]
|-
| 0x04170182
| [[BOSSP:ReadNsDataPrivileged|ReadNsDataPrivileged]]
|-
| 0x04180100
| [[BOSSP:SetNsDataAdditionalInfoPrivileged|SetNsDataAdditionalInfoPrivileged]]
|-
| 0x041900C0
| [[BOSSP:GetNsDataAdditionalInfoPrivileged|GetNsDataAdditionalInfoPrivileged]]
|-
| 0x041A0100
| [[BOSSP:SetNsDataNewFlagPrivileged|SetNsDataNewFlagPrivileged]]
|-
| 0x041B00C0
| [[BOSSP:GetNsDataNewFlagPrivileged|GetNsDataNewFlagPrivileged]]
|-
| 0x041C00C0
| [[BOSSP:GetNsDataLastUpdatePrivileged|GetNsDataLastUpdatePrivileged]]
|-
| 0x041D0040
| (bool unk_flag1)
|-
| 0x041E0000
| Returns: bool unk_flag1
|-
| 0x041F0040
| [[BOSSP:SetTestModeAvailability|SetTestModeAvailability]] (bool test_mode_flag)
|-
| 0x04200000
| [[BOSSP:GetTestModeAvailability|GetTestModeAvailability]]. Returns: bool test_mode_flag
|-
| 0x04210000?
| Stubbed
|-
| 0x04220000
| ?
|-
| 0x04230000?
| Stubbed
|-
| 0x04240000
| ?
|-
| 0x04250042
| [[BOSSP:SetPolicyListEnvId|SetPolicyListEnvId]]. Sets the policylist env ID (default env ID is "p01"): strncpy("p01", in, 8)
|-
| 0x04260042
| [[BOSSP:GetPolicyListEnvId|GetPolicyListEnvId]]. Gets the policylist env ID (default env ID is "p01"): strcpy(out, "p01")
|-
| 0x04270042
| [[BOSSP:SetPolicyListUrl|SetPolicyListUrl]]. Sets a custom policylist URL. Max of 0x200 chars
|-
| 0x04280042
| [[BOSSP:GetPolicyListUrl|GetPolicyListUrl]]. Gets the custom policylist URL
|-
| 0x04290002
| (Handle unk)
|-
| 0x042A0000
| Closes the previous handle
|-
| 0x042B0000
| Returns: u8 unk
|-
| 0x042C0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>
|-
| 0x042D0000
| Returns: u32 unk
|-
| 0x042E00C2
| [[BOSSP:StartTaskPrivileged|StartTaskPrivileged]]
|-
| 0x042F00C2
| [[BOSSP:StartTaskImmediatePrivileged|StartTaskImmediatePrivileged]]
|-
| 0x043000C2
| [[BOSSP:CancelTaskPrivileged|CancelTaskPrivileged]]
|-
| 0x04310040
| (u32 unk_4) The input is stored in a variable whose default value is 0x70
|-
| 0x04320040
| Returns: u32 unk_4
|-
| 0x04330080
| [[BOSSP:GetStorageOptionPrivileged|GetStorageOptionPrivileged]]
|-
| 0x043400C2
| [[BOSSP:StartBgImmediatePrivileged|StartBgImmediatePrivileged]]
|-
| 0x04350042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x04360042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043700C2
| [[BOSSP:GetTaskPriorityPrivileged|GetTaskPriorityPrivileged]]
|-
| 0x04380000
| ?
|-
| 0x04390104
| [[BOSSP:GetTaskQueryPrivileged|GetTaskQueryPrivileged]]
|-
| 0x043A0042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x043B0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043C0080
| (u64 title_id)
|-
| 0x043D0080
| (u64 title_id)
|-
| 0x043E0042
| [[BOSSP:SetSprelayUrl|SetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Sets the sprelay URL
|-
| 0x043F0042
| [[BOSSP:GetSprelayUrl|GetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Gets the sprelay URL
|-
| 0x04400080
| [[BOSSP:SetSprelayInterval|SetSprelayInterval]] (u32 interval, u32 unk). Sets the sprelay interval, and other things
|-
| 0x04410000
| [[BOSSP:GetSprelayInterval|GetSprelayInterval]] Returns: u32 interval, u32 unk. Gets the sprelay interval, and other things
|-
| 0x04420000
| ?
|-
| 0x04430042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x208
|-
| 0x04440042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x130
|-
| 0x04450040
| (u8 unk_5)
|-
| 0x04460000
| Returns: u8 unk_5
|-
| 0x04470002
| [[BOSSP:RegisterNewArrivalEventPrivileged|RegisterNewArrivalEventPrivileged]]
|-
| 0x04480000?
| Stubbed
|-
| 0x04490142
| [[BOSSP:RegisterTaskPrivileged|RegisterTaskPrivileged]]
|-
| 0x044A0180
| [[BOSSP:SetStorageInfoPrivileged|SetStorageInfoPrivileged]]
|-
| 0x044B01C0
| [[BOSSP:RegisterStorageEntryPrivileged|RegisterStorageEntryPrivileged]]
|-
| 0x044C0080
| [[BOSSP:UnregisterStoragePrivileged|UnregisterStoragePrivileged]]
|-
| 0x044D0080
| [[BOSSP:GetStorageInfoPrivileged|GetStorageInfoPrivileged]]
|-
| 0x044E0080
| [[BOSSP:GetStorageEntryInfoPrivileged|GetStorageEntryInfoPrivileged]]
|-
| 0x044F0102
| [[BOSSP:UpdateTaskIntervalPrivileged|UpdateTaskIntervalPrivileged]]
|-
| 0x04500102
| [[BOSSP:UpdateTaskCountPrivileged|UpdateTaskCountPrivileged]]
|-
| 0x045100C2
| [[BOSSP:GetTaskIntervalPrivileged|GetTaskIntervalPrivileged]]
|-
| 0x045200C2
| [[BOSSP:GetTaskCountPrivileged|GetTaskCountPrivileged]]
|-
| 0x045300C2
| [[BOSSP:GetTaskServiceStatusPrivileged|GetTaskServiceStatusPrivileged]]
|-
| 0x04540102
| [[BOSSP:GetTaskStatePrivileged|GetTaskStatePrivileged]]
|-
| 0x045500C2
| [[BOSSP:GetTaskResultPrivileged|GetTaskResultPrivileged]]
|-
| 0x045600C2
| [[BOSSP:GetTaskCommErrorCodePrivileged|GetTaskCommErrorCodePrivileged]]
|-
| 0x04570142
| [[BOSSP:GetTaskStatusPrivileged|GetTaskStatusPrivileged]]
|-
| 0x04580104
| [[BOSSP:SetTaskQueryPrivileged|SetTaskQueryPrivileged]]
|}

boss:P also contains all of the commands from boss:U.

When Home Menu loads the SpotPass [[CBMD]] with [[Extended_Banner]], it uses bossP command 0x040D0182 first. Then it uses GetNsDataHeaderInfoPrivileged, then ReadNsDataPrivileged for loading the actual banner data.

==BOSS Service "boss:M"==

{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010002
| ?
|-
| 0x00020000
| ?
|-
| 0x00030040
| ?
|-
| 0x00040000
| ?
|-
| 0x00050000
| ?
|-
| 0x00060000
| ?
|-
| 0x00070000
| ?
|}

==programIDs==
BOSS uses programIDs raw without any handling for the New3DS programID-low bitmask. For example, attempting a NsDataId listing with the New3DS bitmask set will fail, if BOSS is only setup for that programID with the New3DS bitmask clear.

When [[BOSSU:InitializeSession|initializing]] BOSS with the default programID, the New3DS programID-low bitmask is always clear for New3DS titles since that's how it was originally registered with [[Filesystem_services|FS]]. Hence, the programID in the [[SpotPass|BOSS-container]] must always have the New3DS bitmask clear. This also means everything using the BOSSP commands with the raw programIDs loaded from AM title-listing are broken with New3DS titles, for example [[Extended_Banner]].

==Content Data Storage==
SpotPass content for each application is stored under the extdata specified by [[BOSS:SetStorageInfo]]. Certain commands verify that the PID associated with the current service session has access to the specified extdata by using [[FS:CheckAuthorityToAccessExtSaveData]], returning an error on failure. This basically renders SpotPass unusable under user-processes(when initialized under those processes) which don't have access to any SD extdata(unless NAND extdata is used instead).

All of these commands using [[FS:CheckAuthorityToAccessExtSaveData]] are: [[BOSS:SetStorageInfo]] and RegisterStorageEntry, for both BOSSU and BOSSP.

BOSS-container content is stored in the extdata registered for the programID specified in the BOSS-container, what task it's associated with / what title registered it is irrelevant with BOSS-container data storage.

==Custom SpotPass content==
SpotPass supports raw content download without using the encrypted+signed SpotPass container(raw content is used by [[Home Menu]] SpotPass VersionList for example). However, this is incompatible with the data-loading method used with SpotPass-container content(NsData commands can't be used with it).

When writing the raw content, it firsts deletes and creates the "<taskID>" file under the data-storage extdata with normal extdata(not the separate boss archive). Once successful, the final filename specified by the task config will be deleted if needed, then the "<taskID>" file will be renamed to the final filename. Afterwards, the user-process can access the final file just like any other extdata file.

For using custom content with the SpotPass container(like official titles), the only known ways to do so is: "CFW" / ARM11-kernelhax with the sigchecks for this patched, or some sort of BOSS-sysmodule exploit if there's any vulns to begin with.

==HTTP upload==
SpotPass tasks can be used for uploading data via HTTP POST. The exact method varies, but the main one is a [[HTTPC:SendPOSTDataRawTimeout|raw]] POST.

The content data is loaded from the following path: snprintf(outpath, outpathsize, "%s/%s%02x.up", archivepath, taskidstr_probably, unk);

The archivepath can be either "bossdb:"(BOSS-sysmodule NAND savedata) or the content-data-storage extdata. Certain other paths in the BOSS savedata can be used too.

==BOSS Tasks==
The TaskID is a 8-byte buffer containing a string including NUL-terminator(taskIDs are compared with: strncmp(str0, str1, 7)).

When disabling SpotPass, applications use [[BOSSU:CancelTask]] then [[BOSSU:UnregisterTask]], to delete each task.

Each process can only access tasks which it created, not other processes' tasks(even when using bossP with [[BOSSP:InitializeSessionPrivileged|init_programID]]=0).

After registration, tasks will not automatically run until they are started using one of the start-task commands.

==NsDataId==
This is an u32 ID for SpotPass content, used with the NsData service commands etc.

==NsDataHeaderInfo==
When the input type is not one of the below or when the specified output size doesn't match the expected size for this type, an error is returned.

===Type0===
Total size is 0x8-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| programID
|}

===Type1===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ?
|}

===Type2===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Content data-type, originally from the [[SpotPass|BOSS-container]].
|}

===Type3===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Content size
|}

===Type4===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ?
|}

===Type5===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ?
|}

===Type6===
Total size is 0x20-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| programID. Same data as Type0.
|-
| 0x8
| 0x4
| Same data as Type1.
|-
| 0xC
| 0x4
| ?
|-
| 0x10
| 0x4
| Same data as Type3.
|-
| 0x14
| 0xC
| ?
|}

==PropertyIDs==
{| class="wikitable" border="1"
! ID !! Size !! Type !! Read !! Write !! Rewritable !! Description
|-
| 0x0 || 0x1 || u8 || Yes || Yes || Yes || [[#PriorityLevel|Priority]]. Represents the priority of a task
|-
| 0x1 || 0x1 || u8 || Yes || Yes || Yes || SchedulingPolicy. Unknown purpose, the API on games force this to 1
|-
| 0x2 || 0x4 || u32 || Yes || Yes || Yes || TaskTargetDuration. Unknown purpose, the API on games require a value below 0x10000 (not inclusive)
|-
| 0x3 || 0x4 || u32 || Yes || Yes || Yes || Interval in seconds of the task
|-
| 0x4 || 0x4 || u32 || Yes || Yes || Yes || Count. Number of times that the task will be run. If zero, the task is persistent
|-
| 0x5 || 0x1 || u8 || Yes || Yes || Yes || TaskPermission. Unknown purpose, the API on games require a value between 0 and 3
|-
| 0x6 || 0x1 || u8 || Yes || Yes || No || [[#ActionCode|ActionCode]]. Represents the action that a task will perform
|-
| 0x7 || 0x200 || char[512] || Yes || Yes || No || URL. Unused for DataStore actions
|-
| 0x8 || 0x4 || || Yes || Yes || No || ?
|-
| 0x9 || 0x1 || || Yes || Yes || No || Controls the action data type? The API on games require a value between 0 and 6
|-
| 0xA || 0x100 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xB and 0x3E
|-
| 0xB || 0x200 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xA and 0x3E
|-
| 0xC || 0x4 || Handle || Yes || Yes || No || Optional file handle with the data to send
|-
| 0xD || 0x360 || HeaderField[3] || Yes || Yes || No || HeaderFields. Additional headers to include in the request sent to the server. Structure:
{| class="wikitable" border="1"
|-
! Offset !! Size !! Description
|-
| 0x0 || 0x20 || char[32] Header name
|-
| 0x20 || 0x100 || char[256] Header value
|}
|-
| 0xE || 0x4 || u32[1] || Yes || Yes || No || ClientCerts. List of [[HTTPC:SetClientCertDefault|cert IDs]] to use as client certs
|-
| 0xF || 0xC || u32[3] || Yes || Yes || No || RootCAs. List of [[HTTPC:AddDefaultCert|cert IDs]] to use as root CAs
|-
| 0x10 || 0x1 || u8 || Yes || Yes || No || FSClientCert. If non-zero, enables the task client certificate to be read from the filesystem. May be a bool?
|-
| 0x11 || 0x1 || u8 || Yes || Yes || No || FSRootCA. If non-zero, enables the task root CA to be read from the filesystem. May be a bool?
|-
| 0x12 || 0x1 || u8 || Yes || Yes || No || [[#ApInfoType|ApInfoType]]
|-
| 0x13 || 0x4 || u32 || Yes || Yes || No || RootCaCount. Amount of root CAs stored in property 0xF
|-
| 0x14 || 0x4 || u32 || Yes || Yes || No || ClientCertCount. Amount of client certificates stored in property 0xE
|-
| 0x15 || 0x40 || || Yes || Yes || No || ?
|-
| 0x16 || 0x4 || || Yes || Yes || No || ?
|-
| 0x17 || || || No || No || No || Reserved
|-
| 0x18 || 0x1 || || Yes || Yes || No || Unknown purpose, the API on games force this to 1
|-
| 0x19 || 0x1 || || Yes || Yes || No || ?
|-
| 0x1A || 0x1 || || Yes || Yes || No || ?
|-
| 0x1B || 0x4 || || Yes || Yes || No || ?
|-
| 0x1C || 0x4 || || Yes || Yes || No || ?
|-
| 0x1D || 0x1 || u8 || Yes || No || No || [[#TaskStateCode|TaskStateCode]]. Unknown purpose
|-
| 0x1E || 0x1 || || Yes || No || No || ?
|-
| 0x1F || 0x1 || || Yes || No || No || ?
|-
| 0x20 || 0x1 || u8 || Yes || No || No || TaskResultCode. Unknown purpose
|-
| 0x21 || 0x1 || u8 || Yes || No || No || TaskServiceStatus. Unknown purpose
|-
| 0x22 || 0x1 || || Yes || No || No || ?
|-
| 0x23 || 0x4 || u32 || Yes || No || No || CommErrorCode. Unknown purpose
|-
| 0x24 || 0x1 || || Yes || No || No || ?
|-
| 0x25 || 0x4 || || Yes || No || No || ?
|-
| 0x26 || 0x4 || || Yes || No || No || ?
|-
| 0x27 || 0x4 || || Yes || No || No || ?
|-
| 0x28 || 0x8 || u64 || Yes || No || No || LastSuccessfulTimestamp. Number of seconds since the year 2000 of the last successful run of the task
|-
| 0x29 || 0x8 || || Yes || No || No || ?
|-
| 0x2A || 0x4 || || Yes || No || No || ?
|-
| 0x2B || 0x4 || || Yes || No || No || ?
|-
| 0x2C || 0x1 || || Yes || No || No || ?
|-
| 0x2D || 0x2 || || Yes || No || No || ?
|-
| 0x2E || 0x2 || || Yes || No || No || ?
|-
| 0x2F || 0x40 || char[64] || Yes || No || No || LastModifiedHeader. Date string from the Last-Modified HTTP header received when executing the task
|-
| 0x30 || 0x1 || || Yes || No || No || ?
|-
| 0x31 || 0x4 || || Yes || No || No || ?
|-
| 0x32 || 0x100 || || Yes || No || No || ?
|-
| 0x33 || 0x2 || u16 || Yes || No || No || TotalApps. Number of application IDs on the below list
|-
| 0x34 || 0x400 || u64[128] || Yes || No || No || AppIdList. List of application IDs registered in BOSS
|-
| 0x35 || 0x2 || u16 || Yes || No || No || TotalTasks. Number of task IDs on the below list
|-
| 0x36 || 0x400 || char[8][128] || Yes || No || No || TaskIdList. List of task IDs registered by the application
|-
| 0x37 || 0x2 || u16 || Yes || No || No || TotalSteps. Number of step IDs on the below list
|-
| 0x38 || 0x80 || u8[128] || Yes || No || No || StepIdList. List of steps that the task has registered
|-
| 0x39 || || || No || No || No || Reserved
|-
| 0x3A || || || No || No || No || Reserved
|-
| 0x3B || 0x4 || || Yes || Yes || No || ?
|-
| 0x3C || || || No || No || No || Reserved
|-
| 0x3D || || || No || No || No || Reserved
|-
| 0x3E || 0x200 || || Yes || Yes || No || DataStoreDownloadActionData. Shares buffer with properties 0xA and 0xB
|-
| 0x3F || 0x1 || u8 || Yes || Yes || No || [[#CfgInfoType|CfgInfoType]]
|}

The official name for this type is "PropertyType". The read column represents properties which can be obtained with [[BOSSU:ReceiveProperty|ReceiveProperty]], the write column represents properties which can be set with [[BOSSU:SendProperty|SendProperty]], and the rewritable column indicates properties which can be reassigned into an existing task with [[BOSSU:ReconfigureTask|ReconfigureTask]]. If the specified size for the command is larger than the property size, it will use the actual property size instead. When the specified size is less than the actual property size, all of the property data that won't be written to is cleared.

Trying to send a property which doesn't support being sent will give an error 0xC960F84D. Using reserved properties as an argument will give the same error.

==TaskStateCode==
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Last task run was successful?
|-
| 0x2
| Task started.
|-
| 0x5
| Task not started(also the initial state immediately after task creation).
|-
| 0x6
| Unknown
|-
| 0x7
| Task processing failed(such as network error).
|}

This u8 is returned by [[BOSSU:GetTaskState]].

==PriorityLevel==
{| class="wikitable" border="1"
! Value !! Name !! Description
|-
| 0x0 || INVALID? || Probably represents an invalid value
|-
| 0x15 || EXPEDITE1 ||
|-
| 0x16 || EXPEDITE2 ||
|-
| 0x17 || EXPEDITE3 ||
|-
| 0x18 || EXPEDITE4 ||
|-
| 0x19 || EXPEDITE5 ||
|-
| 0x1A || EXPEDITE6 ||
|-
| 0x1B || EXPEDITE7 ||
|-
| 0x1C || EXPEDITE8 ||
|-
| 0x23 || EXPEDITE ||
|-
| 0x50 || HIGH ||
|-
| 0x7D || MEDIUM || This is the default value inside the games API
|-
| 0xAA || LOW ||
|-
| 0xD7 || LOWEST ||
|-
| 0xDD || LOWEST1 ||
|-
| 0xDE || LOWEST2 ||
|-
| 0xDF || LOWEST3 ||
|-
| 0xE0 || LOWEST4 ||
|-
| 0xE1 || LOWEST5 ||
|-
| 0xE2 || LOWEST6 ||
|-
| 0xE3 || LOWEST7 ||
|-
| 0xE4 || LOWEST8 ||
|-
| 0xFF || STOPPED || The task won't be run
|}

Represents the priority of a task. Any values outside the ones listed above are considered invalid.

==ActionCode==
{| class="wikitable" border="1"
! Value !! Description
|-
| 0x1 || FileList? Action code used for listing files on the BOSS server. May be a generic raw download?
|-
| 0x2 || NsaDownload? Action code for downloading data from the given URL, principally an NsData
|-
| 0x3 || Upload? Action code for uploading data to the given URL
|-
| 0x4 || ?
|-
| 0x5 || ?
|-
| 0x6 || Action code used by task ID "pl" from the Home Menu
|-
| 0x7 || Action code used by task ID "phu" from the Home Menu
|-
| 0x8 || Action code used by task ID "tiu" from the Home Menu
|-
| 0x9 || Action code used by task ID "splu" from the Home Menu
|-
| 0xA || Action code used for downloading data from DataStore through an Hpp server. Stores notification data?
|-
| 0xB || Action code related to DataStore?
|-
| 0xC || Action code used for StreetPass Relay
|-
| 0xD || Action code used for downloading the title version list (versionList.dat)
|}

This represents the action that a task will perform.

==ApInfoType==
{| class="wikitable" border="1"
! Flag !! Description
|-
| 0x1 || Adds the "apgroup" parameter to the query
|-
| 0x2 || Adds the "aparea" parameter to the query
|-
| 0x4 || Adds the "ap" parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the access point the console is connected to.

==CfgInfoType==
{| class="wikitable sortable"
! Flag !! Description
|-
| 0x01 || Adds the "c" (two-letter country code) parameter to the query
|-
| 0x02 || Adds the "l" (two-letter language code) parameter to the query
|-
| 0x04 || Adds the "tm" ([[Cfg:GetSystemModel|target model]]) parameter to the query
|}

This is a set of flags which add additional paramaters to the URL query with information about the console configuration.

==Errors==
{| class="wikitable" border="1"
|-
! Error-code
! Description
|-
| 0xC8A0F833
| taskID not found.
|-
| 0xC8A0F836
| taskID already exists, for task creation.
|-
| 0xC8A0F842
| The specified programID is not setup for BOSS.
|-
| 0xC8A0F843
| The specified NsDataId was not found.
|}

[[Category:Services]]

BOSS Services

2025-08-20T17:39:29Z

DaniElectra: /* PropertyIDs */ Expand documentation

==BOSS User Service "boss:U"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010082
| [[BOSSU:InitializeSession|InitializeSession]]
|-
| 0x00020100
| [[BOSSU:SetStorageInfo|SetStorageInfo]]
|-
| 0x00030000
| [[BOSSU:UnregisterStorage|UnregisterStorage]]
|-
| 0x00040000
| [[BOSSU:GetStorageInfo|GetStorageInfo]]
|-
| 0x00050042
| [[BOSSU:RegisterPrivateRootCa|RegisterPrivateRootCa]]
|-
| 0x00060084
| [[BOSSU:RegisterPrivateClientCert|RegisterPrivateClientCert]] <nowiki>(u32 Size0, u32 Size1, ((Size0<<4) | 10), Buf0, ((Size1<<4) | 10), Buf1)</nowiki> This writes the content of the input buffers into files "bossdb:/%s_CL" and "bossdb:/%s_CLK", where "%s" is generated from the programID.
|-
| 0x00070000
| [[BOSSU:GetNewArrivalFlag|GetNewArrivalFlag]]
|-
| 0x00080002
| [[BOSSU:RegisterNewArrivalEvent|RegisterNewArrivalEvent]]: Used for sending a handle. This is used with a table of programIDs etc with a maximum of 5 entries.
|-
| 0x00090040
| [[BOSSU:SetOptoutFlag|SetOptoutFlag]]
|-
| 0x000A0000
| [[BOSSU:GetOptoutFlag|GetOptoutFlag]]
|-
| 0x000B00C2
| [[BOSSU:RegisterTask|RegisterTask]]
|-
| 0x000C0082
| [[BOSSU:UnregisterTask|UnregisterTask]]
|-
| 0x000D0082
| [[BOSSU:ReconfigureTask|ReconfigureTask]]
|-
| 0x000E0000
| [[BOSSU:GetTaskIdList|GetTaskIdList]]
|-
| 0x000F0042
| [[BOSSU:GetStepIdList|GetStepIdList]]
|-
| 0x00100102
| [[BOSSU:GetNsDataIdList|GetNsDataIdList]]
|-
| 0x00110102
| [[BOSSU:GetNsDataIdList1|GetNsDataIdList1]]
|-
| 0x00120102
| [[BOSSU:GetNsDataIdList2|GetNsDataIdList2]]
|-
| 0x00130102
| [[BOSSU:GetNsDataIdList3|GetNsDataIdList3]]
|-
| 0x00140082
| [[BOSSU:SendProperty|SendProperty]]
|-
| 0x00150042
| [[BOSSU:SendPropertyHandle|SendPropertyHandle]]
|-
| 0x00160082
| [[BOSSU:ReceiveProperty|ReceiveProperty]]
|-
| 0x00170082
| [[BOSSU:UpdateTaskInterval|UpdateTaskInterval]]
|-
| 0x00180082
| [[BOSSU:UpdateTaskCount|UpdateTaskCount]]
|-
| 0x00190042
| [[BOSSU:GetTaskInterval|GetTaskInterval]]
|-
| 0x001A0042
| [[BOSSU:GetTaskCount|GetTaskCount]]
|-
| 0x001B0042
| [[BOSSU:GetTaskServiceStatus|GetTaskServiceStatus]]
|-
| 0x001C0042
| [[BOSSU:StartTask|StartTask]]
|-
| 0x001D0042
| [[BOSSU:StartTaskImmediate|StartTaskImmediate]]
|-
| 0x001E0042
| [[BOSSU:CancelTask|CancelTask]]
|-
| 0x001F0000
| [[BOSSU:GetTaskFinishHandle|GetTaskFinishHandle]]
|-
| 0x00200082
| [[BOSSU:GetTaskState|GetTaskState]]
|-
| 0x00210042
| [[BOSSU:GetTaskResult|GetTaskResult]]
|-
| 0x00220042
| [[BOSSU:GetTaskCommErrorCode|GetTaskCommErrorCode]]
|-
| 0x002300C2
| [[BOSSU:GetTaskStatus|GetTaskStatus]]
|-
| 0x00240082
| [[BOSSU:GetTaskError|GetTaskError]]
|-
| 0x00250082
| [[BOSSU:GetTaskInfo|GetTaskInfo]]
|-
| 0x00260040
| [[BOSSU:DeleteNsData|DeleteNsData]]
|-
| 0x002700C2
| [[BOSSU:GetNsDataHeaderInfo|GetNsDataHeaderInfo]]
|-
| 0x00280102
| [[BOSSU:ReadNsData|ReadNsData]]
|-
| 0x00290080
| [[BOSSU:SetNsDataAdditionalInfo|SetNsDataAdditionalInfo]]
|-
| 0x002A0040
| [[BOSSU:GetNsDataAdditionalInfo|GetNsDataAdditionalInfo]]. Writes an output u32 to cmdreply[2].
|-
| 0x002B0080
| [[BOSSU:SetNsDataNewFlag|SetNsDataNewFlag]]
|-
| 0x002C0040
| [[BOSSU:GetNsDataNewFlag|GetNsDataNewFlag]]
|-
| 0x002D0040
| [[BOSSU:GetNsDataLastUpdate|GetNsDataLastUpdate]] (u32 NsDataId) Writes an output u64 to cmdreply[2-3], from the content file in extdata.
|-
| 0x002E0040
| [[BOSSU:GetErrorCode|GetErrorCode]]
|-
| 0x002F0140
| [[BOSSU:RegisterStorageEntry|RegisterStorageEntry]]
|-
| 0x00300000
| [[BOSSU:GetStorageEntryInfo|GetStorageEntryInfo]]
|-
| 0x00310100
| [[BOSSU:SetStorageOption|SetStorageOption]]
|-
| 0x00320000
| [[BOSSU:GetStorageOption|GetStorageOption]]
|-
| 0x00330042
| [[BOSSU:StartBgImmediate|StartBgImmediate]]
|-
| 0x00340042
| [[BOSSU:GetTaskPriority|GetTaskPriority]]
|-
| 0x003500C2
| [[BOSSU:RegisterImmediateTask|RegisterImmediateTask]]
|-
| 0x00360084
| [[BOSSU:SetTaskQuery|SetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|-
| 0x00370084
| [[BOSSU:GetTaskQuery|GetTaskQuery]] <nowiki>(u32 TaskID_Size, u32 BufSize, ((TaskID_Size<<4) | 10), TaskID_buf, ((BufSize<<4) | 10), Buf)</nowiki> BufSize must match 0x60.
|}

==BOSS Privileged Service "boss:P"==
{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x04010082
| [[BOSSP:InitializeSessionPrivileged|InitializeSessionPrivileged]]
|-
| 0x04020000
| ?
|-
| 0x04030000
| ?
|-
| 0x04040080
| [[BOSSP:GetAppNewFlag|GetAppNewFlag]]
|-
| 0x040500C0
| [[BOSSP:SetAppNewFlag|SetAppNewFlag]]
|-
| 0x040600C0
| [[BOSSP:SetOptoutFlagPrivileged|SetOptoutFlagPrivileged]]
|-
| 0x04070080
| [[BOSSP:GetOptoutFlagPrivileged|GetOptoutFlagPrivileged]]
|-
| 0x04080040
| (u8 optout) Sets the optout flag to all apps?
|-
| 0x04090102
| [[BOSSP:UnregisterTaskPrivileged|UnregisterTaskPrivileged]]
|-
| 0x040A0000
| [[BOSSP:GetAppIdList|GetAppIdList]]
|-
| 0x040B0080
| [[BOSSP:GetTaskIdListPrivileged|GetTaskIdListPrivileged]]
|-
| 0x040C00C2
| [[BOSSP:GetStepIdListPrivileged|GetStepIdListPrivileged]]
|-
| 0x040D0182
| [[BOSSP:GetNsDataIdListPrivileged|GetNsDataIdListPrivileged]]
|-
| 0x040E0182
| [[BOSSP:GetNsDataIdListPrivileged1|GetNsDataIdListPrivileged1]]
|-
| 0x040F0102
| [[BOSSP:GetTaskInfoPrivileged|GetTaskInfoPrivileged]]
|-
| 0x04100102
| [[BOSSP:GetTaskStatusPrivileged1|GetTaskStatusPrivileged1]] Same as GetTaskStatusPrivileged, but the input bool is set to false
|-
| 0x04110102
| [[BOSSP:GetTaskErrorPrivileged|GetTaskErrorPrivileged]]
|-
| 0x04120000
| Related to the sysmodule savedata?
|-
| 0x04130082
| [[BOSSP:SendPropertyPrivileged|SendPropertyPrivileged]]
|-
| 0x04140082
| [[BOSSP:ReceivePropertyPrivileged|ReceivePropertyPrivileged]]
|-
| 0x041500C0
| [[BOSSP:DeleteNsDataPrivileged|DeleteNsDataPrivileged]]
|-
| 0x04160142
| [[BOSSP:GetNsDataHeaderInfoPrivileged|GetNsDataHeaderInfoPrivileged]]
|-
| 0x04170182
| [[BOSSP:ReadNsDataPrivileged|ReadNsDataPrivileged]]
|-
| 0x04180100
| [[BOSSP:SetNsDataAdditionalInfoPrivileged|SetNsDataAdditionalInfoPrivileged]]
|-
| 0x041900C0
| [[BOSSP:GetNsDataAdditionalInfoPrivileged|GetNsDataAdditionalInfoPrivileged]]
|-
| 0x041A0100
| [[BOSSP:SetNsDataNewFlagPrivileged|SetNsDataNewFlagPrivileged]]
|-
| 0x041B00C0
| [[BOSSP:GetNsDataNewFlagPrivileged|GetNsDataNewFlagPrivileged]]
|-
| 0x041C00C0
| [[BOSSP:GetNsDataLastUpdatePrivileged|GetNsDataLastUpdatePrivileged]]
|-
| 0x041D0040
| (bool unk_flag1)
|-
| 0x041E0000
| Returns: bool unk_flag1
|-
| 0x041F0040
| [[BOSSP:SetTestModeAvailability|SetTestModeAvailability]] (bool test_mode_flag)
|-
| 0x04200000
| [[BOSSP:GetTestModeAvailability|GetTestModeAvailability]]. Returns: bool test_mode_flag
|-
| 0x04210000?
| Stubbed
|-
| 0x04220000
| ?
|-
| 0x04230000?
| Stubbed
|-
| 0x04240000
| ?
|-
| 0x04250042
| [[BOSSP:SetPolicyListEnvId|SetPolicyListEnvId]]. Sets the policylist env ID (default env ID is "p01"): strncpy("p01", in, 8)
|-
| 0x04260042
| [[BOSSP:GetPolicyListEnvId|GetPolicyListEnvId]]. Gets the policylist env ID (default env ID is "p01"): strcpy(out, "p01")
|-
| 0x04270042
| [[BOSSP:SetPolicyListUrl|SetPolicyListUrl]]. Sets a custom policylist URL. Max of 0x200 chars
|-
| 0x04280042
| [[BOSSP:GetPolicyListUrl|GetPolicyListUrl]]. Gets the custom policylist URL
|-
| 0x04290002
| (Handle unk)
|-
| 0x042A0000
| Closes the previous handle
|-
| 0x042B0000
| Returns: u8 unk
|-
| 0x042C0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>
|-
| 0x042D0000
| Returns: u32 unk
|-
| 0x042E00C2
| [[BOSSP:StartTaskPrivileged|StartTaskPrivileged]]
|-
| 0x042F00C2
| [[BOSSP:StartTaskImmediatePrivileged|StartTaskImmediatePrivileged]]
|-
| 0x043000C2
| [[BOSSP:CancelTaskPrivileged|CancelTaskPrivileged]]
|-
| 0x04310040
| (u32 unk_4) The input is stored in a variable whose default value is 0x70
|-
| 0x04320040
| Returns: u32 unk_4
|-
| 0x04330080
| [[BOSSP:GetStorageOptionPrivileged|GetStorageOptionPrivileged]]
|-
| 0x043400C2
| [[BOSSP:StartBgImmediatePrivileged|StartBgImmediatePrivileged]]
|-
| 0x04350042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x04360042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043700C2
| [[BOSSP:GetTaskPriorityPrivileged|GetTaskPriorityPrivileged]]
|-
| 0x04380000
| ?
|-
| 0x04390104
| [[BOSSP:GetTaskQueryPrivileged|GetTaskQueryPrivileged]]
|-
| 0x043A0042
| <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Stubbed
|-
| 0x043B0042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Stubbed
|-
| 0x043C0080
| (u64 title_id)
|-
| 0x043D0080
| (u64 title_id)
|-
| 0x043E0042
| [[BOSSP:SetSprelayUrl|SetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xA), Buf)</nowiki>. Sets the sprelay URL
|-
| 0x043F0042
| [[BOSSP:GetSprelayUrl|GetSprelayUrl]] <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Gets the sprelay URL
|-
| 0x04400080
| [[BOSSP:SetSprelayInterval|SetSprelayInterval]] (u32 interval, u32 unk). Sets the sprelay interval, and other things
|-
| 0x04410000
| [[BOSSP:GetSprelayInterval|GetSprelayInterval]] Returns: u32 interval, u32 unk. Gets the sprelay interval, and other things
|-
| 0x04420000
| ?
|-
| 0x04430042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x208
|-
| 0x04440042
| <nowiki>(u32 Size, ((Size<<4)|0xC), Buf)</nowiki>. Size must be at least 0x130
|-
| 0x04450040
| (u8 unk_5)
|-
| 0x04460000
| Returns: u8 unk_5
|-
| 0x04470002
| [[BOSSP:RegisterNewArrivalEventPrivileged|RegisterNewArrivalEventPrivileged]]
|-
| 0x04480000?
| Stubbed
|-
| 0x04490142
| [[BOSSP:RegisterTaskPrivileged|RegisterTaskPrivileged]]
|-
| 0x044A0180
| [[BOSSP:SetStorageInfoPrivileged|SetStorageInfoPrivileged]]
|-
| 0x044B01C0
| [[BOSSP:RegisterStorageEntryPrivileged|RegisterStorageEntryPrivileged]]
|-
| 0x044C0080
| [[BOSSP:UnregisterStoragePrivileged|UnregisterStoragePrivileged]]
|-
| 0x044D0080
| [[BOSSP:GetStorageInfoPrivileged|GetStorageInfoPrivileged]]
|-
| 0x044E0080
| [[BOSSP:GetStorageEntryInfoPrivileged|GetStorageEntryInfoPrivileged]]
|-
| 0x044F0102
| [[BOSSP:UpdateTaskIntervalPrivileged|UpdateTaskIntervalPrivileged]]
|-
| 0x04500102
| [[BOSSP:UpdateTaskCountPrivileged|UpdateTaskCountPrivileged]]
|-
| 0x045100C2
| [[BOSSP:GetTaskIntervalPrivileged|GetTaskIntervalPrivileged]]
|-
| 0x045200C2
| [[BOSSP:GetTaskCountPrivileged|GetTaskCountPrivileged]]
|-
| 0x045300C2
| [[BOSSP:GetTaskServiceStatusPrivileged|GetTaskServiceStatusPrivileged]]
|-
| 0x04540102
| [[BOSSP:GetTaskStatePrivileged|GetTaskStatePrivileged]]
|-
| 0x045500C2
| [[BOSSP:GetTaskResultPrivileged|GetTaskResultPrivileged]]
|-
| 0x045600C2
| [[BOSSP:GetTaskCommErrorCodePrivileged|GetTaskCommErrorCodePrivileged]]
|-
| 0x04570142
| [[BOSSP:GetTaskStatusPrivileged|GetTaskStatusPrivileged]]
|-
| 0x04580104
| [[BOSSP:SetTaskQueryPrivileged|SetTaskQueryPrivileged]]
|}

boss:P also contains all of the commands from boss:U.

When Home Menu loads the SpotPass [[CBMD]] with [[Extended_Banner]], it uses bossP command 0x040D0182 first. Then it uses GetNsDataHeaderInfoPrivileged, then ReadNsDataPrivileged for loading the actual banner data.

==BOSS Service "boss:M"==

{| class="wikitable" border="1"
|-
! Command Header
! Description
|-
| 0x00010002
| ?
|-
| 0x00020000
| ?
|-
| 0x00030040
| ?
|-
| 0x00040000
| ?
|-
| 0x00050000
| ?
|-
| 0x00060000
| ?
|-
| 0x00070000
| ?
|}

==programIDs==
BOSS uses programIDs raw without any handling for the New3DS programID-low bitmask. For example, attempting a NsDataId listing with the New3DS bitmask set will fail, if BOSS is only setup for that programID with the New3DS bitmask clear.

When [[BOSSU:InitializeSession|initializing]] BOSS with the default programID, the New3DS programID-low bitmask is always clear for New3DS titles since that's how it was originally registered with [[Filesystem_services|FS]]. Hence, the programID in the [[SpotPass|BOSS-container]] must always have the New3DS bitmask clear. This also means everything using the BOSSP commands with the raw programIDs loaded from AM title-listing are broken with New3DS titles, for example [[Extended_Banner]].

==Content Data Storage==
SpotPass content for each application is stored under the extdata specified by [[BOSS:SetStorageInfo]]. Certain commands verify that the PID associated with the current service session has access to the specified extdata by using [[FS:CheckAuthorityToAccessExtSaveData]], returning an error on failure. This basically renders SpotPass unusable under user-processes(when initialized under those processes) which don't have access to any SD extdata(unless NAND extdata is used instead).

All of these commands using [[FS:CheckAuthorityToAccessExtSaveData]] are: [[BOSS:SetStorageInfo]] and RegisterStorageEntry, for both BOSSU and BOSSP.

BOSS-container content is stored in the extdata registered for the programID specified in the BOSS-container, what task it's associated with / what title registered it is irrelevant with BOSS-container data storage.

==Custom SpotPass content==
SpotPass supports raw content download without using the encrypted+signed SpotPass container(raw content is used by [[Home Menu]] SpotPass VersionList for example). However, this is incompatible with the data-loading method used with SpotPass-container content(NsData commands can't be used with it).

When writing the raw content, it firsts deletes and creates the "<taskID>" file under the data-storage extdata with normal extdata(not the separate boss archive). Once successful, the final filename specified by the task config will be deleted if needed, then the "<taskID>" file will be renamed to the final filename. Afterwards, the user-process can access the final file just like any other extdata file.

For using custom content with the SpotPass container(like official titles), the only known ways to do so is: "CFW" / ARM11-kernelhax with the sigchecks for this patched, or some sort of BOSS-sysmodule exploit if there's any vulns to begin with.

==HTTP upload==
SpotPass tasks can be used for uploading data via HTTP POST. The exact method varies, but the main one is a [[HTTPC:SendPOSTDataRawTimeout|raw]] POST.

The content data is loaded from the following path: snprintf(outpath, outpathsize, "%s/%s%02x.up", archivepath, taskidstr_probably, unk);

The archivepath can be either "bossdb:"(BOSS-sysmodule NAND savedata) or the content-data-storage extdata. Certain other paths in the BOSS savedata can be used too.

==BOSS Tasks==
The TaskID is a 8-byte buffer containing a string including NUL-terminator(taskIDs are compared with: strncmp(str0, str1, 7)).

When disabling SpotPass, applications use [[BOSSU:CancelTask]] then [[BOSSU:UnregisterTask]], to delete each task.

Each process can only access tasks which it created, not other processes' tasks(even when using bossP with [[BOSSP:InitializeSessionPrivileged|init_programID]]=0).

After registration, tasks will not automatically run until they are started using one of the start-task commands.

==NsDataId==
This is an u32 ID for SpotPass content, used with the NsData service commands etc.

==NsDataHeaderInfo==
When the input type is not one of the below or when the specified output size doesn't match the expected size for this type, an error is returned.

===Type0===
Total size is 0x8-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| programID
|}

===Type1===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ?
|}

===Type2===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Content data-type, originally from the [[SpotPass|BOSS-container]].
|}

===Type3===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| Content size
|}

===Type4===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ?
|}

===Type5===
Total size is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| ?
|}

===Type6===
Total size is 0x20-bytes.

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| programID. Same data as Type0.
|-
| 0x8
| 0x4
| Same data as Type1.
|-
| 0xC
| 0x4
| ?
|-
| 0x10
| 0x4
| Same data as Type3.
|-
| 0x14
| 0xC
| ?
|}

==PropertyIDs==
{| class="wikitable sortable"
! ID !! Size !! Type !! Read !! Write !! Rewritable !! Description
|-
| 0x0 || 0x1 || u8 || Yes || Yes || Yes || Priority. Represents the priority of a task
|-
| 0x1 || 0x1 || u8 || Yes || Yes || Yes || SchedulingPolicy. Unknown purpose, the API on games force this to 1
|-
| 0x2 || 0x4 || u32 || Yes || Yes || Yes || TaskTargetDuration. Unknown purpose, the API on games require a value below 0x10000 (not inclusive)
|-
| 0x3 || 0x4 || u32 || Yes || Yes || Yes || Interval in seconds of the task
|-
| 0x4 || 0x4 || u32 || Yes || Yes || Yes || Count. Number of times that the task will be run. If zero, the task is persistent
|-
| 0x5 || 0x1 || u8 || Yes || Yes || Yes || TaskPermission. Unknown purpose, the API on games require a value between 0 and 3
|-
| 0x6 || 0x1 || u8 || Yes || Yes || No || ActionCode. Represents the action that a task will perform
|-
| 0x7 || 0x200 || char[512] || Yes || Yes || No || URL. Unused for DataStore actions
|-
| 0x8 || 0x4 || || Yes || Yes || No || ?
|-
| 0x9 || 0x1 || || Yes || Yes || No || Controls the action data type? The API on games require a value between 0 and 6
|-
| 0xA || 0x100 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xB and 0x3E
|-
| 0xB || 0x200 || || Yes || Yes || No || Unknown action data. Shares buffer with properties 0xA and 0x3E
|-
| 0xC || 0x4 || Handle || Yes || Yes || No || Optional file handle with the data to send
|-
| 0xD || 0x360 || || Yes || Yes || No || HeaderFields. Additional headers to include in the request sent to the server
|-
| 0xE || 0x4 || u32[1] || Yes || Yes || No || ClientCerts. List of [[HTTPC:SetClientCertDefault|cert IDs]] to use as client certs
|-
| 0xF || 0xC || u32[3] || Yes || Yes || No || RootCAs. List of [[HTTPC:AddDefaultCert|cert IDs]] to use as root CAs
|-
| 0x10 || 0x1 || u8 || Yes || Yes || No || FSClientCert. If non-zero, enables the task client certificate to be read from the filesystem. May be a bool?
|-
| 0x11 || 0x1 || u8 || Yes || Yes || No || FSRootCA. If non-zero, enables the task root CA to be read from the filesystem. May be a bool?
|-
| 0x12 || 0x1 || u8 || Yes || Yes || No || ApInfoType
|-
| 0x13 || 0x4 || u32 || Yes || Yes || No || RootCaCount. Amount of root CAs stored in property 0xF
|-
| 0x14 || 0x4 || u32 || Yes || Yes || No || ClientCertCount. Amount of client certificates stored in property 0xE
|-
| 0x15 || 0x40 || || Yes || Yes || No || ?
|-
| 0x16 || 0x4 || || Yes || Yes || No || ?
|-
| 0x17 || || || No || No || No || Reserved
|-
| 0x18 || 0x1 || || Yes || Yes || No || Unknown purpose, the API on games force this to 1
|-
| 0x19 || 0x1 || || Yes || Yes || No || ?
|-
| 0x1A || 0x1 || || Yes || Yes || No || ?
|-
| 0x1B || 0x4 || || Yes || Yes || No || ?
|-
| 0x1C || 0x4 || || Yes || Yes || No || ?
|-
| 0x1D || 0x1 || u8 || Yes || No || No || StateCode. Unknown purpose
|-
| 0x1E || 0x1 || || Yes || No || No || ?
|-
| 0x1F || 0x1 || || Yes || No || No || ?
|-
| 0x20 || 0x1 || u8 || Yes || No || No || TaskResultCode. Unknown purpose
|-
| 0x21 || 0x1 || u8 || Yes || No || No || ServiceStatus. Unknown purpose
|-
| 0x22 || 0x1 || || Yes || No || No || ?
|-
| 0x23 || 0x4 || u32 || Yes || No || No || CommErrorCode. Unknown purpose
|-
| 0x24 || 0x1 || || Yes || No || No || ?
|-
| 0x25 || 0x4 || || Yes || No || No || ?
|-
| 0x26 || 0x4 || || Yes || No || No || ?
|-
| 0x27 || 0x4 || || Yes || No || No || ?
|-
| 0x28 || 0x8 || u64 || Yes || No || No || LastSuccessfulTimestamp. Number of seconds since the year 2000 of the last successful run of the task
|-
| 0x29 || 0x8 || || Yes || No || No || ?
|-
| 0x2A || 0x4 || || Yes || No || No || ?
|-
| 0x2B || 0x4 || || Yes || No || No || ?
|-
| 0x2C || 0x1 || || Yes || No || No || ?
|-
| 0x2D || 0x2 || || Yes || No || No || ?
|-
| 0x2E || 0x2 || || Yes || No || No || ?
|-
| 0x2F || 0x40 || char[64] || Yes || No || No || LastModifiedHeader. Date string from the Last-Modified HTTP header received when executing the task
|-
| 0x30 || 0x1 || || Yes || No || No || ?
|-
| 0x31 || 0x4 || || Yes || No || No || ?
|-
| 0x32 || 0x100 || || Yes || No || No || ?
|-
| 0x33 || 0x2 || u16 || Yes || No || No || TotalApps. Number of application IDs on the below list
|-
| 0x34 || 0x400 || u64[128] || Yes || No || No || AppIdList. List of application IDs registered in BOSS
|-
| 0x35 || 0x2 || u16 || Yes || No || No || TotalTasks. Number of task IDs on the below list
|-
| 0x36 || 0x400 || char[8][128] || Yes || No || No || TaskIdList. List of task IDs registered by the application
|-
| 0x37 || 0x2 || u16 || Yes || No || No || TotalSteps. Number of step IDs on the below list
|-
| 0x38 || 0x80 || u8[128] || Yes || No || No || StepIdList. List of steps that the task has registered
|-
| 0x39 || || || No || No || No || Reserved
|-
| 0x3A || || || No || No || No || Reserved
|-
| 0x3B || 0x4 || || Yes || Yes || No || ?
|-
| 0x3C || || || No || No || No || Reserved
|-
| 0x3D || || || No || No || No || Reserved
|-
| 0x3E || 0x200 || || Yes || Yes || No || DataStoreDownloadActionData. Shares buffer with properties 0xA and 0xB
|-
| 0x3F || 0x1 || u8 || Yes || Yes || No || CfgInfoType
|}

The read column represents properties which can be obtained with [[BOSSU:ReceiveProperty|ReceiveProperty]], the write column represents properties which can be set with [[BOSSU:SendProperty|SendProperty]], and the rewritable column indicates properties which can be reassigned into an existing task with [[BOSSU:ReconfigureTask|ReconfigureTask]]. If the specified size for the command is larger than the property size, it will use the actual property size instead. When the specified size is less than the actual property size, all of the property data that won't be written to is cleared.

Trying to send a property which doesn't support being sent will give an error 0xC960F84D. Using reserved properties as an argument will give the same error.

==TaskStatus==
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Last task run was successful?
|-
| 0x2
| Task started.
|-
| 0x5
| Task not started(also the initial state immediately after task creation).
|-
| 0x6
| Unknown
|-
| 0x7
| Task processing failed(such as network error).
|}

This u8 is returned by [[BOSSU:GetTaskState]].

==Errors==
{| class="wikitable" border="1"
|-
! Error-code
! Description
|-
| 0xC8A0F833
| taskID not found.
|-
| 0xC8A0F836
| taskID already exists, for task creation.
|-
| 0xC8A0F842
| The specified programID is not setup for BOSS.
|-
| 0xC8A0F843
| The specified NsDataId was not found.
|}

[[Category:Services]]

BOSSU:GetTaskQuery

2025-02-07T23:22:41Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{IPC/RequestHeader|0x0037|2|4}} {{IPC/RequestEntry|u32, Task ID size, including NULL terminator}} {{IPC/RequestEntry|u32, Task query size}} {{IPC/Ma..."

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0037|2|4}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|u32, Task query size}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/MapPointerW|Task query}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0037|1|4}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/MapPointerW|Task query}}
{{IPC/RequestEnd}}

=Description=
Gets the task query to the task for the program ID of the current session. The task query is a 0x60-byte structure, so the size is always 0x60.

BOSSU:SetTaskQuery

2025-02-07T23:22:02Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{IPC/RequestHeader|0x0036|2|4}} {{IPC/RequestEntry|u32, Task ID size, including NULL terminator}} {{IPC/RequestEntry|u32, Task query size}} {{IPC/Ma..."

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0036|2|4}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|u32, Task query size}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/MapPointerR|Task query}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0036|1|4}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/MapPointerR|Task query}}
{{IPC/RequestEnd}}

=Description=
Sets a task query to the task for the program ID of the current session. The task query is a 0x60-byte structure, so the size is always 0x60.

BOSSU:RegisterImmediateTask

2025-02-07T23:16:24Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{IPC/RequestHeader|0x0035|3|2}} {{IPC/RequestEntry|u32, Task ID size, including NULL terminator}} {{IPC/RequestEntry|bool, TaskOption configured}} {..."

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0035|3|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|bool, TaskOption configured}}
{{IPC/RequestEntry|u8, Step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0035|1|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Registers a task for the program ID of the current session and updates the BOSS savedata immediately, using information previously configured with [[BOSSU:SendProperty]].

Immediate tasks are those that are configured to run immediately and only once (the count and interval are set to 1).

The input bool is set to true in the SDK if the application provides a TaskOption, which contains some of the properties that can be configured.

BOSSU:GetTaskPriority

2025-02-07T23:12:40Z

DaniElectra: Use IPC template header

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0034|1|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terinator}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0034|2|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u8, Task priority}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
This loads the current state of PropertyID 0x0 (task priority) for the given task on the program ID of the current session.

BOSSU:StartBgImmediate

2025-02-07T23:09:52Z

DaniElectra: Use IPC template header

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0033|1|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0033|1|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Seems similar to [[BOSSU:StartTaskImmediate]]?

BOSSU:GetStorageOption

2025-02-07T22:59:32Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{IPC/RequestHeader|0x0032|0|0}} {{IPC/RequestEnd}} =Response= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x0032|5|0}} {{IPC/Re..."

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0032|0|0}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0032|5|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u8, Unknown}}
{{IPC/RequestEntry|u32, Unknown}}
{{IPC/RequestEntry|u16, Unknown}}
{{IPC/RequestEntry|u16, Unknown}}
{{IPC/RequestEnd}}

=Description=
Gets options for the storage of the program ID of the current session.

BOSSU:SetStorageOption

2025-02-07T22:57:45Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{IPC/RequestHeader|0x0031|4|0}} {{IPC/RequestEntry|u8, Unknown}} {{IPC/RequestEntry|u32, Unknown}} {{IPC/RequestEntry|u16, Unknown}} {{IPC/RequestEn..."

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0031|4|0}}
{{IPC/RequestEntry|u8, Unknown}}
{{IPC/RequestEntry|u32, Unknown}}
{{IPC/RequestEntry|u16, Unknown}}
{{IPC/RequestEntry|u16, Unknown}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0031|1|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEnd}}

=Description=
Sets options for the storage of the program ID of the current session.

BOSSU:GetStorageEntryInfo

2025-02-07T22:48:37Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x0030|0|0}} {{IPC/RequestEnd}} =Response= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/Request..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0030|0|0}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0030|3|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u32, Storage size}}
{{IPC/RequestEntry|u16, Entry ID?}}
{{IPC/RequestEnd}}

=Description=
Gets information about the current storage entry being used for the program ID of the current session.

BOSSU:RegisterStorageEntry

2025-02-07T22:45:59Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{IPC/RequestHeader|0x002F|5|0}} {{IPC/RequestEntryRange|2|u64 Extdata ID}} {{IPC/RequestEntry|u32, Storage size}} {{IPC/RequestEntry|u16, Entry ID?}..."

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x002F|5|0}}
{{IPC/RequestEntryRange|2|u64 Extdata ID}}
{{IPC/RequestEntry|u32, Storage size}}
{{IPC/RequestEntry|u16, Entry ID?}}
{{IPC/RequestEntry|u8, [[Filesystem_services#MediaType|MediaType]] (only NAND or SD)}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002F|1|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEnd}}

=Description=
Registers a storage entry for the program ID of the current session, reserving storage for up to the given size. This is immediately written into the BOSS NAND savedata.

BOSSU:GetErrorCode

2025-02-07T22:41:53Z

DaniElectra: Use IPC template header

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002E|1|0}}
{{IPC/RequestEntry|u8, TaskResultCode}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002E|2|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u32, Error code}}
{{IPC/RequestEnd}}

=Description=
Converts the given task result code into an error code (004-XXXX). The returned value is an integer 004XXXX.

The error code is looked up in a table. When the input value is 0x71, the output is 46001+5 (004-6006). Otherwise when no match is found in the table and it's not 0x71, the error code is 004-6001.

This always returns result code 0.

BOSSU:GetNsDataLastUpdate

2025-02-07T22:35:07Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x002D|1|0}} {{IPC/RequestEntry|u32, NS Data ID}} {{IPC/RequestEnd}} =Response= {{IPC/Request}} {{#v..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002D|1|0}}
{{IPC/RequestEntry|u32, NS Data ID}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002D|3|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntryRange|2|u64, Last update}}
{{IPC/RequestEnd}}

=Description=
Reads the last update field from the header of the given NS Data ID of the program ID of the current session.

BOSSU:GetNsDataNewFlag

2025-02-07T22:07:03Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x002C|1|0}} {{IPC/RequestEntry|u32, NS Data ID}} {{IPC/RequestEnd}} =Response= {{IPC/Request}} {{#v..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002C|1|0}}
{{IPC/RequestEntry|u32, NS Data ID}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002C|2|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|bool, New flag}}
{{IPC/RequestEnd}}

=Description=
Gets the new flag from the given NS Data ID of the program ID of the current session.

BOSSU:SetNsDataNewFlag

2025-02-07T22:05:11Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x002B|2|0}} {{IPC/RequestEntry|u32, NS Data ID}} {{IPC/RequestEntry|bool, New flag}} {{IPC/RequestEn..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002B|2|0}}
{{IPC/RequestEntry|u32, NS Data ID}}
{{IPC/RequestEntry|bool, New flag}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002B|1|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEnd}}

=Description=
Sets the new flag on the given NS Data ID of the program ID of the current session.

BOSSU:GetNsDataAdditionalInfo

2025-02-07T22:03:26Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x002A|1|0}} {{IPC/RequestEntry|u32, NS Data ID}} {{IPC/RequestEnd}} =Response= {{IPC/Request}} {{#v..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002A|1|0}}
{{IPC/RequestEntry|u32, NS Data ID}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x002A|2|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u32, Additional info}}
{{IPC/RequestEnd}}

=Description=
Gets additional info from the header of the given NS Data ID of the program ID of the current session.

BOSSU:SetNsDataAdditionalInfo

2025-02-07T22:01:54Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x0029|2|0}} {{IPC/RequestEntry|u32, NS Data ID}} {{IPC/RequestEntry|u32, Additional info}} {{IPC/Req..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0029|2|0}}
{{IPC/RequestEntry|u32, NS Data ID}}
{{IPC/RequestEntry|u32, Additional info}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0029|1|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEnd}}

=Description=
Writes additional info into the header of the given NS Data ID of the program ID of the current session.

BOSSU:ReadNsData

2025-02-06T23:08:33Z

DaniElectra: Use IPC template header

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0028|4|2}}
{{IPC/RequestEntry|u32, NS Data ID}}
{{IPC/RequestEntryRange|2|s64, Offset}}
{{IPC/RequestEntry|u32, Buffer size}}
{{IPC/MapPointerW|Data buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0028|3|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u32, Actual read size}}
{{IPC/RequestEntry|u32, Version of the NS Data}}
{{IPC/MapPointerW|Data buffer}}
{{IPC/RequestEnd}}

=Description=
Reads the content from the given NS Data ID of the program ID of the current session.

BOSSU:GetNsDataHeaderInfo

2025-02-06T23:01:47Z

DaniElectra: Use IPC template header

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0027|3|2}}
{{IPC/RequestEntry|u32, NS Data ID}}
{{IPC/RequestEntry|u8, [[BOSS_Services#NsDataHeaderInfo|HeaderInfoType]]}}
{{IPC/RequestEntry|u32, Buffer size}}
{{IPC/MapPointerW|Data buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0027|1|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerW|Data buffer}}
{{IPC/RequestEnd}}

=Description=
Gets information from the header of the given NS Data ID of the program ID of the current session.

BOSSU:DeleteNsData

2025-02-06T22:57:17Z

DaniElectra: Use IPC template header

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0026|1|0}}
{{IPC/RequestEntry|u32, NS Data ID}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0026|1|0}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEnd}}

=Description=
Deletes the given NS Data ID from the storage of the program ID of the current session.

BOSSU:GetTaskInfo

2025-02-01T23:24:15Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x0025|2|2}} {{IPC/RequestEntry|u32, Task ID size, including NULL terminator}} {{IPC/RequestEntry|u8,..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0025|2|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|u8, Step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0025|1|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Loads all configuration properties of the given task on the program ID of the current session so that they can be accessed with [[BOSSU:ReceiveProperty]]. This can be used for reconfiguring an existing task and keep all unmodified values the same.

The status properties aren't loaded with this command.

BOSSU:GetTaskError

2025-02-01T22:52:57Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x0024|2|2}} {{IPC/RequestEntry|u32, Task ID size, including NULL terminator}} {{IPC/RequestEntry|u8,..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0024|2|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|u8, Step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0024|2|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u8, Current step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Loads the error of the given task on the program ID of the current session into property ID 0x30, which can be accessed with [[BOSSU:ReceiveProperty]].

BOSSU:GetTaskStatus

2025-02-01T22:43:46Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x0023|3|2}} {{IPC/RequestEntry|u32, Task ID size, including NULL terminator}} {{IPC/RequestEntry|boo..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0023|3|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|bool, Unknown}}
{{IPC/RequestEntry|u8, Step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0023|2|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u8, Current step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Gets the status of the given task on the program ID of the current session. Alongside the current step ID the reponse, more detailed information is loaded into properties which can be accessed with [[BOSSU:ReceiveProperty]].

BOSSU:GetTaskCommErrorCode

2025-02-01T22:38:47Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x0022|1|2}} {{IPC/RequestEntry|u32, Task ID size, including NULL terminator}} {{IPC/MapPointerR|Task..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0022|1|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0022|4|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u32, TaskCommErrorCode}}
{{IPC/RequestEntry|u32, Count}}
{{IPC/RequestEntry|u8, Current step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Gets the communications error code of the given task on the program ID of the current session.

The TaskCommErrorCode represents the HTTP status code received when performing a task.

BOSSU:GetTaskState

2025-02-01T22:02:31Z

DaniElectra:

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0020|2|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|bool, Unknown}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0020|4|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u8, [[BOSS_Services#TaskStatus|TaskStateCode]]}}
{{IPC/RequestEntry|u32, Count}}
{{IPC/RequestEntry|u8, Current step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Gets the state of the given task on the program ID of the current session.

BOSSU:GetTaskResult

2025-02-01T22:02:12Z

DaniElectra: Created page with "=Request= {{IPC/Request}} {{#vardefine:ipc_offset|0}} {{IPC/RequestHeader|0x0021|1|2}} {{IPC/RequestEntry|u32, Task ID size, including NULL terminator}} {{IPC/MapPointerR|Task..."

=Request=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0021|1|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0021|4|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u8, TaskResult}}
{{IPC/RequestEntry|u32, Count}}
{{IPC/RequestEntry|u8, Current step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Gets the result of the given task on the program ID of the current session.

BOSSU:GetTaskState

2025-02-01T21:59:02Z

DaniElectra: Use IPC template header

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x0020|2|2}}
{{IPC/RequestEntry|u32, Task ID size, including NULL terminator}}
{{IPC/RequestEntry|bool, Unknown}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x0020|3|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/RequestEntry|u8, [[BOSS_Services#TaskStatus|TaskStateCode]]}}
{{IPC/RequestEntry|u32, Count}}
{{IPC/RequestEntry|u8, Current step ID}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Gets the state of the given task on the program ID of the current session.

BOSSU:GetTaskFinishHandle

2025-02-01T21:43:57Z

DaniElectra: Use IPC template header

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x001F|0|0}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x001F|1|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/CopyHandle|1}}
{{IPC/CopyHandleEntry|KEvent event}}
{{IPC/RequestEnd}}

=Description=
Returns an event handle for the current session which is signaled when the task currently loaded in the session finishes.

BOSSU:StartTask

2025-02-01T21:35:39Z

DaniElectra:

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x001C|1|2}}
{{IPC/RequestEntry|Task ID size, including NULL terminator}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x001C|1|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Starts the given task on the program ID of the current session.

BOSSU:StartTaskImmediate

2025-02-01T21:35:14Z

DaniElectra:

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x001D|1|2}}
{{IPC/RequestEntry|Task ID size, including NULL terminator}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x001D|1|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Starts the given immediate task on the program ID of the current session. Immediate tasks are those that are configured to run immediately and only once (the count and interval are set to 1).

BOSSU:CancelTask

2025-02-01T21:34:49Z

DaniElectra: Use IPC template header

=Request=
{{IPC/Request}}
{{IPC/RequestHeader|0x001E|1|2}}
{{IPC/RequestEntry|Task ID size, including NULL terminator}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Response=
{{IPC/Request}}
{{#vardefine:ipc_offset|0}}
{{IPC/RequestHeader|0x001E|1|2}}
{{IPC/RequestEntry|Result code}}
{{IPC/MapPointerR|Task ID buffer}}
{{IPC/RequestEnd}}

=Description=
Cancels the given task on the program ID of the current session.