LDN services: Difference between revisions
No edit summary |
|||
(86 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
= ldn:m = | = ldn:m = | ||
This is "nn::ldn::detail::IMonitorServiceCreator". | This is "nn::ldn::detail::IMonitorServiceCreator". | ||
This has IPC max_sessions 5. | |||
[20.2.0+] This has max_sessions 6. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 8: | Line 12: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| 0 || [[#CreateMonitorService]] | | 0 || [[#CreateMonitorService|CreateMonitorService]] | ||
|} | |} | ||
Line 23: | Line 27: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| 0 || [[# | | 0 || [[#GetState|GetState]] | ||
|- | |- | ||
| 1 || [[# | | 1 || [[#GetNetworkInfo|GetNetworkInfo]] | ||
|- | |- | ||
| 2 || [[# | | 2 || [[#GetIpv4Address|GetIpv4Address]] | ||
|- | |- | ||
| 3 || [[# | | 3 || [[#GetDisconnectReason|GetDisconnectReason]] | ||
|- | |- | ||
| 4 || [[# | | 4 || [[#GetSecurityParameter|GetSecurityParameter]] | ||
|- | |- | ||
| 5 || [[# | | 5 || [[#GetNetworkConfig|GetNetworkConfig]] | ||
|- | |- | ||
| 100 || [[# | | 100 || [[#Initialize]] | ||
|- | |- | ||
| 101 || [[# | | 101 || [[#Finalize]] | ||
|} | |} | ||
=== | === GetState === | ||
No input, returns an output u32. | No input, returns an output u32. | ||
sdknso implements this by <code>return</code>ing the u32, with 0 being returned on error. | sdknso implements this by <code>return</code>ing the u32, with 0 being returned on error. | ||
=== | === GetNetworkInfo === | ||
Takes a type-0x1A output buffer containing a [[#NetworkInfo]]. | Takes a type-0x1A output buffer containing a [[#NetworkInfo]]. | ||
=== | === GetIpv4Address === | ||
No input, returns an output [[#Ipv4Address]] and a [[#SubnetMask]]. | No input, returns an output [[#Ipv4Address]] and a [[#SubnetMask]]. | ||
=== | === GetDisconnectReason === | ||
No input, returns an output s16. | No input, returns an output s16. | ||
Line 58: | Line 62: | ||
This just returns 0. | This just returns 0. | ||
=== | === GetSecurityParameter === | ||
No input, returns an output [[#SecurityParameter]]. | No input, returns an output [[#SecurityParameter]]. | ||
This is not exposed by sdknso. | This is not exposed by sdknso. | ||
=== | === GetNetworkConfig === | ||
No input, returns an output [[#NetworkConfig]]. | No input, returns an output [[#NetworkConfig]]. | ||
This is not exposed by sdknso. | This is not exposed by sdknso. | ||
=== | === Initialize === | ||
No input/output. | No input/output. | ||
Line 75: | Line 79: | ||
This just returns 0. | This just returns 0. | ||
=== | === Finalize === | ||
No input/output. | No input/output. | ||
Line 84: | Line 88: | ||
= ldn:s = | = ldn:s = | ||
This is "nn::ldn::detail::ISystemServiceCreator". | This is "nn::ldn::detail::ISystemServiceCreator". | ||
[18.0.0+] The sdknso uses SessionManager with this, where the additional session-count is 0x3. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 89: | Line 95: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| 0 || [[#CreateSystemLocalCommunicationService]] | | 0 || [[#CreateSystemLocalCommunicationService|CreateSystemLocalCommunicationService]] | ||
|- | |- | ||
| 1 || [18.0.0+] [[#CreateClientProcessMonitor]] | | 1 || [18.0.0+] [[#CreateClientProcessMonitor|CreateClientProcessMonitor]] | ||
|} | |} | ||
Line 97: | Line 103: | ||
No input. Returns an [[#ISystemLocalCommunicationService]]. | No input. Returns an [[#ISystemLocalCommunicationService]]. | ||
The user-process closes the ISystemServiceCreator object | The user-process closes the ISystemServiceCreator object once finished with it during initialization. Official sw ignores errors from this cmd. | ||
== CreateClientProcessMonitor == | == CreateClientProcessMonitor == | ||
Line 109: | Line 115: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| 0 || [[#GetState]] | | 0 || [[#GetState_2|GetState]] | ||
|- | |- | ||
| 1 || [[#GetNetworkInfo]] | | 1 || [[#GetNetworkInfo_2|GetNetworkInfo]] | ||
|- | |- | ||
| 2 || [[#GetIpv4Address]] | | 2 || [[#GetIpv4Address_2|GetIpv4Address]] | ||
|- | |- | ||
| 3 || [[#GetDisconnectReason]] | | 3 || [[#GetDisconnectReason_2|GetDisconnectReason]] | ||
|- | |- | ||
| 4 || [[#GetSecurityParameter]] | | 4 || [[#GetSecurityParameter_2|GetSecurityParameter]] | ||
|- | |- | ||
| 5 || [[#GetNetworkConfig]] | | 5 || [[#GetNetworkConfig_2|GetNetworkConfig]] | ||
|- | |- | ||
| 100 || [[# | | 100 || [[#GetStateChangeEvent|GetStateChangeEvent]] | ||
|- | |- | ||
| 101 || [[# | | 101 || [[#GetNetworkInfoAndHistory|GetNetworkInfoAndHistory]] | ||
|- | |- | ||
| 102 || [[#Scan]] | | 102 || [[#Scan|Scan]] | ||
|- | |- | ||
| 103 || [[#ScanPrivate]] | | 103 || [[#ScanPrivate|ScanPrivate]] | ||
|- | |- | ||
| 104 || [5.0.0+] [[# | | 104 || [5.0.0+] [[#SetWirelessControllerPolicy|SetWirelessControllerPolicy]] | ||
|- | |- | ||
| 105 || [13.1.0+] [[# | | 105 || [13.1.0+] [[#SetWirelessAudioPolicy|SetWirelessAudioPolicy]] | ||
|- | |- | ||
| 106 || [18.0.0+] | | 106 || [18.0.0+] [[#SetProtocol|SetProtocol]] | ||
|- | |- | ||
| 200 || [[#OpenAccessPoint]] | | 200 || [[#OpenAccessPoint|OpenAccessPoint]] | ||
|- | |- | ||
| 201 || [[#CloseAccessPoint]] | | 201 || [[#CloseAccessPoint|CloseAccessPoint]] | ||
|- | |- | ||
| 202 || [[#CreateNetwork]] | | 202 || [[#CreateNetwork|CreateNetwork]] | ||
|- | |- | ||
| 203 || [[#CreateNetworkPrivate]] | | 203 || [[#CreateNetworkPrivate|CreateNetworkPrivate]] | ||
|- | |- | ||
| 204 || [[#DestroyNetwork]] | | 204 || [[#DestroyNetwork|DestroyNetwork]] | ||
|- | |- | ||
| 205 || [[#Reject]] | | 205 || [[#Reject|Reject]] | ||
|- | |- | ||
| 206 || [[#SetAdvertiseData]] | | 206 || [[#SetAdvertiseData|SetAdvertiseData]] | ||
|- | |- | ||
| 207 || [[#SetStationAcceptPolicy]] | | 207 || [[#SetStationAcceptPolicy|SetStationAcceptPolicy]] | ||
|- | |- | ||
| 208 || [[#AddAcceptFilterEntry]] | | 208 || [[#AddAcceptFilterEntry|AddAcceptFilterEntry]] | ||
|- | |- | ||
| 209 || [[#ClearAcceptFilter]] | | 209 || [[#ClearAcceptFilter|ClearAcceptFilter]] | ||
|- | |- | ||
| 300 || [[#OpenStation]] | | 300 || [[#OpenStation|OpenStation]] | ||
|- | |- | ||
| 301 || [[#CloseStation]] | | 301 || [[#CloseStation|CloseStation]] | ||
|- | |- | ||
| 302 || [[#Connect]] | | 302 || [[#Connect|Connect]] | ||
|- | |- | ||
| 303 || [[#ConnectPrivate]] | | 303 || [[#ConnectPrivate|ConnectPrivate]] | ||
|- | |- | ||
| 304 || [[#Disconnect]] | | 304 || [[#Disconnect|Disconnect]] | ||
|- | |- | ||
| 400 || [[# | | 400 || [[#Initialize_2|Initialize]] | ||
|- | |- | ||
| 401 || [[# | | 401 || [[#Finalize_2|Finalize]] | ||
|- | |- | ||
| 402 || [4.0.0+] [[#SetOperationMode]] | | 402 || [4.0.0+] [[#SetOperationMode|SetOperationMode]] | ||
|- | |- | ||
| 403 || [7.0.0+] [[# | | 403 || [7.0.0+] [[#InitializeWithVersion|InitializeWithVersion]] | ||
|- | |- | ||
| 404 || [19.0.0+] | | 404 || [19.0.0+] [[#InitializeWithPriority|InitializeWithPriority]] | ||
|- | |- | ||
| 500 || [18.0.0+] EnableActionFrame | | 500 || [18.0.0+] [[#EnableActionFrame|EnableActionFrame]] | ||
|- | |- | ||
| 501 || [18.0.0+] DisableActionFrame | | 501 || [18.0.0+] [[#DisableActionFrame|DisableActionFrame]] | ||
|- | |- | ||
| 502 || [18.0.0+] SendActionFrame | | 502 || [18.0.0+] [[#SendActionFrame|SendActionFrame]] | ||
|- | |- | ||
| 503 || [18.0.0+] RecvActionFrame | | 503 || [18.0.0+] [[#RecvActionFrame|RecvActionFrame]] | ||
|- | |- | ||
| 505 || [18.0.0+] [[#SetHomeChannel|SetHomeChannel]] | | 505 || [18.0.0+] [[#SetHomeChannel|SetHomeChannel]] | ||
|- | |- | ||
| 600 || [18.0.0+] SetTxPower | | 600 || [18.0.0+] [[#SetTxPower|SetTxPower]] | ||
|- | |- | ||
| 601 || [18.0.0+] ResetTxPower | | 601 || [18.0.0+] [[#ResetTxPower|ResetTxPower]] | ||
|} | |} | ||
Line 212: | Line 218: | ||
No input, returns an output [[#NetworkConfig]]. | No input, returns an output [[#NetworkConfig]]. | ||
=== | === GetStateChangeEvent === | ||
No input, returns an output Event handle. | No input, returns an output Event handle. | ||
sdknso uses EventClearMode=1 with this. sdknso will Abort if this cmd fails. | sdknso uses EventClearMode=1 with this. sdknso will Abort if this cmd fails. | ||
This is signaled when the data returned by [[#GetNetworkInfo]]/[[# | This is signaled when the data returned by [[#GetNetworkInfo]]/[[#GetNetworkInfoAndHistory]] is updated. | ||
=== | === GetNetworkInfoAndHistory === | ||
Takes a type-0x1A output buffer containing a [[#NetworkInfo]] and a type-0xA output buffer containing an array of [[#NodeLatestUpdate]]. | Takes a type-0x1A output buffer containing a [[#NetworkInfo]] and a type-0xA output buffer containing an array of [[#NodeLatestUpdate]]. | ||
Line 242: | Line 248: | ||
See [[#Scan]]. | See [[#Scan]]. | ||
=== | === SetWirelessControllerPolicy === | ||
Takes an input [[#WirelessControllerRestriction]], no output. | Takes an input [[#WirelessControllerRestriction]], no output. | ||
Line 249: | Line 255: | ||
The input value is written into state. | The input value is written into state. | ||
=== | === SetWirelessAudioPolicy === | ||
Takes an input [[#BluetoothAudioDeviceConnectableMode]], no output. | Takes an input [[#BluetoothAudioDeviceConnectableMode]], no output. | ||
=== SetProtocol === | |||
Takes an input u32, no output. | |||
This cmd was implemented with [20.0.0+], prior to that this just returned an error. | |||
The sdk user-process func will pass value 1 to the cmd when the input [[#Protocol|Protocol]] is 0/1, 3 is passed directly if specified, otherwise Abort. User-processes use SetProtocol immediately after initializing ldn. | |||
[20.0.0+] The ldn initialization functionality in sdknso also uses this with value 1 (NX) eventually after the init cmd was used successfully. | |||
The input is validated, then a vfunc is called. | |||
The cmd_input must be non-zero. BIT(cmd_input) must be set in a state-field, otherwise a separate Result is returned. | |||
The above state field originates from a ldn:u/ldn:s state field, which on NX is always set to 0xA. Therefore, on NX the above bit check only allows value 1 or 3. | |||
The vfunc sends a message to another thread with the input u32 as the param, and returns the response from that. | |||
The thread msg-queue-handler (besides other validation) uses the input param to select what values to write to state fields. Only input value 1 or 3 is allowed, with an error being thrown otherwise. The previously mentioned validation includes verifying that [[#GetState|State]] is Initialized. | |||
=== OpenAccessPoint === | === OpenAccessPoint === | ||
Line 269: | Line 294: | ||
Unlike CreateNetworkPrivate, this overwrites the channel field in the [[#NetworkConfig]]. When the cached [[SPL_services#IsDevelopment|IsDevelopment]] value is true, the output from [[Settings_services|GetLdnChannel]] will overwrite that field if the s32 setting value is >=0, otherwise the original value is used. Otherwise when the IsDevelopment field is false (retail), the channel is overwritten with value 0. | Unlike CreateNetworkPrivate, this overwrites the channel field in the [[#NetworkConfig]]. When the cached [[SPL_services#IsDevelopment|IsDevelopment]] value is true, the output from [[Settings_services|GetLdnChannel]] will overwrite that field if the s32 setting value is >=0, otherwise the original value is used. Otherwise when the IsDevelopment field is false (retail), the channel is overwritten with value 0. | ||
This overwrites the u16 field at [[#SecurityConfig]]+0. When the cached [[SPL_services#IsDevelopment|IsDevelopment]] value is false (retail), value 1 is used, otherwise the original value is used. | This overwrites the u16 field at [[#SecurityConfig]]+0. When the cached [[SPL_services#IsDevelopment|IsDevelopment]] value is false (retail) ([18.0.0+] [[System_Settings|system-setting]] <code>ldn!enable_static_security_mode_configuration</code> is checked for being true instead), value 1 is used ([18.0.0+] value from [[System_Settings|system-setting]] <code>ldn!static_security_mode</code> is used, with fallback to value 1 if the setting is >=0x4), otherwise the original value is used. | ||
[[#GetState|State]] must be 2, this cmd eventually sets the State to value 3. | [[#GetState|State]] must be 2, this cmd eventually sets the State to value 3. | ||
Line 333: | Line 358: | ||
This is identical to [[#ConnectPrivate]] (besides the below), except the data internally passed for [[#SecurityParameter]]/[[#NetworkConfig]] are loaded from the input [[#NetworkInfo]]. | This is identical to [[#ConnectPrivate]] (besides the below), except the data internally passed for [[#SecurityParameter]]/[[#NetworkConfig]] are loaded from the input [[#NetworkInfo]]. | ||
This overwrites the u16 field at [[#SecurityConfig]]+0. When the cached [[SPL_services#IsDevelopment|IsDevelopment]] value is false (retail), value 1 is used, otherwise the used value is: original_field == 0 ? {u16 [[#NetworkInfo]]+0x60} : original_field. | [1.0.0-?] This overwrites the u16 field at [[#SecurityConfig]]+0. When the cached [[SPL_services#IsDevelopment|IsDevelopment]] value is false (retail), value 1 is used, otherwise the used value is: original_field == 0 ? {u16 [[#NetworkInfo]]+0x60} : original_field. [18.0.0+] This now uses the same SecurityMode override as [[#CreateNetwork|CreateNetwork]]. | ||
u32 LocalCommunicationVersion>>15 must be 0. | u32 LocalCommunicationVersion>>15 must be 0. | ||
Line 342: | Line 367: | ||
See [[#Connect]]. | See [[#Connect]]. | ||
This overwrites the u16 field at [[#SecurityConfig]]+0. When the cached [[SPL_services#IsDevelopment|IsDevelopment]] value is false (retail), value 1 is used, otherwise the original value is used. | [1.0.0-?] This overwrites the u16 field at [[#SecurityConfig]]+0. When the cached [[SPL_services#IsDevelopment|IsDevelopment]] value is false (retail), value 1 is used, otherwise the original value is used. [18.0.0+] This now uses the same SecurityMode override as [[#Connect|Connect]]. | ||
=== Disconnect === | === Disconnect === | ||
Line 349: | Line 374: | ||
[[#GetState|State]] must be 5, this cmd eventually sets the State to value 4. | [[#GetState|State]] must be 5, this cmd eventually sets the State to value 4. | ||
=== | === Initialize === | ||
Takes an input PID and an u64 pid_placeholder. | Takes an input PID and an u64 pid_placeholder. | ||
This is used immediately after object creation. | This is used immediately after object creation. | ||
On old sysvers the cmd impl for User/System are identical, except different params are used for the funcs called internally. | |||
=== | With [7.0.0+] [[#InitializeWithVersion|InitializeWithVersion]] is used instead. The cmd impl for Initialize uses [[#InitializeWithVersion|InitializeWithVersion]] with version=0. | ||
=== Finalize === | |||
No input/output. | No input/output. | ||
Line 372: | Line 399: | ||
The input value is written into state. | The input value is written into state. | ||
=== | === InitializeWithVersion === | ||
Takes an input PID, | Takes an input PID, a s32 version, and an u64 pid_placeholder. | ||
The priority is determined by whether the interface is User/System: System = 0x38, User = 0x5A. | |||
It then calls the init func, with the cmd input params and the above priority, returning the Result on failure. | |||
On newer sysvers this then adds an entry for the state array used by [[#RegisterClient|RegisterClient]]. | |||
Lastly the input PID and version are written into state, then this returns. | |||
The init func does the following: | |||
* The PID must be non-zero, and the version must not be negative. The priority must be 0x5A or 0x38. | |||
* An error is returned if state fields are invalid. | |||
* The input PID and version are written into state (a state field is also set to interface == User). | |||
* Lastly, a vfunc is called with the input priority, returning the Result from that. | |||
The vfunc does the following: | |||
* On newer sysvers, this uses [[Shared_Database_services|pl:s]] RequestApplicationFunctionAuthorizationByProcessId with the input PID and [[Shared_Database_services|ApplicationFunctionAuthorizationId]] = 2 (SecureLdnLocalCommunication), returning the Result on failure. | |||
* Then a message is sent to a msg-queue with the input priority. | |||
The handler for the above message does the following: | |||
* When state is already initialized, runs handling for that. An error is also thrown if the input priority is larger than a state field. | |||
* Initializes state, etc. | |||
* Various [[Network_Interface_services|nifm]] funcs are eventually used. The input priority is used to determine the value for [[Network_Interface_services#CreateRequest|nn::nifm::RequestParameters]]: value 0x4 or value 0x8 is used, depending on priority > 0x59. | |||
** Newer versions also handle ldn lan_emulation [[System_Settings|sys-settings]] here. For the above value, when lan_emulation is enabled it uses value 0x17, with 0x18 additionally used for priority <= 0x59. | |||
* The rest is state init, including setting [[#State|State]] to value 1. Then 0 is returned. | |||
On old sysvers the cmd impl for User/System are identical, except different params are used for the funcs called internally. With newer sysvers the cmd impl is now identical. | |||
Version values passed by official sw: | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Value || SystemVersion | ||
|- | |- | ||
| | | 0x1 || [7.0.0+] | ||
|- | |- | ||
| 0x2 || [18.0.0+] | |||
|- | |- | ||
| | | 0x3 || [19.0.0+] | ||
|- | |- | ||
| | | 0x4 || [20.0.0+] | ||
|} | |} | ||
== | === InitializeWithPriority === | ||
Takes an input PID, a s32 version, a s32 priority, and an u64 pid_placeholder. | |||
This is similar to [[#InitializeWithVersion|InitializeWithVersion]]. The input priority is passed directly to the init func which is called here, instead of determining it from whether the interface is User/System. | |||
Official sw passes input value 0x38 for the priority as the default, when the user doesn't specify the priority. | |||
=== EnableActionFrame === | |||
Takes an input [[#ActionFrameSettings]]. No output. | |||
[[#State|State]] must be Initialized. | |||
=== DisableActionFrame === | |||
No input/output. | |||
[[#State|State]] must be Initialized. | |||
=== SendActionFrame === | |||
Takes a type-0x21 input buffer, two input [[#MacAddress]], two input s16s ('''Band''' and '''ChannelNumber''') and an input [[#MessageFlagSet]]. No output. | |||
[20.0.0+] The input s16s were replaced with a single u16, which has the same format as [[#SetHomeChannel|SetHomeChannel]]. | |||
The first [[#MacAddress]] is the destination, the second [[#MacAddress]] is the Bssid. | |||
The ChannelNumber must be non-zero. | |||
[[#State|State]] must be 3-4 (AccessPointCreated/Station). | |||
=== RecvActionFrame === | |||
Takes a type-0x22 output buffer and an input [[#MessageFlagSet]]. Returns two output [[#MacAddress]], two output s16s ('''Band''' and '''ChannelNumber'''), an output u32 '''Size''', and an output s32 '''LinkLevel'''. | |||
[20.0.0+] The output s16s were replaced with a single u16, which has the same format as [[#SetHomeChannel|SetHomeChannel]]. | |||
[[#EnableActionFrame|EnableActionFrame]] must be used prior to this. | |||
=== SetHomeChannel === | |||
Takes two input s16s '''Band''' and '''ChannelNumber'''. No output. | |||
[20.0.0+] Now takes an input u16 instead of two s16s, merging the two params. Bitmask 0x3FF (low 10-bits) is the ChannelNumber, while the remaining upper 6-bits is the Band. The Band is used as an array index to load the actual Band for passing to a func. Only the following Band input is valid, others return 0x0/0xFFFF: 2 - > 2400, 5 -> 5000, 6 -> 6000. | |||
On NX Band must be ([20.0.0+] converted Band from the above array) 50 ([20.0.0+] 5000) or 24 ([20.0.0+] 2400). | |||
The ChannelNumber must be non-zero. | |||
The [[#State|State]] must be Station. | |||
sdknso uses the input channel to convert to the input needed by the cmd. | |||
=== SetTxPower === | |||
Takes an input s16 '''Power'''. No output. | |||
|- | The input must be 0x0..0xFF. | ||
A state field must be non-zero. | |||
The [[#State|State]] must be 2-5 (AccessPoint*/Station*). | |||
=== ResetTxPower === | |||
No input/output. | |||
The same state field checked by [[#SetTxPower|SetTxPower]] must be non-zero. The [[#State|State]] check is also the same as [[#SetTxPower|SetTxPower]]. | |||
== IClientProcessMonitor == | |||
This is "nn::ldn::detail::IClientProcessMonitor". | |||
This was added with [18.0.0+]. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
| | ! Cmd || Name | ||
|- | |- | ||
| | | 0 || RegisterClient | ||
|} | |||
|- | === RegisterClient === | ||
| | Takes an input PID and an u64 pid_placeholder. | ||
|- | |||
| | [18.0.0+] [[#CreateClientProcessMonitor|CreateClientProcessMonitor]] and RegisterClient are used by sdknso at the end of the ldn initialization functionality. | ||
|- | |||
| | If the objptr in IClientProcessMonitor state is already set from using this cmd previously, this just returns 0. | ||
| | |||
This goes through global state to locate an entry with a matching PID, if none found 0 is returned. The objptr from the state entry is loaded, if NULL this returns 0. This obj is then incref'd and written into the IClientProcessMonitor state. When PID is 0, 0 is returned. It then locates the above state entry again with a matching PID, clearing the entry which matches. Lastly 0 is returned. | |||
The initialization [[#InitializeWithPriority|cmds]] adds an entry to the above global state. | |||
= ldn:u = | |||
This is "nn::ldn::detail::IUserServiceCreator". | |||
[18.0.0+] The sdknso uses SessionManager with this, where the additional session-count is 0x3. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Cmd || Name | |||
|- | |||
| 0 || [[#CreateUserLocalCommunicationService|CreateUserLocalCommunicationService]] | |||
|- | |||
| 1 || [18.0.0+] [[#CreateClientProcessMonitor|CreateClientProcessMonitor]] | |||
|} | |||
== CreateUserLocalCommunicationService== | |||
Returns an [[#IUserLocalCommunicationService]]. | |||
The user-process closes the IUserServiceCreator object once finished with it during initialization. Official sw ignores errors from this cmd. | |||
== IUserLocalCommunicationService == | |||
This is "nn::ldn::detail::IUserLocalCommunicationService". | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
| | ! Cmd || Name | ||
|- | |- | ||
| | | 0 || [[#GetState_2|GetState]] | ||
|- | |- | ||
| | | 1 || [[#GetNetworkInfo_2|GetNetworkInfo]] | ||
|- | |- | ||
| | | 2 || [[#GetIpv4Address_2|GetIpv4Address]] | ||
|- | |- | ||
| | | 3 || [[#GetDisconnectReason_2|GetDisconnectReason]] | ||
|- | |- | ||
| | | 4 || [[#GetSecurityParameter_2|GetSecurityParameter]] | ||
|- | |- | ||
| | | 5 || [[#GetNetworkConfig_2|GetNetworkConfig]] | ||
|- | |- | ||
| | | 100 || [[#GetStateChangeEvent|GetStateChangeEvent]] | ||
|- | |- | ||
| | | 101 || [[#GetNetworkInfoAndHistory|GetNetworkInfoAndHistory]] | ||
|- | |- | ||
| | | 102 || [[#Scan|Scan]] | ||
|- | |- | ||
| | | 103 || [[#ScanPrivate|ScanPrivate]] | ||
|- | |- | ||
| | | 104 || [5.0.0+] [[#SetWirelessControllerPolicy|SetWirelessControllerPolicy]] | ||
|- | |- | ||
| | | 105 || [13.1.0+] [[#SetWirelessAudioPolicy|SetWirelessAudioPolicy]] | ||
|- | |- | ||
| | | 106 || [18.0.0+] [[#SetProtocol|SetProtocol]] | ||
|- | |- | ||
| | | 200 || [[#OpenAccessPoint|OpenAccessPoint]] | ||
|- | |- | ||
| | | 201 || [[#CloseAccessPoint|CloseAccessPoint]] | ||
|- | |- | ||
| | | 202 || [[#CreateNetwork|CreateNetwork]] | ||
|- | |- | ||
| 203 || [[#CreateNetworkPrivate|CreateNetworkPrivate]] | |||
|- | |- | ||
| | | 204 || [[#DestroyNetwork|DestroyNetwork]] | ||
|- | |- | ||
| | | 205 || [[#Reject|Reject]] | ||
|- | |- | ||
| | | 206 || [[#SetAdvertiseData|SetAdvertiseData]] | ||
|- | |- | ||
| | | 207 || [[#SetStationAcceptPolicy|SetStationAcceptPolicy]] | ||
|- | |- | ||
| | | 208 || [[#AddAcceptFilterEntry|AddAcceptFilterEntry]] | ||
|- | |- | ||
| | | 209 || [[#ClearAcceptFilter|ClearAcceptFilter]] | ||
|- | |- | ||
| | | 300 || [[#OpenStation|OpenStation]] | ||
|- | |- | ||
| | | 301 || [[#CloseStation|CloseStation]] | ||
|- | |- | ||
| | | 302 || [[#Connect|Connect]] | ||
|- | |- | ||
| | | 303 || [[#ConnectPrivate|ConnectPrivate]] | ||
| | |||
|- | |- | ||
| | | 304 || [[#Disconnect|Disconnect]] | ||
|- | |- | ||
| | | 400 || [[#Initialize_2|Initialize]] | ||
|- | |- | ||
| | | 401 || [[#Finalize_2|Finalize]] | ||
|- | |- | ||
| | | 402 || [7.0.0+] [[#InitializeWithVersion|InitializeWithVersion]] | ||
|- | |- | ||
| | | 403 || [19.0.0+] [[#SetOperationMode|SetOperationMode]] | ||
|- | |- | ||
| | | 500 || [18.0.0+] [[#EnableActionFrame|EnableActionFrame]] | ||
|- | |- | ||
| | | 501 || [18.0.0+] [[#DisableActionFrame|DisableActionFrame]] | ||
|- | |- | ||
| 18 | | | 502 || [18.0.0+] [[#SendActionFrame|SendActionFrame]] | ||
|- | |- | ||
| | | 503 || [18.0.0+] [[#RecvActionFrame|RecvActionFrame]] | ||
|- | |- | ||
| | | 505 || [18.0.0+] [[#SetHomeChannel|SetHomeChannel]] | ||
|- | |- | ||
| | | 600 || [18.0.0+] [[#SetTxPower|SetTxPower]] | ||
|- | |- | ||
| | | 601 || [18.0.0+] [[#ResetTxPower|ResetTxPower]] | ||
| | |} | ||
| | |||
= ndd = | |||
This is "nn::ndd::IService". | |||
This was added with [5.0.0] and removed with [6.0.0]. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 606: | Line 643: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| 0 || | | 0 || EnableAutoCommunication | ||
|- | |||
| 1 || DisableAutoCommunication | |||
|- | |- | ||
| | | 2 || IsAutoCommunicationEnabled | ||
| | |- | ||
| 3 || EnablePowerSave | |||
|- | |||
| 4 || DisablePowerSave | |||
|- | |- | ||
| 5 || IsPowerSaveEnabled | |||
|- | |- | ||
| | | 6 || IsNetworkActive | ||
|- | |- | ||
| | | 7 || AcquireSendDataUpdateEvent | ||
|- | |- | ||
| | | 8 || AddSendData | ||
|- | |- | ||
| | | 9 || ClearSendData | ||
|- | |- | ||
| | | 10 || GetSendData | ||
|- | |- | ||
| | | 11 || AcquireReceiveDataEvent | ||
|- | |- | ||
| | | 12 || GetCurrentReceiveDataCounter | ||
|- | |- | ||
| | | 13 || GetOldestReceiveDataCounter | ||
|- | |- | ||
| | | 14 || GetNextReceiveDataCounter | ||
|- | |- | ||
| | | 15 || GetAvailableReceiveDataCount | ||
|- | |- | ||
| | | 16 || GetRecentReceiveDataCounter | ||
|- | |- | ||
| | | 17 || GetReceiveData | ||
|- | |- | ||
| | | 18 || AddReceiveData | ||
|- | |- | ||
| | | 19 || ClearReceiveData | ||
|- | |- | ||
| | | 20 || ClearDataIdFilter | ||
|- | |- | ||
| | | 21 || AcquireDeviceScanEvent | ||
|- | |||
| 22 || StartDeviceScan | |||
|- | |- | ||
| | | 23 || CancelDeviceScan | ||
|- | |- | ||
| | | 24 || GetDeviceScanResult | ||
|} | |} | ||
= | = lp2p:app, lp2p:sys = | ||
These are "nn::lp2p::detail::ISfServiceCreator". | |||
These were added with [9.0.0+]. | |||
lp2p:app is used by [[Mario Kart Live: Home Circuit]]. lp2p:sys is used by [[Album_Applet|LibraryAppletPhotoViewer]] with [11.0.0+]. | |||
== | {| class="wikitable" border="1" | ||
|- | |||
! Cmd || Name | |||
|- | |||
| 0 || [[#CreateNetworkService|CreateNetworkService]] | |||
|- | |||
| 8 || [[#CreateNetworkServiceMonitor|CreateNetworkServiceMonitor]] | |||
|} | |||
== | == CreateNetworkService == | ||
Takes a | Takes a PID-descriptor, a reserved input u64 and an input u32. Returns an output [[#ISfService]]. | ||
The input u32 must be value 0x1. | |||
== CreateNetworkServiceMonitor == | |||
Takes a PID-descriptor and a reserved input u64. Returns an output [[#ISfServiceMonitor]]. | |||
== | == ISfService == | ||
This is "nn::lp2p::detail::ISfService". | |||
{| class="wikitable" border="1" | |||
|- | |||
! Cmd || Name | |||
|- | |||
| 0 || [[#Initialize_4|Initialize]] | |||
|- | |||
| 256 || [9.0.0-9.0.1] [[#AttachNetworkInterfaceStateChangeEvent|AttachNetworkInterfaceStateChangeEvent]] | |||
|- | |||
| 264 || [9.0.0-9.0.1] [[#GetNetworkInterfaceLastError|GetNetworkInterfaceLastError]] | |||
|- | |||
| 272 || [9.0.0-9.0.1] [[#GetRole|GetRole]] | |||
|- | |||
| 280 || [9.0.0-9.0.1] [[#GetAdvertiseData|GetAdvertiseData]] | |||
|- | |||
| 288 || [9.0.0-9.0.1] [[#GetGroupInfo|GetGroupInfo]] | |||
|- | |||
| 296 || [9.0.0-9.0.1] [[#GetGroupInfo2|GetGroupInfo2]] | |||
|- | |||
| 304 || [9.0.0-9.0.1] [[#GetGroupOwner|GetGroupOwner]] | |||
|- | |||
| 312 || [9.0.0-9.0.1] [[#GetIpConfig|GetIpConfig]] | |||
|- | |||
| 320 || [9.0.0-9.0.1] [[#GetLinkLevel|GetLinkLevel]] | |||
|- | |||
| 512 || [[#Scan_2|Scan]] | |||
|- | |||
| 768 || [[#CreateGroup|CreateGroup]] | |||
|- | |||
| 776 || [[#DestroyGroup|DestroyGroup]] | |||
|- | |||
| 784 || [[#SetAdvertiseData|SetAdvertiseData]] | |||
|- | |||
| 1536 || [[#SendToOtherGroup|SendToOtherGroup]] | |||
|- | |||
| 1544 || [[#RecvFromOtherGroup|RecvFromOtherGroup]] | |||
|- | |||
| 1552 || [[#AddAcceptableGroupId|AddAcceptableGroupId]] | |||
|- | |||
| 1560 || [9.1.0+] [[#ClearAcceptableGroupId|ClearAcceptableGroupId]] | |||
|} | |||
=== Initialize === | |||
No input/output. | |||
Returns 0. | |||
Unused by official sw. | |||
=== Scan === | |||
Takes a type-0x19 input buffer containing a [[#GroupInfo]] and a type-0x22 output buffer containing an array of [[#ScanResult]]. Returns an output s32 '''TotalOut'''. | |||
=== CreateGroup === | |||
Takes a type-0x31 input buffer containing a [[#GroupInfo]]. No output. | |||
[[Mario Kart Live: Home Circuit|mklive]] uses the following string with this: "Failed to create a group: %08X". | |||
The [[#GetRole|role]] must be 0. This eventually sets the [[#GetRole|role]] to value 1. | |||
=== DestroyGroup === | |||
No input/output. | |||
This destroys the previously [[#CreateGroup|created]] group. If no group was previously created ([[#GetRole|role]] is not 1), this just returns 0. | |||
=== SetAdvertiseData === | |||
Takes a type-0x21 input buffer. No output. | |||
The buffer size must be <=0x80. The [[#GetRole|role]] must be <=1. | |||
A string in [[Mario Kart Live: Home Circuit|mklive]] refers to the buffer data as "scan advertise data". | |||
=== SendToOtherGroup === | |||
Takes an input [[#MacAddress_2|MacAddress]], a [[#GroupId]], a s16 '''Frequency''', a s16 '''Channel''', an u32 '''MessageFlag''' and a type-0x21 input buffer. No output. | |||
The buffer size must be <=0x400. | |||
=== | The MacAddress must be non-zero. The s16s must be >=1. | ||
Only bit0 is used from flags: clear = block until the data can be sent, set = return error when the data can't be sent. | |||
A string in [[Mario Kart Live: Home Circuit|mklive]] refers to the buffer data as "Action frame". | |||
The [[#GetRole|role]] must be non-zero. The error from [[#GetNetworkInterfaceLastError]] will be returned if it's set. | |||
[11.0.0+] [[#GroupInfo]]+0x8A must be value 2, otherwise an error is returned. | |||
This sends an Action frame to the specified [[#GroupId]], with the specified destination [[#MacAddress_2|MacAddress]] (can be a broadcast address). | |||
The frequency param is the same as the [[#GroupInfo]]+0x84 field. | |||
=== RecvFromOtherGroup === | |||
Takes an input u32 '''MessageFlag''' and a type-0x22 output buffer. Returns a [[#MacAddress_2|MacAddress]], an u16 '''Frequency''', a s16 '''Channel''', an u32 '''OutSize''' and a s32. | |||
The OutSize is the original size used for copying to the output buffer, before it's clamped to the output-buffer size. | |||
Only bit0 is used from MessageFlag: clear = block until data is available, set = return error when data is not available. | |||
When data is not available, the error from [[#GetNetworkInterfaceLastError]] will be returned if it's set. | |||
The [[#GetRole|role]] must be non-zero. | |||
This receives an Action frame. | |||
=== AddAcceptableGroupId === | |||
|- | Takes an input [[#GroupId]]. No output. | ||
| | |||
=== ClearAcceptableGroupId === | |||
No input/output. | |||
== ISfServiceMonitor == | |||
This is "nn::lp2p::detail::ISfServiceMonitor". | |||
This interface has no commands, until [9.1.0+] which added actual commands. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Cmd || Name | |||
|- | |- | ||
| | | 0 || [[#Initialize_5|Initialize]] | ||
|- | |- | ||
| | | 256 || [[#AttachNetworkInterfaceStateChangeEvent|AttachNetworkInterfaceStateChangeEvent]] | ||
|- | |- | ||
| | | 264 || [[#GetNetworkInterfaceLastError|GetNetworkInterfaceLastError]] | ||
|- | |- | ||
| | | 272 || [[#GetRole|GetRole]] | ||
|- | |- | ||
| | | 280 || [[#GetAdvertiseData|GetAdvertiseData]] | ||
|- | |- | ||
| | | 281 || [[#GetAdvertiseData2|GetAdvertiseData2]] | ||
|- | |- | ||
| | | 288 || [[#GetGroupInfo|GetGroupInfo]] | ||
|- | |- | ||
| 336 || [[#GetMembers]] | | 296 || [[#GetGroupInfo2|GetGroupInfo2]] | ||
|} | |- | ||
| 304 || [[#GetGroupOwner|GetGroupOwner]] | |||
|- | |||
| 312 || [[#GetIpConfig|GetIpConfig]] | |||
|- | |||
| 320 || [[#GetLinkLevel|GetLinkLevel]] | |||
|- | |||
| 328 || [[#AttachJoinEvent|AttachJoinEvent]] | |||
|- | |||
| 336 || [[#GetMembers|GetMembers]] | |||
|} | |||
=== Initialize === | === Initialize === | ||
Line 834: | Line 933: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| 0 || [[#CreateMonitorService]] | | 0 || [[#CreateMonitorService|CreateMonitorService]] | ||
|} | |} | ||
Line 847: | Line 946: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| 0 || [[# | | 0 || [[#Initialize_6|Initialize]] | ||
|- | |- | ||
| 288 || [[#GetGroupInfo]] | | 288 || [[#GetGroupInfo|GetGroupInfo]] | ||
|- | |- | ||
| 320 || [[#GetLinkLevel]] | | 320 || [[#GetLinkLevel|GetLinkLevel]] | ||
|} | |} | ||
Line 878: | Line 977: | ||
|- | |- | ||
| 6 || Error | | 6 || Error | ||
|} | |} | ||
Line 909: | Line 1,007: | ||
|} | |} | ||
= | = MacAddress = | ||
This is "nn::ldn:: | This is "nn::ldn::MacAddress". This is a 6-byte struct with 1-byte alignment. | ||
= NodeInfo = | |||
This is "nn::ldn::NodeInfo". | |||
The | The first node in the nodes array is always the AccessPoint (NodeId 0x0). NodeId is the index of the node in the nodes array. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 920: | Line 1,021: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || | | 0x0 || 0x4 || [[#Ipv4Address|Ipv4Address]] | ||
|- | |- | ||
| | | 0x4 || 0x6 || [[#MacAddress|MacAddress]] | ||
|- | |- | ||
| 0xA || | | 0xA || 0x1 || NodeId | ||
|- | |- | ||
| | | 0xB || 0x1 || IsConnected | ||
|- | |- | ||
| | | 0xC || 0x21 || UserName | ||
|- | |- | ||
| | | 0x2D || 0x1 || [19.0.0+] Platform? (0 = NX, 1 = Ounce) | ||
|- | |- | ||
| | | 0x2E || 0x2 || LocalCommunicationVersion | ||
|- | |- | ||
| | | 0x30 || 0x10 || Reserved | ||
| | |} | ||
= NodeLatestUpdate = | |||
This is "nn::ldn::NodeLatestUpdate". This is a 0x8-byte struct. | |||
| | {| class="wikitable" border="1" | ||
|- | |- | ||
! Offset | |||
! Size | |||
! Description | |||
|- | |- | ||
| | | 0x0 || 0x1 || StateChange | ||
|- | |- | ||
| | | 0x1 || 0x7 || Reserved | ||
|} | |} | ||
= | = IntentId = | ||
This is "nn::ldn:: | This is "nn::ldn::IntentId". | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 980: | Line 1,061: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || 0x8 | | | 0x0 || 0x8 || LocalCommunicationId | ||
|- | |- | ||
| 0x8 || 0x2 || | | 0x8 || 0x2 || Reserved | ||
|- | |- | ||
| 0xA || 0x2 || | | 0xA || 0x2 || SceneId | ||
|- | |- | ||
| 0xC || 0x4 || | | 0xC || 0x4 || Reserved | ||
| | |} | ||
| | |||
* LocalCommunicationId: [[#CreateNetwork|CreateNetwork]], [[#CreateNetworkPrivate|CreateNetworkPrivate]], [[#Connect|Connect]], [[#ConnectPrivate|ConnectPrivate]] (also [[#ScanFilter|ScanFilter]] when enabled with the flag): When -1, this is overwritten with the first LocalCommunicationId from the user-process [[NACP]], if loading fails value 0 is written instead. Otherwise when not -1, if [[NACP]] loading is successful, this field must match one of the LocalCommunicationIds from there. | |||
* SceneId: Arbitrary user data, this can be used for filtering with [[#ScanFilter|ScanFilter]] for example. | |||
= SessionId = | |||
This is "nn::ldn::SessionId". | |||
This is used to generate/overwrite the Ssid when needed. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
! Offset | |||
! Size | |||
! Description | |||
|- | |- | ||
| | | 0x0 || 0x10 || Random | ||
|} | |} | ||
= | = NetworkId = | ||
This is "nn::ldn:: | This is "nn::ldn::NetworkId". This is a 0x20-byte struct. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Offset | ||
! | ! Size | ||
! Description | |||
|- | |- | ||
| 0x0 || | | 0x0 || 0x10 || [[#IntentId|IntentId]] | ||
|- | |- | ||
| | | 0x10 || 0x10 || [[#SessionId|SessionId]] | ||
|} | |||
= CommonNetworkInfo = | |||
This is "nn::ldn::CommonNetworkInfo". This is a 0x30-byte struct. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
! Offset | |||
! Size | |||
! Description | |||
|- | |- | ||
| | | 0x0 || 0x6 || [[#MacAddress|Bssid]] | ||
|- | |- | ||
| | | 0x6 || 0x22 || [[#Ssid|Ssid]] | ||
|- | |- | ||
| | | 0x28 || 0x2 || Channel | ||
| | |||
| | |||
|- | |- | ||
| | | 0x2A || 0x1 || LinkLevel | ||
|- | |- | ||
| | | 0x2B || 0x1 || NetworkType | ||
|- | |- | ||
| | | 0x2C || 0x4 || Reserved | ||
|} | |} | ||
= | = LdnNetworkInfo = | ||
This is "nn::ldn:: | This is "nn::ldn::LdnNetworkInfo". This is a 0x430-byte struct. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,041: | Line 1,132: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || | | 0x0 || 0x10 || ServerRandom | ||
|- | |- | ||
| | | 0x10 || 0x2 || SecurityMode | ||
|- | |- | ||
| | | 0x12 || 0x1 || StationAcceptPolicy | ||
|- | |- | ||
| | | 0x13 || 0x1 || Version | ||
|- | |- | ||
| | | 0x14 || 0x2 || Reserved | ||
|- | |- | ||
| | | 0x16 || 0x1 || NodeCountMax | ||
|- | |- | ||
| | | 0x17 || 0x1 || NodeCount | ||
|- | |- | ||
| | | 0x18 || 0x200 (0x40 * 8) || [[#NodeInfo|Nodes]] | ||
|- | |- | ||
| | | 0x218 || 0x2 || Reserved | ||
|- | |||
| 0x21A || 0x2 || AdvertiseDataSize | |||
|- | |||
| 0x21C || 0x180 || AdvertiseData | |||
|- | |||
| 0x39C || 0x8C || Reserved | |||
|- | |||
| 0x428 || 0x8 || [6.0.0-?] Challenge (set to the output from [[ETicket_services|es]] cmd1501 during network creation) ([?+] only used internally, not exposed in LdnNetworkInfo anymore) | |||
|} | |} | ||
= | = NetworkInfo = | ||
This is "nn::ldn:: | This is "nn::ldn::NetworkInfo". This is a 0x480-byte struct. | ||
The fields listed as Reserved (besides the fields before +0x10) are cleared during the memset and are not written to again afterwards, with cmds which return NetworkInfo. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,069: | Line 1,170: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || | | 0x0 || 0x20 || [[#NetworkId|NetworkId]] | ||
|- | |- | ||
| | | 0x20 || 0x30 || [[#CommonNetworkInfo|Common]] | ||
|- | |||
| 0x50 || 0x430 || [[#LdnNetworkInfo|Ldn]] | |||
|} | |} | ||
= | = ScanFilter = | ||
This is "nn::ldn:: | This is "nn::ldn::ScanFilter". This is a 0x60-byte struct with 8-byte alignment. | ||
sdknso copies the input ScanFilter to a tmp struct on stack (with [[#ScanFilterFlag|Flag]] masking), which is then used with the cmd. sdknso only copies Bssid with [[#ScanPrivate|ScanPrivate]], with [[#Scan|Scan]] it also masks out the [[#ScanFilterFlag|Flag]] for Bssid. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Offset | ||
! | ! Size | ||
! Description | |||
|- | |||
| 0x0 || 0x20 || [[#NetworkId|NetworkId]] | |||
|- | |||
| 0x20 || 0x4 || NetworkType | |||
|- | |||
| 0x24 || 0x6 || [[#MacAddress|Bssid]] | |||
|- | |||
| 0x2A || 0x22 || [[#Ssid|Ssid]] | |||
|- | |- | ||
| | | 0x4C || 0x10 || Reserved | ||
|- | |- | ||
| | | 0x5C || 0x4 || [[#ScanFilterFlag|Flag]] | ||
|} | |} | ||
= | Each [[#ScanFilterFlag|Flag]] bit when set enables using the corresponding ScanFilter data. This is usually a compare with the ScanFilter data and the internal [[#NetworkInfo|NetworkInfo]] data. | ||
This is "nn::ldn:: | |||
* NetworkType: (ScanFilter_NetworkType & NetworkInfo_NetworkType) must be non-zero. | |||
* Ssid: The length fields must match, then memcmp is used. | |||
The filtering func also handles validating the Band/Channel, however these fields are internal only and are not exposed in the user ScanFilter. | |||
= ScanFilterFlag = | |||
This is "nn::ldn::ScanFilterFlag". | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,097: | Line 1,216: | ||
! Description | ! Description | ||
|- | |- | ||
| | | 0x0 || None | ||
|- | |- | ||
| | | 0x1 || LocalCommunicationId | ||
| | |- | ||
| 0x2 || SessionId | |||
|- | |||
| 0x4 || NetworkType | |||
|- | |||
| 0x8 || Bssid | |||
|- | |- | ||
| 0x10 || Ssid | |||
|- | |- | ||
| | | 0x20 || SceneId | ||
|- | |- | ||
| | | 0x21 || IntentId | ||
|- | |- | ||
| | | 0x23 || NetworkId | ||
|- | |- | ||
| | | 0x3F || All | ||
|} | |} | ||
= | = NetworkConfig = | ||
This is "nn::ldn:: | This is "nn::ldn::NetworkConfig". This is a 0x20-byte struct with 8-byte alignment. | ||
sdknso copies the input NetworkConfig to a tmp struct on stack, which is then used with the cmd ([[#CreateNetwork]], [[#CreateNetworkPrivate]], [[#ConnectPrivate]]). | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,128: | Line 1,248: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || | | 0x0 || 0x10 || [[#IntentId|IntentId]] | ||
|- | |||
| 0x10 || 0x2 || Channel | |||
|- | |||
| 0x12 || 0x1 || NodeCountMax | |||
|- | |||
| 0x13 || 0x1 || Reserved | |||
|- | |- | ||
| | | 0x14 || 0x2 || LocalCommunicationVersion | ||
|- | |- | ||
| | | 0x16 || 0xA || Reserved | ||
|} | |} | ||
= WirelessControllerRestriction = | |||
This is "nn::ldn::WirelessControllerRestriction". This is an u32 enum. | |||
This is used to determine the value passed to [[BTM_services|btm]] SetWlanMode. | |||
This is | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Value | ||
! Description | |||
! Description | |||
|- | |- | ||
| | | 0 || Disabled | ||
|- | |- | ||
| | | 1 || Enabled | ||
|} | |} | ||
= | = WirelessAudioRestriction = | ||
This is "nn::ldn:: | This is "nn::ldn::WirelessAudioRestriction". This is an u32 enum. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Value | ||
! | ! Description | ||
|- | |||
| 0 || Disabled | |||
|- | |- | ||
| | | 1 || Enabled | ||
|} | |} | ||
= | = SecurityMode = | ||
This is "nn::ldn:: | This is "nn::ldn::SecurityMode". This is an u32 enum. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Value | ||
! | ! Description | ||
|- | |||
| 0 || Any | |||
|- | |- | ||
| | | 1 || Product | ||
|- | |- | ||
| | | 2 || Debug | ||
|} | |- | ||
| 3 || SystemDebug | |||
= | |} | ||
This is "nn::ldn:: | |||
Value: | |||
* 1-2: Broadcast Action frame data is encrypted. | |||
* 3: Broadcast Action frame data is plaintext. | |||
* 1: Data frames are encrypted. | |||
* 2-3: Data frames for normal data-transfer are plaintext - the network is Open. | |||
= SecurityConfig = | |||
This is "nn::ldn::SecurityConfig". This is a 0x44-byte struct with 2-byte alignment. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,193: | Line 1,322: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || | | 0x0 || 0x2 || [[#SecurityMode|SecurityMode]] (overwritten by [[#CreateNetwork]]/[[#CreateNetworkPrivate]] and [[#Connect]]/[[#ConnectPrivate]], the value used internally by these cmds must be 1-3) | ||
|- | |- | ||
| | | 0x2 || 0x2 || PassphraseSize (must be 0x10-0x40) | ||
|- | |- | ||
| | | 0x4 || 0x40 || Passphrase (used with key derivation) | ||
|} | |} | ||
= | = SecurityParameter = | ||
This is "nn::ldn:: | This is "nn::ldn::SecurityParameter". This is a 0x20-byte struct with 1-byte alignment. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Offset | ||
! | ! Size | ||
! Description | |||
|- | |- | ||
| | | 0x0 || 0x10 || ServerRandom (used with the same key derivation as [[#SecurityConfig]]) | ||
|- | |- | ||
| | | 0x10 || 0x10 || [[#SessionId|SessionId]] | ||
| | |||
| | |||
|} | |} | ||
= | = UserConfig = | ||
This is "nn::ldn:: | This is "nn::ldn::UserConfig". This is a 0x30-byte struct with 1-byte alignment. | ||
sdknso copies the input UserConfig to a tmp struct on stack, which is then used with the cmd. Only the first 0x20-bytes are copied, with the rest cleared. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,231: | Line 1,354: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || | | 0x0 || 0x21 || UserName (NUL-terminated string for the user name) | ||
|- | |- | ||
| | | 0x21 || 0xF || Reserved | ||
|} | |||
= AddressEntry = | |||
This is "nn::ldn::AddressEntry". This is a 0xC-byte struct. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
| 0xA || | ! Offset | ||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x4 || [[#Ipv4Address]] | |||
|- | |||
| 0x4 || 0x6 || [[#MacAddress|MacAddress]] | |||
|- | |||
| 0xA || 0x2 || Reserved | |||
|} | |||
= AcceptPolicy = | |||
This is "nn::ldn::AcceptPolicy". This is an u8. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
! Value | |||
! Description | |||
|- | |- | ||
| | | 0 || AlwaysAccept | ||
|- | |- | ||
| | | 1 || AlwaysReject | ||
|- | |- | ||
| | | 2 || BlackList (addresses in the [[#AddAcceptFilterEntry|list]] are not allowed) | ||
|- | |- | ||
| | | 3 || WhiteList (only addresses in the [[#AddAcceptFilterEntry|list]] are allowed) | ||
|} | |} | ||
Line 1,299: | Line 1,443: | ||
|} | |} | ||
= | = Protocol = | ||
This is "nn:: | This is "nn::ldn::Protocol". This is an u32 enum. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Value | ||
! | ! Description | ||
|- | |||
| 0 || Default | |||
|- | |- | ||
| | | 1 || NX | ||
|- | |- | ||
| | | 3 || (NXAndOunce?) | ||
|} | |} | ||
The Initialize* cmds configure state the same as using [[#SetProtocol|SetProtocol]] with Protocol NX. | |||
[[ | There's presumably a S2-only value which enables using Ounce-only keys. Attempting to decrypt Ounce-only ldn with the Protocol3 keys fails (including with [[#Scan|Scan]]/[[#ScanPrivate|ScanPrivate]]), with the following (with S2 hosting): | ||
* In-game ldn-usage for a S2-only Application. | |||
* Local-game-update with a S2-only Application. | |||
* Local-game-update for a S1-game which has a Nintendo Switch 2 Edition available, even without the S2-Edition being installed. | |||
= ActionFrameSettings = | |||
This is "nn::ldn::ActionFrameSettings". This is a 0x80-byte struct. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,334: | Line 1,474: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || | | 0x0 || 0x8 || LocalCommunicationId | ||
|- | |- | ||
| | | 0x8 || 0x34 || Reserved | ||
|- | |- | ||
| | | 0x3C || 0x2 || SecurityMode | ||
|- | |- | ||
| | | 0x3E || 0x2 || PassphraseSize (Must be 0x10-0x40) | ||
|- | |- | ||
| | | 0x40 || 0x40 || Passphrase | ||
|} | |||
SecurityMode must be 1-2. The same SecurityMode override functionality from elsewhere is used later with this. | |||
The same LocalCommunicationId override/validation from elsewhere is used with the input as well. | |||
= MessageFlagSet = | |||
This is "nn::ldn::MessageFlagSet". This is a BitFlagSet object for [[#MessageFlag]]. | |||
= MessageFlag = | |||
This is "nn::ldn::MessageFlag". | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
! Value | |||
! Description | |||
|- | |- | ||
| | | 0 || | ||
|} | |||
[[#SendActionFrame|SendActionFrame]]/[[#RecvActionFrame|RecvActionFrame]] handles bit0 the same way as the MessageFlag with lp2p [[#SendToOtherGroup|SendToOtherGroup]]/[[#RecvFromOtherGroup|RecvFromOtherGroup]]. | |||
= MacAddress = | |||
This is "nn::lp2p::MacAddress". Same as [[#MacAddress|MacAddress]]. | |||
= GroupId = | |||
This is "nn::lp2p::GroupId". This is a 6-byte struct with 1-byte alignment. | |||
This is a WiFi BSSID. | |||
= NodeInfo = | |||
This is "nn::lp2p::NodeInfo". This is a 0x80-byte struct. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
! Offset | |||
! Size | |||
! Description | |||
|- | |- | ||
| | | 0x0 || || <code>struct sockaddr</code> for the IP address. | ||
|- | |- | ||
| | | 0x24 || 0x6 || [[#MacAddress_2|MacAddress]] | ||
|} | |||
= GroupInfo = | |||
This is "nn::lp2p::GroupInfo". This is a 0x200-byte struct. | |||
[[Mario Kart Live: Home Circuit|mklive]] sets the SSID to a string generated from random data. | |||
[[#Scan_2|Scan]] only uses the following fields for the cmd input struct: SupportedPlatform/Priority, Frequency/Channel, and PresharedKeyBinarySize/PresharedKey. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
! Offset | |||
! Size | |||
! Description | |||
|- | |- | ||
| 0x88 || 0x1 || NetworkMode. Used during group-creation to determine the [[BTM_services#SetWlanMode|WlanMode]] to use. When this is value 0x2, mode=3 is used, otherwise it's determined via the +0x81 field. | | 0x0 || 0x10 || Wrapped master key. When zero, set to randomly-generated data. This is decrypted with a "static AES key" and used to derive the 4 encryption keys for the session. | ||
|- | |||
| 0x10 || 0x8 || LocalCommunicationId. When zero, the value from control.nacp is loaded. This is later validated by [[#Join]]/[[#CreateGroup]] the same way as the [[#NetworkConfig]] field. Used during key derivation to derive keys B and D. | |||
|- | |||
| 0x18 || 0x6 || [[#GroupId]] ("GROUP ID (BSSID)"). When zero, the default is used. The default should be used here: an error is thrown if the data here doesn't match the output from [[WLAN_services|wlan:lcl]] cmd2. | |||
|- | |||
| 0x1E || 0x21 || ServiceName ("GROUP NAME (SSID)"). NUL-terminated string. See below. | |||
|- | |||
| 0x3F || 0x1 || s8 Flags count. Must be <=0x3F. | |||
|- | |||
| 0x40 || 0x40 || Array of s8 with the above count. Each entry value must be <=0x3F. Each entry is an array index used to load a set of flags from a global array with the specified index. global_flags are also masked with flags loaded from here. User-processes use entryval=1 as the default, with [11.0.0+] entryval=0 can be used for standard WPA2-PSK (see +0x8A). | |||
|- | |||
| 0x80 || 0x1 || SupportedPlatform. Must match value 1. 0 is PlatformIdNX, 1 is PlatformIdRcd. | |||
|- | |||
| 0x81 || 0x1 || MemberCountMax. s8, Must be <=0x8. During group creation this is passed to [[WLAN_services|wlan:lcl]] cmd40, when this is value 0 a default of value 1 is passed. During group-creation when the below +0x88 field is not value 0x2, the passed [[BTM_services#SetWlanMode|WlanMode]] is <code>x81_field_val > 3</code>. | |||
|- | |||
| 0x82 || 0x1 || | |||
|- | |||
| 0x84 || 0x2 || Frequency. Wifi frequency: 24 = 2.4GHz, 50 = 5GHz. | |||
|- | |||
| 0x86 || 0x2 || s16 Channel ("CHANNEL"). Wifi channel number. 0 = use default, otherwise this must be one of the following depending on the frequency field: | |||
* 24: 1, 6, 11. | |||
* 50: 36, 40, 44, 48. | |||
|- | |||
| 0x88 || 0x1 || NetworkMode. Used during group-creation to determine the [[BTM_services#SetWlanMode|WlanMode]] to use. When this is value 0x2, mode=3 is used, otherwise it's determined via the +0x81 field. | |||
|- | |- | ||
| 0x89 || 0x1 || PerformanceRequirement. | | 0x89 || 0x1 || PerformanceRequirement. | ||
Line 1,434: | Line 1,640: | ||
= Network protocol = | = Network protocol = | ||
== ldn == | == ldn == | ||
A beacon and Action frame are broadcasted. The SSID in the beacon is hidden (32-bytes with value 0). For [[#Scan]]/[[#ScanPrivate]] it doesn't matter if no beacon is available ([[#NetworkInfo]] is the same), as long as the Action frame is broadcasted. However, the Station will not send a probe-request during connection if no beacon is available (and therefore not attempt any communication with the AccessPoint). The beacon doesn't have any custom Nintendo data, that data is in the | A beacon and Action frame are broadcasted. The SSID in the beacon is hidden (32-bytes with value 0). For [[#Scan]]/[[#ScanPrivate]] it doesn't matter if no beacon is available ([[#NetworkInfo]] is the same), as long as the Action frame is broadcasted. However, the Station will not send a probe-request during connection if no beacon is available (and therefore not attempt any communication with the AccessPoint). The beacon doesn't have any custom Nintendo data, that data is in the Action frame. | ||
During connection, the Station first sends a probe-request using the [[#NetworkInfo|generated]] SSID from the Action frame. If the probe-response contains the expected data for the [[#SecurityConfig]] type, the Station then proceeds to connect to the AccessPoint. The key for data-frames, if [[#SecurityConfig|enabled]], is derived from a buffer containing: {[[#SecurityParameter]]+0x0} followed by {[[#SecurityConfig]] | During connection, the Station first sends a probe-request using the [[#NetworkInfo|generated]] SSID from the Action frame. If the probe-response contains the expected data for the [[#SecurityConfig]] type, the Station then proceeds to connect to the AccessPoint. | ||
Keys are derived with: <code>GenerateAesKek(AccessKey, KeySource, Generation, Option=0); GenerateAesKey(out_key, AccessKey, {output from SHA256(data_to_hash)});</code> The key for data-frames, if [[#SecurityConfig|enabled]], is derived from a buffer containing: {[[#SecurityParameter]]+0x0} followed by {[[#SecurityConfig]] Passphrase with the specified PassphraseSize}. The [[#ActionFrame]]/data-frame keys are derived roughly the same, the only difference is the data for hashing + the [[SPL_services|KeySource]]. The key derived by ldn is used directly as the static CCMP key for all data-frames (CCMP / MIC is standard). When [[#Protocol|Protocol]] is 3 the [[SPL_services|Generation]] is [[19.0.0|0x13]] instead of 0x0, for all of the previously mentioned keys derivation. | |||
Then the Station scans for an [[#ActionFrame]] for loading the [[#NetworkInfo]]. | Then the Station scans for an [[#ActionFrame]] for loading the [[#NetworkInfo]]. | ||
Line 1,444: | Line 1,652: | ||
After Authentication the Station will scan for another [[#ActionFrame]], with frame-comparision enabled with the above frame (frame must have been updated since the previous scan). The Station locates the index for a [[#MacAddress|MacAddress]] matching itself in the [[#NetworkInfo]] [[#NodeInfo|NodeInfo]] array (the entry for the AccessPoint is skipped), throwing an error if not found. After validating the LocalCommunicationVersion, it proceeds to handle ARP setup below. | After Authentication the Station will scan for another [[#ActionFrame]], with frame-comparision enabled with the above frame (frame must have been updated since the previous scan). The Station locates the index for a [[#MacAddress|MacAddress]] matching itself in the [[#NetworkInfo]] [[#NodeInfo|NodeInfo]] array (the entry for the AccessPoint is skipped), throwing an error if not found. After validating the LocalCommunicationVersion, it proceeds to handle ARP setup below. | ||
This does not use DHCP, each node on the network has to manually setup ARP (without sending ARP network requests) with the [[#NodeInfo|NodeInfo]] array in [[#NetworkInfo]]. | This does not use DHCP, each node on the network has to manually setup ARP (without sending ARP network requests) with the [[#NodeInfo|NodeInfo]] array in [[#NetworkInfo]]. [?+] After the client is [[#EthFrame|authenticated]] the host sends an ARP reply to the client (there's no ARP usage besides this). | ||
At this point standard sockets can be used over Data frames. | At this point standard sockets can be used over Data frames. | ||
Line 1,473: | Line 1,681: | ||
| 0x2 || 0x1 || Status. 0 = success, non-zero = error. | | 0x2 || 0x1 || Status. 0 = success, non-zero = error. | ||
|- | |- | ||
| 0x3 || 0x1 || [2.0.0+] bool flag. The AccessPoint verifies that this is not set. Always set to 1 by the AccessPoint in the response. The Station only uses this when the [[#AuthVersion]] is >=2. | | 0x3 || 0x1 || [2.0.0+] bool flag. The AccessPoint verifies that this is not set. Always set to 1 by the AccessPoint in the response. [2.0.0-?] The Station only uses this when the [[#AuthVersion]] is >=2. | ||
|- | |- | ||
| 0x4 || 0x1 || [6.0.0+] High u8 for the size. | | 0x4 || 0x1 || [6.0.0+] High u8 for the size. | ||
|- | |- | ||
| 0x5 || | | 0x5 || 0x1 || [20.0.0+] AuthEncryptionType, must match the type being used by the [[#Protocol|Protocol]]. 0 = plaintext ([[#Protocol|Protocol]] NX), 1 = AES-128-GCM ([[#Protocol|Protocol]] 3). | ||
|- | |||
| 0x6 || 0x2 || Unused, zeros. | |||
|- | |- | ||
| 0x8 || 0x20 || [[#NetworkInfo]]+0, must match the corresponding data in [[#NetworkInfo]] when the receiving node verifies this. With the | | 0x8 || 0x20 || [[#NetworkInfo]]+0, must match the corresponding data in [[#NetworkInfo]] when the receiving node verifies this. With the | ||
Line 1,485: | Line 1,695: | ||
AccessPoint->Station frame, the Station verifies that this matches the data previously sent to the AccessPoint. | AccessPoint->Station frame, the Station verifies that this matches the data previously sent to the AccessPoint. | ||
|- | |- | ||
| 0x38 || 0x10 || | | 0x38 || 0x10 || AuthEncryptionType1: Used for key derivation. | ||
Station->AccessPoint: The Station sets this to random data. Unused by the AccessPoint (besides the above), except for copying into the response. | |||
AccessPoint->Station: +0x38 from the data originally sent by the Station. The Station verifies that this matches the previously sent data. | |||
|- | |||
| 0x48 || 0x10 || Only present with AuthEncryptionType1: AES-128-GCM MAC tag. | |||
|- | |- | ||
| 0x48 || || Frame-specific data, with the above size. The total frame size - {offset of the start of this data in the frame} must match the above size. | | 0x48 (0x58 with AuthEncryptionType1) || || Frame-specific payload data, with the above size. The total frame size - {offset of the start of this data in the frame} must match the above size. | ||
|} | |} | ||
The Station sets the above size to 0x40 ([6.0.0+] if [[#NetworkInfo]]+0x13 is <3). [6.0.0+] The Authentication challenge is only used/enabled if that value is >=3, and [[#IUserLocalCommunicationService]] is being used. | The Station sets the above size to 0x40 ([6.0.0+] if [[#NetworkInfo]]+0x13 is <3) ([?+] 0x64 regardless of [[#AuthVersion]]). [6.0.0+] The Authentication challenge is only used/enabled if that value is >=3, and [[#IUserLocalCommunicationService]] is being used. | ||
The AccessPoint sets the above size to 0x40 ([6.0.0+] 0x0 if the +0x0 [[#AuthVersion]] is <3). [6.0.0+] The AccessPoint will only use/enable the Authentication challenge when the +0x0 [[#AuthVersion]] is >=3, and [[#IUserLocalCommunicationService]] is being used. This data will not be included in the frame if the status field indicates error. | The AccessPoint sets the above size to 0x40 ([6.0.0+] 0x0 if the +0x0 [[#AuthVersion]] is <3) ([?+] 0x84 regardless of [[#AuthVersion]]). [6.0.0+] The AccessPoint will only use/enable the Authentication challenge when the +0x0 [[#AuthVersion]] is >=3, and [[#IUserLocalCommunicationService]] is being used. This data will not be included in the frame if the status field indicates error. | ||
[6.0.0+] Support for the Authentication challenge with [[ETicket_services|es]] cmds 1501-1504 was added. | [6.0.0+] Support for the Authentication challenge with [[ETicket_services|es]] cmds 1501-1504 was added. | ||
AuthEncryptionType1: The key is derived essentially the same as the data-frame CCMP key, except the input data for hashing is the 0x10-bytes at +0x38 (this also only supports using [[SPL_services|Generation]] 0x13, returning immediately if the input param indicates otherwise due to the [[#Protocol|Protocol]]). The encrypted AES-128-GCM data starts at +0x58 with the above size. The 0xC-bytes IV is at +0x0, the AAD is at +0x0 size 0x48-bytes. | |||
The AccessPoint will not respond to frames where the source mac-address is unrecognized. | The AccessPoint will not respond to frames where the source mac-address is unrecognized. | ||
Station->AccessPoint payload data, relative to frame_end above (frame size depends on whether the challenge is enabled): | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,506: | Line 1,723: | ||
! Description | ! Description | ||
|- | |- | ||
| | | 0x0 || 0x20 || [[#UserConfig]]+0. Copied into state by the AccessPoint. | ||
|- | |- | ||
| | | 0x20 || 0x2 || Big-endian LocalCommunicationVersion. Byte-swapped by the AccessPoint then copied into state. [?+] This is now ignored. | ||
|- | |- | ||
| | | 0x22 || 0x1 || [19.0.0+] [[#NodeInfo|NodeInfo]] +0x2D. Copied into state by the AccessPoint. On NX the Station always sets this to 0 in the sent payload-data. | ||
|- | |- | ||
| | | 0x23 || 0x1D || Zeros, unused by the AccessPoint. | ||
|- | |- | ||
| | | 0x40 || 0x24 || [6.0.0+] Zeros, unused by the AccessPoint. | ||
|- | |- | ||
| | | 0x64 || 0x300 || [6.0.0+] Authentication challenge data. If enabled, the total frame size must be >= {end offset of this data in the frame}. The frame data does not include this if it's not enabled. | ||
|} | |} | ||
AccessPoint->Station response | AccessPoint->Station response payload data, relative to frame_end above (frame size depends on whether the challenge is enabled): | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,527: | Line 1,744: | ||
! Description | ! Description | ||
|- | |- | ||
| | | 0x0 || 0x1 || | ||
|- | |- | ||
| | | 0x1 || 0x3F || Zeros. [6.0.0-?] Only included in the frame if it's enabled (+0x0 [[#AuthVersion]] >= 3). Unused by the Station. | ||
|- | |- | ||
| | | 0x40 || 0x44 || [6.0.0-?] Only included in the frame if it's enabled (+0x0 [[#AuthVersion]] >= 3). Unused by the Station. | ||
|- | |- | ||
| | | 0x84 || 0x100 || [6.0.0+] If enabled, Authentication challenge response data. Not included in the frame if it's not enabled. | ||
|} | |} | ||
===== AuthVersion ===== | ===== AuthVersion ===== | ||
Must be 0x1-0xF. | Must be 0x1-0xF (<x010 with newer versions). | ||
[?+] When the AccessPoint is handling the [[#Authentication|Authentication]] EthFrame, the AuthVersion must be >=1 for [[#Protocol|Protocol]] NX, and >=4 for [[#Protocol|Protocol]] 3. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 1,548: | Line 1,767: | ||
|- | |- | ||
| 3 || [6.0.0+] | | 3 || [6.0.0+] | ||
|- | |||
| 4 || [19.0.0+] | |||
|} | |} | ||
Line 1,582: | Line 1,803: | ||
| 0x0 || 0x20 || [[#NetworkInfo]]+0x0. The u64/u16 are big-endian. Outside of [[#Scan]]/[[#ScanPrivate]], this must match the previously loaded data for this. | | 0x0 || 0x20 || [[#NetworkInfo]]+0x0. The u64/u16 are big-endian. Outside of [[#Scan]]/[[#ScanPrivate]], this must match the previously loaded data for this. | ||
|- | |- | ||
| 0x20 || 0x1 || [[#AuthVersion]]. Copied to [[#NetworkInfo]]+0x63. When comparing with a previous frame is enabled, this must match the value from the previous frame. | | 0x20 || 0x1 || [[#AuthVersion]]. Copied to [[#NetworkInfo]]+0x63. When comparing with a previous frame is enabled, this must match the value from the previous frame. | ||
|- | |- | ||
| 0x21 || 0x1 || Encryption type: 1 = plaintext, 2 = | | 0x21 || 0x1 || Encryption type: 1 = plaintext, 2 = AES-128-CTR, [20.0.0+] 3 = AES-128-GCM, {frames with other values are ignored by [[#Scan]]/[[#ScanPrivate]]}. Must match the type which is currently being used: with [[#Scan]]/[[#ScanPrivate]] this is determined via this field, otherwise [[#SecurityConfig]] is used to determine this. | ||
|- | |- | ||
| 0x22 || 0x2 || Big-endian u16 size for the data starting at +0x48 | | 0x22 || 0x2 || Big-endian u16 size for the data starting at +0x48 (+0x38 with EncryptionType3), and must match {total frame size relative to +0x0 above} - {header_size}. | ||
|- | |- | ||
| 0x24 || 0x4 || Big-endian u32 Counter. The initial value is randomly-generated. This is incremented each time the below content is updated (including initial creation). Also used by the Station to determine whether the frame changed compared to a previous one. When comparing against a previous frame, new_counter-prev_counter must be <= 0xFF, and the counters must not match. | | 0x24 || 0x4 || Big-endian u32 Counter. The initial value is randomly-generated. This is incremented each time the below content is updated (including initial creation). Also used by the Station to determine whether the frame changed compared to a previous one. When comparing against a previous frame, new_counter-prev_counter must be <= 0xFF, and the counters must not match. | ||
|- | |- | ||
| 0x28 || 0x20 || SHA256 hash over the entire frame starting at +0x0, with the above size + 0x48. During hashing, this hash is cleared, with the new hash overwriting the original in memory (the original is copied to stack for comparing). | | 0x28 || 0x20 || EncryptionType1-2: SHA256 hash over the entire frame starting at +0x0, with the above size + 0x48. During hashing, this hash is cleared, with the new hash overwriting the original in memory (the original is copied to stack for comparing). | ||
|} | |- | ||
| 0x28 || 0x10 || EncryptionType3: AES-128-GCM MAC tag (replaces the SHA256 hash). | |||
When encryption is enabled, the encrypted data is +0x28 with size {remaining frame size} | |} | ||
The content data at + | Using EncryptionType3 outside of [[#Scan]]/[[#ScanPrivate]] is enabled with [[#Protocol|Protocol]] 3. | ||
{| class="wikitable" border="1" | When encryption is enabled, the encrypted data is at +0x28 (+0x38 with EncryptionType3) with size {remaining frame size}. The key is derived from the raw 0x20-bytes at +0x0. The CTR/IV is {raw Counter above without byte-swap}, with the rest cleared to zeros. The AAD for AES-128-GCM is at +0x0 size 0x28-bytes. | ||
|- | |||
! Offset | Originally [[#Scan]]/[[#ScanPrivate]] used the EncryptionType field to determine encryption handling. With [18.0.0+] these now set an internal SecurityMode field to 0 (Any) initially, then later uses the same SecurityMode override as [[#CreateNetwork|CreateNetwork]]. The internal SecurityMode field is used to determine encryption handling: Any uses the EncryptionType field like before. With non-zero the encryption handling is determined as required by the SecurityMode. | ||
! Size | |||
! Description | The content data at +{above_header_size} follows, which has the size specified above (which must be >=0x500 with EncryptionType1-2), where all fields are big-endian. For EncryptionType1-2: | ||
|- | |||
| 0x0 || 0x10 || [[#NetworkInfo]]+0x50 | {| class="wikitable" border="1" | ||
|- | |- | ||
| 0x10 || 0x2 || [[#NetworkInfo]]+0x60 | ! Offset | ||
|- | ! Size | ||
| 0x12 || 0x1 || [[#NetworkInfo]]+0x62 | ! Description | ||
|- | |- | ||
| 0x13 || | | 0x0 || 0x10 || [[#NetworkInfo]]+0x50 | ||
|- | |- | ||
| 0x16 || 0x1 || s8 [[#NetworkInfo]]+0x66, clamped to range 1-8. | | 0x10 || 0x2 || [[#NetworkInfo]]+0x60 | ||
|- | |- | ||
| 0x17 || 0x1 || s8 [[#NetworkInfo]]+0x67, clamped to range 1-8. | | 0x12 || 0x1 || [[#NetworkInfo]]+0x62 | ||
|- | |||
| 0x13 || 0x1 || Unused | |||
|- | |||
| 0x14 || 0x2 || | |||
|- | |||
| 0x16 || 0x1 || s8 [[#NetworkInfo]]+0x66, clamped to range 1-8. | |||
|- | |||
| 0x17 || 0x1 || s8 [[#NetworkInfo]]+0x67, clamped to range 1-8. | |||
|- | |||
| 0x18 || 0x1C0(0x38*8) || Array of the below node struct. | |||
|- | |||
| 0x1D8 || 0x2 || Unused | |||
|- | |||
| 0x1DA || 0x2 || [[#NetworkInfo]]+0x26A | |||
|- | |||
| 0x1DC || 0x180 || [[#NetworkInfo]]+0x26C | |||
|- | |||
| 0x35C || 0x19C || Unused | |||
|- | |||
| 0x4F8 || 0x8 || [6.0.0+] [[#NetworkInfo]]+0x478 | |||
|} | |||
For EncryptionType3: | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x10 || [[#NetworkInfo]]+0x50 | |||
|- | |||
| 0x10 || 0x8 || [[#NetworkInfo]]+0x478 | |||
|- | |||
| 0x18 || 0x1 || [[#NetworkInfo]]+0x60 | |||
|- | |||
| 0x19 || 0x1 || [[#NetworkInfo]]+0x62 | |||
|- | |||
| 0x1A || 0x2 || s16 LocalCommunicationVersion. Must not be negative. | |||
|- | |||
| 0x1C || 0x8 || Unused? | |||
|- | |||
| 0x24 || 0x2 || Same as +0x14 in the above struct for EncryptionType1-2. | |||
|- | |||
| 0x26 || 0x1 || s8 [[#NetworkInfo]]+0x66 (NodeCountMax) | |||
|- | |||
| 0x27 || 0x1 || s8 [[#NetworkInfo]]+0x67 (NodeCount) | |||
|- | |||
| 0x28 || NodeCount*0x30 || Array of the below node struct. | |||
|- | |||
| 0x28 + (NodeCount*0x30) || 0x2 || [[#NetworkInfo]]+0x26A (AdvertiseDataSize) | |||
|- | |||
| 0x2A + (NodeCount*0x30) || AdvertiseDataSize || [[#NetworkInfo]]+0x26C (AdvertiseData) | |||
|} | |||
The data here is copied into [[#NetworkInfo]]. | |||
Node data used in the above array (all fields big-endian), which are copied into the [[#NetworkInfo]] [[#NodeInfo|NodeInfo]] array. For EncryptionType1-2: | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x4 || [[#Ipv4Address]] | |||
|- | |||
| 0x4 || 0x6 || [[#MacAddress|MacAddress]] | |||
|- | |||
| 0xA || 0x1 || bool IsConnected | |||
|- | |||
| 0xB || 0x1 || [19.0.0+] [[#NodeInfo|NodeInfo]] +0x2D | |||
|- | |||
| 0xC || 0x20 || First 0x20-bytes of [[#UserConfig]]. | |||
|- | |||
| 0x2C || 0x2 || s16 LocalCommunicationVersion | |||
|- | |||
| 0x2E || 0xA || Unused | |||
|} | |||
For EncryptionType3: | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x4 || [[#Ipv4Address]] | |||
|- | |||
| 0x4 || 0x6 || [[#MacAddress|MacAddress]] | |||
|- | |||
| 0xA || 0x1 || NodeId | |||
|- | |||
| 0xB || 0x1 || [[#NodeInfo|NodeInfo]] +0x2D | |||
|- | |||
| 0xC || 0x20 || First 0x20-bytes of [[#UserConfig]]. | |||
|- | |||
| 0x2C || 0x4 || Unused | |||
|} | |||
=== ActionFrame2 === | |||
The Action frames used by [[#SendActionFrame|SendActionFrame]]/[[#RecvActionFrame|RecvActionFrame]] have the following structure: | |||
* "Fixed parameters": | |||
** "Category code: Vendor Specific (127)" | |||
** "OUI: 00:22:aa (Nintendo Co., Ltd.)" | |||
* The Data starts with the following header: | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x2 || 04 00 | |||
|- | |||
| 0x2 || 0x2 || Protocol ID, must match big-endian 0x0102. | |||
|- | |||
| 0x4 || 0x2 || 00 00 | |||
|- | |||
| 0x6 || 0x2 || 00 00 | |||
|} | |||
Then the actual data follows (all fields big-endian): | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x1 || [[#AuthVersion]] | |||
|- | |||
| 0x1 || 0x1 || EncryptionType, must match the expected type for the current SecurityMode. 1 = plaintext, 2 = AES-128-GCM. | |||
|- | |- | ||
| | | 0x2 || 0x2 || Padding | ||
|- | |- | ||
| | | 0x4 || 0x4 || Counter | ||
|- | |- | ||
| | | 0x8 || 0x8 || LocalCommunicationId | ||
|- | |- | ||
| | | 0x10 || 0x10 || Used with key derivation. | ||
|- | |- | ||
| | | 0x20 || 0x10 || EncryptionType2: AES-128-GCM MAC tag. | ||
|- | |- | ||
| | | 0x30 || Remaining frame size || Data payload | ||
|} | |} | ||
The data | The 0xC-byte IV for AES-128-GCM is the raw 4-bytes from the above Counter, with the rest cleared to zeroes. The encrypted data is at +0x30, with the remaining frame size. The AAD is the 0x20-bytes at +0x0. | ||
The key is derived similar to the regular action-frame key (same KeySource), except: the Generation is always [[17.0.0|0x11]], with the following data for hashing: {big-endian LocalCommunicationId} {+0x10 size 0x10-bytes} {[[#ActionFrameSettings]] Passphrase with the specified PassphraseSize}. | |||
The data payload is the data buffer for [[#SendActionFrame|SendActionFrame]]/[[#RecvActionFrame|RecvActionFrame]]. | |||
== lp2p == | == lp2p == |