Nintendo Switch Brew

LDN services: Difference between revisions

← Older edit
No edit summary
 
(61 intermediate revisions by 2 users not shown)
Line 8: Line 8:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#CreateMonitorService]]
| 0 || [[#CreateMonitorService|CreateMonitorService]]
|}
|}


Line 23: Line 23:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#GetStateForMonitor]]
| 0 || [[#GetState|GetState]]
|-
|-
| 1 || [[#GetNetworkInfoForMonitor]]
| 1 || [[#GetNetworkInfo|GetNetworkInfo]]
|-
|-
| 2 || [[#GetIpv4AddressForMonitor]]
| 2 || [[#GetIpv4Address|GetIpv4Address]]
|-
|-
| 3 || [[#GetDisconnectReasonForMonitor]]
| 3 || [[#GetDisconnectReason|GetDisconnectReason]]
|-
|-
| 4 || [[#GetSecurityParameterForMonitor]]
| 4 || [[#GetSecurityParameter|GetSecurityParameter]]
|-
|-
| 5 || [[#GetNetworkConfigForMonitor]]
| 5 || [[#GetNetworkConfig|GetNetworkConfig]]
|-
|-
| 100 || [[#InitializeMonitor]]
| 100 || [[#Initialize]]
|-
|-
| 101 || [[#FinalizeMonitor]]
| 101 || [[#Finalize]]
|}
|}


=== GetStateForMonitor ===
=== 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.


=== GetNetworkInfoForMonitor ===
=== GetNetworkInfo ===
Takes a type-0x1A output buffer containing a [[#NetworkInfo]].
Takes a type-0x1A output buffer containing a [[#NetworkInfo]].


=== GetIpv4AddressForMonitor ===
=== GetIpv4Address ===
No input, returns an output [[#Ipv4Address]] and a [[#SubnetMask]].
No input, returns an output [[#Ipv4Address]] and a [[#SubnetMask]].


=== GetDisconnectReasonForMonitor ===
=== GetDisconnectReason ===
No input, returns an output s16.
No input, returns an output s16.


Line 58: Line 58:
This just returns 0.
This just returns 0.


=== GetSecurityParameterForMonitor ===
=== 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.


=== GetNetworkConfigForMonitor ===
=== 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.


=== InitializeMonitor ===
=== Initialize ===
No input/output.
No input/output.


Line 75: Line 75:
This just returns 0.
This just returns 0.


=== FinalizeMonitor ===
=== Finalize ===
No input/output.
No input/output.


Line 89: Line 89:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#CreateSystemLocalCommunicationService]]
| 0 || [[#CreateSystemLocalCommunicationService|CreateSystemLocalCommunicationService]]
|-
|-
| 1 || [18.0.0+] [[#CreateClientProcessMonitor]]
| 1 || [18.0.0+] [[#CreateClientProcessMonitor|CreateClientProcessMonitor]]
|}
|}


Line 109: Line 109:
! 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 || [[#AttachStateChangeEvent]]
| 100 || [[#GetStateChangeEvent|GetStateChangeEvent]]
|-
|-
| 101 || [[#GetNetworkInfoLatestUpdate]]
| 101 || [[#GetNetworkInfoAndHistory|GetNetworkInfoAndHistory]]
|-
|-
| 102 || [[#Scan]]
| 102 || [[#Scan|Scan]]
|-
|-
| 103 || [[#ScanPrivate]]
| 103 || [[#ScanPrivate|ScanPrivate]]
|-
|-
| 104 || [5.0.0+] [[#SetWirelessControllerRestriction]]
| 104 || [5.0.0+] [[#SetWirelessControllerPolicy|SetWirelessControllerPolicy]]
|-
|-
| 105 || [13.1.0+] [[#SetBluetoothAudioDeviceConnectableMode]]
| 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 || [[#InitializeSystem]]
| 400 || [[#Initialize_2|Initialize]]
|-
|-
| 401 || [[#FinalizeSystem]]
| 401 || [[#Finalize_2|Finalize]]
|-
|-
| 402 || [4.0.0+] [[#SetOperationMode]]
| 402 || [4.0.0+] [[#SetOperationMode|SetOperationMode]]
|-
|-
| 403 || [7.0.0+] [[#InitializeSystem2]]
| 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
| 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 212:
No input, returns an output [[#NetworkConfig]].
No input, returns an output [[#NetworkConfig]].


=== AttachStateChangeEvent ===
=== 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]]/[[#GetNetworkInfoLatestUpdate]] is updated.
This is signaled when the data returned by [[#GetNetworkInfo]]/[[#GetNetworkInfoAndHistory]] is updated.


=== GetNetworkInfoLatestUpdate ===
=== 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 242:
See [[#Scan]].
See [[#Scan]].


=== SetWirelessControllerRestriction ===
=== SetWirelessControllerPolicy ===
Takes an input [[#WirelessControllerRestriction]], no output.
Takes an input [[#WirelessControllerRestriction]], no output.


Line 249: Line 249:
The input value is written into state.
The input value is written into state.


=== SetBluetoothAudioDeviceConnectableMode ===
=== 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.
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 286:
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 350:
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 359:
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 366:
[[#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.


=== InitializeSystem ===
=== 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.


With [7.0.0+] [[#InitializeSystem2]] is used instead.
With [7.0.0+] [[#InitializeWithVersion|InitializeWithVersion]] is used instead. The cmd impl for Initialize uses [[#InitializeWithVersion|InitializeWithVersion]] with input_u32=0.


=== FinalizeSystem ===
=== Finalize ===
No input/output.
No input/output.


Line 372: Line 389:
The input value is written into state.
The input value is written into state.


=== InitializeSystem2 ===
=== InitializeWithVersion ===
Takes an input PID, an u32, and an u64 pid_placeholder.
Takes an input PID, an u32, and an u64 pid_placeholder.


Official sw uses hard-coded value 0x1 for the u32.
Official sw uses hard-coded value 0x1 for the u32.


The input u32 is ignored, the impl for this cmd is identical to [[#InitializeSystem]].
The input u32 is ignored, the impl for this cmd is identical to [[#Initialize_2|Initialize]].


Internally this calls a func with params: (..., PID, &{u16 value 0x38}). On success, this then calls another func (which sets two state fields to the input) with params: (state, 0) (these state fields are used during [[#Authentication]] to check which service is being used).
Internally this calls a func with params: (..., PID, &{u16 value 0x38}). On success, this then calls another func (which sets two state fields to the input) with params: (state, 0) (these state fields are used during [[#Authentication]] to check which service is being used).
Line 385: Line 402:
[[#GetState|State]] must be 0, this cmd eventually sets the State to value 1.
[[#GetState|State]] must be 0, this cmd eventually sets the State to value 1.


== IClientProcessMonitor ==
=== InitializeWithPriority ===
This is "nn::ldn::detail::IClientProcessMonitor".
Takes an input PID, an u32, an u32, and an u64 pid_placeholder.
 
This is similar to [[#InitializeWithVersion|InitializeWithVersion]], with the additional cmd input u32 now being passed directly to the init func which is called here.
 
=== EnableActionFrame ===
Takes an input [[#ActionFrameSettings]]. No output.


This was added with [18.0.0+].  
[[#State|State]] must be Initialized.


{| class="wikitable" border="1"
=== 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.
 
[[#State|State]] must be 3-4 (AccessPointCreated/Station).
 
On NX this sends a raw action frame with the input buffer as the data?
 
=== RecvActionFrame ===
Takes a type-0x22 output buffer and an input [[#MessageFlagSet]]. Returns an output u32 '''Size''', two output [[#MacAddress]], two output s16s ('''Band''' and '''ChannelNumber''') and an output s32 '''LinkLevel'''.
 
[[#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 [[#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
! Cmd || Name
|-
|-
Line 404: Line 473:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#CreateUserLocalCommunicationService]]
| 0 || [[#CreateUserLocalCommunicationService|CreateUserLocalCommunicationService]]
|-
|-
| 1 || [18.0.0+] [[#CreateClientProcessMonitor]]
| 1 || [18.0.0+] [[#CreateClientProcessMonitor|CreateClientProcessMonitor]]
|}
|}


Line 417: Line 486:
This is "nn::ldn::detail::IUserLocalCommunicationService".
This is "nn::ldn::detail::IUserLocalCommunicationService".


This is identical to [[#ISystemLocalCommunicationService]], except for the System-only cmd(s), and [[#Initialize]]/[[#Initialize2]] differ.
This is identical to [[#ISystemLocalCommunicationService]], except for the System-only cmd(s), and [[#Initialize_3|Initialize]]/[[#InitializeWithVersion_2|InitializeWithVersion]] differ.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 423: Line 492:
! 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 || [[#AttachStateChangeEvent]]
| 100 || [[#GetStateChangeEvent|GetStateChangeEvent]]
|-
|-
| 101 || [[#GetNetworkInfoLatestUpdate]]
| 101 || [[#GetNetworkInfoAndHistory|GetNetworkInfoAndHistory]]
|-
|-
| 102 || [[#Scan]]
| 102 || [[#Scan|Scan]]
|-
|-
| 103 || [[#ScanPrivate]]
| 103 || [[#ScanPrivate|ScanPrivate]]
|-
|-
| 104 || [5.0.0+] [[#SetWirelessControllerRestriction]]
| 104 || [5.0.0+] [[#SetWirelessControllerPolicy|SetWirelessControllerPolicy]]
|-
|-
| 105 || [13.1.0+] [[#SetBluetoothAudioDeviceConnectableMode]]
| 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 || [[#Initialize]]
| 400 || [[#Initialize_3|Initialize]]
|-
|-
| 401 || [[#Finalize]]
| 401 || [[#Finalize_3|Finalize]]
|-
|-
| 402 || [7.0.0+] [[#Initialize2]]
| 402 || [7.0.0+] [[#InitializeWithVersion_2|InitializeWithVersion]]
|-
|-
| 403 || [19.0.0+]  
| 403 || [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
| 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 507: Line 576:
This is used immediately after object creation.
This is used immediately after object creation.


With [7.0.0+] [[#Initialize2]] is used instead.
With [7.0.0+] [[#InitializeWithVersion_2|InitializeWithVersion]] is used instead.


This is identical to [[#InitializeSystem]] except different params are used for the funcs called internally.
This is identical to [[#Initialize_2|Initialize]] except different params are used for the funcs called internally.


=== Finalize ===
=== Finalize ===
Line 516: Line 585:
This is used during service exit, prior to closing the object. Official sw will Abort if this fails.
This is used during service exit, prior to closing the object. Official sw will Abort if this fails.


This is identical to [[#FinalizeSystem]].
=== InitializeWithVersion ===
 
=== Initialize2 ===
Takes an input PID, an u32, and an u64 pid_placeholder.
Takes an input PID, an u32, and an u64 pid_placeholder.


Official sw uses hard-coded value 0x1 for the u32.
Official sw uses hard-coded value 0x1 for the u32.


The input u32 is ignored, the impl for this cmd is identical to [[#Initialize]].
The input u32 is ignored, the impl for this cmd is identical to [[#Initialize_3|Initialize]].


This is identical to [[#InitializeSystem2]] except different params are used for the funcs called internally: the u16 value is 0x5A, and the value for the second func is 1.
This is identical to [[#InitializeWithVersion|InitializeWithVersion]] except different params are used for the funcs called internally: the u16 value is 0x5A, and the value for the second func is 1.


= ndd =
= ndd =
Line 598: Line 665:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#CreateNetworkService]]
| 0 || [[#CreateNetworkService|CreateNetworkService]]
|-
|-
| 8 || [[#CreateNetworkServiceMonitor]]
| 8 || [[#CreateNetworkServiceMonitor|CreateNetworkServiceMonitor]]
|}
|}


Line 618: Line 685:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#Initialize|Initialize]]
| 0 || [[#Initialize_4|Initialize]]
|-
|-
| [9.0.0-9.0.1] 256 || [[#AttachNetworkInterfaceStateChangeEvent]]
| 256 || [9.0.0-9.0.1] [[#AttachNetworkInterfaceStateChangeEvent|AttachNetworkInterfaceStateChangeEvent]]
|-
|-
| [9.0.0-9.0.1] 264 || [[#GetNetworkInterfaceLastError]]
| 264 || [9.0.0-9.0.1] [[#GetNetworkInterfaceLastError|GetNetworkInterfaceLastError]]
|-
|-
| [9.0.0-9.0.1] 272 || [[#GetRole]]
| 272 || [9.0.0-9.0.1] [[#GetRole|GetRole]]
|-
|-
| [9.0.0-9.0.1] 280 || [[#GetAdvertiseData]]
| 280 || [9.0.0-9.0.1] [[#GetAdvertiseData|GetAdvertiseData]]
|-
|-
| [9.0.0-9.0.1] 288 || [[#GetGroupInfo]]
| 288 || [9.0.0-9.0.1] [[#GetGroupInfo|GetGroupInfo]]
|-
|-
| [9.0.0-9.0.1] 296 || [[#GetGroupInfo2]]
| 296 || [9.0.0-9.0.1] [[#GetGroupInfo2|GetGroupInfo2]]
|-
|-
| [9.0.0-9.0.1] 304 || [[#GetGroupOwner]]
| 304 || [9.0.0-9.0.1] [[#GetGroupOwner|GetGroupOwner]]
|-
|-
| [9.0.0-9.0.1] 312 || [[#GetIpConfig]]
| 312 || [9.0.0-9.0.1] [[#GetIpConfig|GetIpConfig]]
|-
|-
| [9.0.0-9.0.1] 320 || [[#GetLinkLevel]]
| 320 || [9.0.0-9.0.1] [[#GetLinkLevel|GetLinkLevel]]
|-
|-
| 512 || [[#Scan]]
| 512 || [[#Scan_2|Scan]]
|-
|-
| 768 || [[#CreateGroup]]
| 768 || [[#CreateGroup|CreateGroup]]
|-
|-
| 776 || [[#DestroyGroup]]
| 776 || [[#DestroyGroup|DestroyGroup]]
|-
|-
| 784 || [[#SetAdvertiseData]]
| 784 || [[#SetAdvertiseData|SetAdvertiseData]]
|-
|-
| 1536 || [[#SendToOtherGroup]]
| 1536 || [[#SendToOtherGroup|SendToOtherGroup]]
|-
|-
| 1544 || [[#RecvFromOtherGroup]]
| 1544 || [[#RecvFromOtherGroup|RecvFromOtherGroup]]
|-
|-
| 1552 || [[#AddAcceptableGroupId]]
| 1552 || [[#AddAcceptableGroupId|AddAcceptableGroupId]]
|-
|-
| 1560 || [9.1.0+] [[#ClearAcceptableGroupId]]
| 1560 || [9.1.0+] [[#ClearAcceptableGroupId|ClearAcceptableGroupId]]
|}
|}


Line 731: Line 798:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#Initialize_2|Initialize]]
| 0 || [[#Initialize_5|Initialize]]
|-
|-
| 256 || [[#AttachNetworkInterfaceStateChangeEvent]]
| 256 || [[#AttachNetworkInterfaceStateChangeEvent|AttachNetworkInterfaceStateChangeEvent]]
|-
|-
| 264 || [[#GetNetworkInterfaceLastError]]
| 264 || [[#GetNetworkInterfaceLastError|GetNetworkInterfaceLastError]]
|-
|-
| 272 || [[#GetRole]]
| 272 || [[#GetRole|GetRole]]
|-
|-
| 280 || [[#GetAdvertiseData]]
| 280 || [[#GetAdvertiseData|GetAdvertiseData]]
|-
|-
| 281 || [[#GetAdvertiseData2]]
| 281 || [[#GetAdvertiseData2|GetAdvertiseData2]]
|-
|-
| 288 || [[#GetGroupInfo]]
| 288 || [[#GetGroupInfo|GetGroupInfo]]
|-
|-
| 296 || [[#GetGroupInfo2]]
| 296 || [[#GetGroupInfo2|GetGroupInfo2]]
|-
|-
| 304 || [[#GetGroupOwner]]
| 304 || [[#GetGroupOwner|GetGroupOwner]]
|-
|-
| 312 || [[#GetIpConfig]]
| 312 || [[#GetIpConfig|GetIpConfig]]
|-
|-
| 320 || [[#GetLinkLevel]]
| 320 || [[#GetLinkLevel|GetLinkLevel]]
|-
|-
| 328 || [[#AttachJoinEvent]]
| 328 || [[#AttachJoinEvent|AttachJoinEvent]]
|-
|-
| 336 || [[#GetMembers]]
| 336 || [[#GetMembers|GetMembers]]
|}
|}


Line 826: Line 893:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#CreateMonitorService]]
| 0 || [[#CreateMonitorService|CreateMonitorService]]
|}
|}


Line 839: Line 906:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#Initialize_3|Initialize]]
| 0 || [[#Initialize_6|Initialize]]
|-
|-
| 288 || [[#GetGroupInfo]]
| 288 || [[#GetGroupInfo|GetGroupInfo]]
|-
|-
| 320 || [[#GetLinkLevel]]
| 320 || [[#GetLinkLevel|GetLinkLevel]]
|}
|}


Line 870: Line 937:
|-
|-
| 6 || Error
| 6 || Error
|-
|}
|}


Line 901: Line 967:
|}
|}


= NetworkInfo =
= MacAddress =
This is "nn::ldn::NetworkInfo". This is a 0x480-byte struct. The data at +0x50 is another struct.
This is "nn::ldn::MacAddress". This is a 6-byte struct with 1-byte alignment.


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.
= NodeInfo =
This is "nn::ldn::NodeInfo".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 912: Line 979:
! Description
! Description
|-
|-
| 0x0 || 0x8 || LocalCommunicationId
| 0x0 || 0x4 || [[#Ipv4Address|Ipv4Address]]
|-
|-
| 0x8 || 0x2 || Reserved
| 0x4 || 0x6 || [[#MacAddress|MacAddress]]
|-
|-
| 0xA || 0x2 || Arbitrary user data which can be used for filtering with [[#ScanFilter]].
| 0xA || 0x1 || NodeId
|-
|-
| 0xC || 0x4 || Reserved
| 0xB || 0x1 || IsConnected
|-
|-
| 0x10 || 0x10 || Last 0x10-bytes of [[#SecurityParameter]]. NetworkId which is used to generate/overwrite the [[#Ssid]]. With [[#Scan]]/[[#ScanPrivate]], this is only done after filtering when +0x4B is value 0x2. The converted Ssid is a 0x20-byte lowercase hex string version of the input NetworkId.
| 0xC || 0x21 || UserName
|-
|-
| 0x20 || 0x6 || [[#MacAddress|MacAddress]]
| 0x2D || 0x1 || [19.0.0+] Platform? (0 = NX, 1 = Ounce)
|-
|-
| 0x26 || 0x22 || [[#Ssid]]
| 0x2E || 0x2 || LocalCommunicationVersion
|-
|-
| 0x48 || 0x2 || s16 NetworkChannel
| 0x30 || 0x10 || Reserved
|}
 
= NodeLatestUpdate =
This is "nn::ldn::NodeLatestUpdate". This is a 0x8-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 0x4A || 0x1 || s8 LinkLevel
! Offset
! Size
! Description
|-
|-
| 0x4B || 0x1 || Set to hard-coded value 0x2 with output structs, except with [[#Scan]]/[[#ScanPrivate]] which can also set value 0x1 in certain cases. 0x1 = normal network without an [[#ActionFrame]], 0x2 = LDN network with a valid [[#ActionFrame]].
| 0x0 || 0x1 || StateChange
|-
|-
| 0x4C || 0x4 || Padding
| 0x1 || 0x7 || Reserved
|}
 
= IntentId =
This is "nn::ldn::IntentId".
 
{| class="wikitable" border="1"
|-
|-
| 0x50 || 0x10 || First 0x10-bytes of [[#SecurityParameter]].
! Offset
! Size
! Description
|-
|-
| 0x60 || 0x2 || Same as [[#SecurityConfig]]+0x0.
| 0x0 || 0x8 || LocalCommunicationId
|-
|-
| 0x62 || 0x1 || [[#AcceptPolicy]]
| 0x8 || 0x2 || Reserved
|-
|-
| 0x63 || 0x1 || Only set with [[#Scan]]/[[#ScanPrivate]], when +0x4B is value 0x2. See [[#ActionFrame]].
| 0xA || 0x2 || SceneId
|-
|-
| 0x64 || 0x2 || Padding
| 0xC || 0x4 || Reserved
|-
| 0x66 || 0x1 || Maximum participants, for the [[#NodeInfo|NodeInfo]] array.
|-
| 0x67 || 0x1 || ParticipantNum, number of set entries in the [[#NodeInfo|NodeInfo]] array. If +0x4B is not 0x2, ParticipantNum should be handled as if it's 0.
|-
| 0x68 || 0x200(0x40*8) || Array of [[#NodeInfo|NodeInfo]] with 8 entries, starting with the AccessPoint node.
|-
| 0x268 || 0x2 || Reserved
|-
| 0x26A || 0x2 || AdvertiseData size
|-
| 0x26C || 0x180 || AdvertiseData
|-
| 0x3EC || 0x8C || Reserved
|-
| 0x478 || 0x8 || [6.0.0+] Random AuthenticationId. Set to the output from [[ETicket_services|es]] cmd1501 during network creation.
|}
|}


= ScanFilter =
= SessionId =
This is "nn::ldn::ScanFilter". This is a 0x60-byte struct with 8-byte alignment.
This is "nn::ldn::SessionId".
 
sdknso copies the input ScanFilter to a tmp struct on stack, which is then used with the cmd.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 972: Line 1,037:
! Description
! Description
|-
|-
| 0x0 || 0x8 || When enabled, this will be overwritten if it's -1. The data written for this is the first [[NACP_Format|LocalCommunicationId]] for the user-process loaded via [[Glue_services|arp:r]], if loading fails value 0 is written instead. During filtering if enabled, u8 [[#NetworkInfo]]+0x4B must match 0x2, and this ScanFilter field must match [[#NetworkInfo]]+0x0.
| 0x0 || 0x10 || Random
|-
|}
| 0x8 || 0x2 || Padding
 
= NetworkId =
This is "nn::ldn::NetworkId". This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 0xA || 0x2 || During filtering if enabled, u8 [[#NetworkInfo]]+0x4B must match 0x2, and this ScanFilter field must match [[#NetworkInfo]]+0xA.
! Offset
! Size
! Description
|-
| 0x0 || 0x10 || [[#IntentId|IntentId]]
|-
| 0x10 || 0x10 || [[#SessionId|SessionId]]
|}
 
= CommonNetworkInfo =
This is "nn::ldn::CommonNetworkInfo". This is a 0x30-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 0xC || 0x4 || Padding
! Offset
! Size
! Description
|-
|-
| 0x10 || 0x10 || During filtering if enabled, u8 [[#NetworkInfo]]+0x4B must match 0x2, and this ScanFilter data must match [[#NetworkInfo]]+0x10.
| 0x0 || 0x6 || [[#MacAddress|Bssid]]
|-
|-
| 0x20 || 0x4 || When enabled, must be <=0x3, and during filtering must match u8 [[#NetworkInfo]]+0x4B.
| 0x6 || 0x22 || [[#Ssid|Ssid]]
|-
|-
| 0x24 || 0x6 || [[#MacAddress|MacAddress]]. Only copied with [[#ScanPrivate]]. During filtering if enabled, this must match [[#NetworkInfo]]+0x20.
| 0x28 || 0x2 || Channel
|-
|-
| 0x2A || 0x22 || [[#Ssid]]. During filtering if enabled, this must match [[#NetworkInfo]]+0x26 (the [[#Ssid]] there must be valid for this as well). The strings are compared, without verifying the length field in [[#Ssid]] matches.
| 0x2A || 0x1 || LinkLevel
|-
|-
| 0x4C || 0x10 || Cleared to zero for the tmp struct.
| 0x2B || 0x1 || NetworkType
|-
|-
| 0x5C || 0x4 || [[#ScanFilterFlag|Flag]] (masked with 0x37 for [[#Scan]], with [[#ScanPrivate]] this is masked with 0x3F)
| 0x2C || 0x4 || Reserved
|}
|}


= ScanFilterFlag =
= LdnNetworkInfo =
This is "nn::ldn::ScanFilterFlag".
This is "nn::ldn::LdnNetworkInfo". This is a 0x430-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Value
! Offset
! Description
! Size
! Description
|-
|-
| 0x0 || None
| 0x0 || 0x10 || ServerRandom
|-
|-
| 0x1 || LocalCommunicationId
| 0x10 || 0x2 || SecurityMode
|-
|-
| 0x2 || SessionId
| 0x12 || 0x1 || StationAcceptPolicy
|-
|-
| 0x4 || NetworkType
| 0x13 || 0x1 || Version
|-
| 0x14 || 0x2 || Reserved
|-
| 0x16 || 0x1 || NodeCountMax
|-
| 0x17 || 0x1 || NodeCount
|-
|-
| 0x8 || Bssid
| 0x18 || 0x200 (0x40 * 8) || [[#NodeInfo|Nodes]]
|-
|-
| 0x10 || Ssid
| 0x218 || 0x2 || Reserved
|-
|-
| 0x20 || SceneId
| 0x21A || 0x2 || AdvertiseDataSize
|-
|-
| 0x21 || IntentId
| 0x21C || 0x180 || AdvertiseData
|-
|-
| 0x23 || NetworkId
| 0x39C || 0x8C || Reserved
|-
|-
| 0x3F || All
| 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)
|}
|}


= NetworkConfig =
= NetworkInfo =
This is "nn::ldn::NetworkConfig". This is a 0x20-byte struct with 8-byte alignment.
This is "nn::ldn::NetworkInfo". This is a 0x480-byte struct.


sdknso copies the input NetworkConfig to a tmp struct on stack, which is then used with the cmd ([[#CreateNetwork]], [[#CreateNetworkPrivate]], [[#ConnectPrivate]]).
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,033: Line 1,123:
! Description
! Description
|-
|-
| 0x0 || 0x8 || LocalCommunicationId. Same as [[#NetworkInfo]]+0x0. [[#CreateNetwork]]/[[#CreateNetworkPrivate]]/[[#Connect]]/[[#ConnectPrivate]]: When -1, this is overwritten with the first [[NACP_Format|LocalCommunicationId]] for the user-process loaded via [[Glue_services|arp:r]], if loading fails value 0 is written instead. Otherwise when not -1, if control.nacp loading is successful with [[Glue_services|arp:r]], this field must match one of the LocalCommunicationIds from there otherwise an error is thrown.
| 0x0 || 0x20 || [[#NetworkId|NetworkId]]
|-
|-
| 0x8 || 0x2 || Cleared to zero during the copy.
| 0x20 || 0x30 || [[#CommonNetworkInfo|Common]]
|-
|-
| 0xA || 0x2 || Same as [[#NetworkInfo]]+0xA.
| 0x50 || 0x430 || [[#LdnNetworkInfo|Ldn]]
|}
 
= ScanFilter =
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, which is then used with the cmd.
 
{| class="wikitable" border="1"
|-
|-
| 0xC || 0x4 || Cleared to zero during the copy.
! Offset
! Size
! Description
|-
|-
| 0x10 || 0x2 || s16 Channel, can be zero. Same as [[#NetworkInfo]]+0x48.
| 0x0 || 0x20 || [[#NetworkId|NetworkId]]
|-
|-
| 0x12 || 0x1 || s8. Same as [[#NetworkInfo]]+0x66. [[#CreateNetwork]]/[[#CreateNetworkPrivate]]: Must be 0x1-0x8.
| 0x20 || 0x4 || NetworkType
|-
|-
| 0x13 || 0x1 || Cleared to zero during the copy.
| 0x24 || 0x6 || [[#MacAddress|Bssid]]
|-
|-
| 0x14 || 0x2 || Same as [[#NetworkInfo]]+0x96 (LocalCommunicationVersion from the first [[#NodeInfo|NodeInfo]]). Must not be negative. [[#Connect]]/[[#ConnectPrivate]]: This must match the value for the AccessPoint LocalCommunicationVersion.
| 0x2A || 0x22 || [[#Ssid|Ssid]]
|-
|-
| 0x16 || 0xA || Cleared to zero during the copy.
| 0x4C || 0x10 || Reserved
|}
 
= NodeLatestUpdate =
This is "nn::ldn::NodeLatestUpdate". This is a 0x8-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x5C || 0x4 || [[#ScanFilterFlag|Flag]]
! Size
! Description
|-
| 0x0 || 0x1 || The field in state is reset to zero by [[#GetNetworkInfoLatestUpdate]] after loading it. Official apps checks whether this is non-zero.
|-
| 0x1 || 0x7 || Not initialized with [[#GetNetworkInfoLatestUpdate]].
|}
|}


= WirelessControllerRestriction =
= ScanFilterFlag =
This is "nn::ldn::WirelessControllerRestriction". This is an u32 enum.
This is "nn::ldn::ScanFilterFlag".
 
This is used to determine the value passed to [[BTM_services|btm]] SetWlanMode.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,076: Line 1,162:
!  Description
!  Description
|-
|-
| 0 || Disabled
| 0x0 || None
|-
|-
| 1 || Enabled
| 0x1 || LocalCommunicationId
|}
 
= BluetoothAudioDeviceConnectableMode =
This is "nn::ldn::BluetoothAudioDeviceConnectableMode". This is an u32 enum.
 
{| class="wikitable" border="1"
|-
|-
!  Value
| 0x2 || SessionId
!  Description
|-
|-
| 0 || Disabled
| 0x4 || NetworkType
|-
|-
| 1 || Enabled
| 0x8 || Bssid
|}
 
= SecurityMode =
This is "nn::ldn::SecurityMode". This is an u32 enum.
 
{| class="wikitable" border="1"
|-
|-
!  Value
| 0x10 || Ssid
!  Description
|-
|-
| 0 || Any
| 0x20 || SceneId
|-
|-
| 1 || Product
| 0x21 || IntentId
|-
|-
| 2 || Debug
| 0x23 || NetworkId
|-
|-
| 3 || SystemDebug
| 0x3F || All
|}
|}


= SecurityConfig =
= NetworkConfig =
This is "nn::ldn::SecurityConfig". This is a 0x44-byte struct with 2-byte alignment.
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,120: Line 1,194:
! Description
! Description
|-
|-
| 0x0 || 0x2 || [[#SecurityMode|SecurityMode]] (overwritten by [[#CreateNetwork]]/[[#CreateNetworkPrivate]] and [[#Connect]]/[[#ConnectPrivate]], the value used internally by these cmds must be 1-3)
| 0x0 || 0x10 || [[#IntentId|IntentId]]
|-
| 0x10 || 0x2 || Channel
|-
| 0x12 || 0x1 || NodeCountMax
|-
| 0x13 || 0x1 || Reserved
|-
|-
| 0x2 || 0x2 || PassphraseSize (must be 0x10-0x40)
| 0x14 || 0x2 || LocalCommunicationVersion
|-
|-
| 0x4 || 0x40 || Passphrase (used with key derivation)
| 0x16 || 0xA || Reserved
|}
|}


Type:
= WirelessControllerRestriction =
* 1-2: Broadcast Action frame data is encrypted and is verified with SHA256.
This is "nn::ldn::WirelessControllerRestriction". This is an u32 enum.
* 3: Broadcast Action frame data is plaintext and is verified with SHA256.


* 1: Data frames are encrypted.
This is used to determine the value passed to [[BTM_services|btm]] SetWlanMode.
* 2-3: Data frames for normal data-transfer are plaintext - the network is Open.
 
= SecurityParameter =
This is "nn::ldn::SecurityParameter". This is a 0x20-byte struct with 1-byte alignment.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Value
! Size
! Description
! Description
|-
|-
| 0x0 || 0x10 || ServerRandom (used with the same key derivation as [[#SecurityConfig]])
| 0 || Disabled
|-
|-
| 0x10 || 0x10 || [[#SessionId|SessionId]]
| 1 || Enabled
|}
|}


= SessionId =
= WirelessAudioRestriction =
This is "nn::ldn::SessionId".
This is "nn::ldn::WirelessAudioRestriction". This is an u32 enum.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Value
! Size
! Description
! Description
|-
| 0 || Disabled
|-
|-
| 0x0 || 0x10 || Random
| 1 || Enabled
|}
|}


= UserConfig =
= SecurityMode =
This is "nn::ldn::UserConfig". This is a 0x30-byte struct with 1-byte alignment.
This is "nn::ldn::SecurityMode". This is an u32 enum.
 
sdknso copies the input UserConfig to a tmp struct on stack, which is then used with the cmd.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Value
! Size
! Description
! Description
|-
|-
| 0x0 || 0x21 || UserName (NUL-terminated string for the user nickname)
| 0 || Any
|-
|-
| 0x21 || 0xF || Reserved (cleared to zero during the copy)
| 1 || Product
|-
| 2 || Debug
|-
| 3 || SystemDebug
|}
|}


= AddressEntry =
Value:
This is "nn::ldn::AddressEntry". This is a 0xC-byte struct.
* 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,185: Line 1,268:
! Description
! Description
|-
|-
| 0x0 || 0x4 || [[#Ipv4Address]]
| 0x0 || 0x2 || [[#SecurityMode|SecurityMode]] (overwritten by [[#CreateNetwork]]/[[#CreateNetworkPrivate]] and [[#Connect]]/[[#ConnectPrivate]], the value used internally by these cmds must be 1-3)
|-
|-
| 0x4 || 0x6 || [[#MacAddress|MacAddress]]
| 0x2 || 0x2 || PassphraseSize (must be 0x10-0x40)
|-
|-
| 0xA || 0x2 || Reserved
| 0x4 || 0x40 || Passphrase (used with key derivation)
|}
|}


= AcceptPolicy =
= SecurityParameter =
This is "nn::ldn::AcceptPolicy". This is an u8.
This is "nn::ldn::SecurityParameter". This is a 0x20-byte struct with 1-byte alignment.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Value
! Offset
! Description
! Size
! Description
|-
|-
| 0 || AlwaysAccept
| 0x0 || 0x10 || ServerRandom (used with the same key derivation as [[#SecurityConfig]])
|-
|-
| 1 || AlwaysReject
| 0x10 || 0x10 || [[#SessionId|SessionId]]
|-
| 2 || BlackList (addresses in the [[#AddAcceptFilterEntry|list]] are not allowed)
|-
| 3 || WhiteList (only addresses in the [[#AddAcceptFilterEntry|list]] are allowed)
|}
|}


= MacAddress =
= UserConfig =
This is "nn::ldn::MacAddress". This is a 6-byte struct with 1-byte alignment.
This is "nn::ldn::UserConfig". This is a 0x30-byte struct with 1-byte alignment.


= NodeInfo =
sdknso copies the input UserConfig to a tmp struct on stack, which is then used with the cmd.
This is "nn::ldn::NodeInfo".
 
The fields listed as Reserved 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,223: Line 1,300:
! Description
! Description
|-
|-
| 0x0 || 0x4 || [[#Ipv4Address]]
| 0x0 || 0x21 || UserName (NUL-terminated string for the user nickname)
|-
|-
| 0x4 || 0x6 || [[#MacAddress|MacAddress]]
| 0x21 || 0xF || Reserved (cleared to zero during the copy)
|-
|}
| 0xA || 0x1 || NodeId
 
= AddressEntry =
This is "nn::ldn::AddressEntry". This is a 0xC-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 0xB || 0x1 || IsConnected
! Offset
! Size
! Description
|-
|-
| 0xC || 0x21 || UserName (first 0x21-bytes of [[#UserConfig]])
| 0x0 || 0x4 || [[#Ipv4Address]]
|-
|-
| 0x2D || 0x1 || Reserved
| 0x4 || 0x6 || [[#MacAddress|MacAddress]]
|-
|-
| 0x2E || 0x2 || LocalCommunicationVersion
| 0xA || 0x2 || Reserved
|-
| 0x30 || 0x10 || Reserved
|}
|}


= ConnectOption =
= AcceptPolicy =
This is "nn::ldn::ConnectOption". This is an u32 bitmask.
This is "nn::ldn::AcceptPolicy". This is an u8.
 
 
There's two versions of the sdknso funcs for [[#Connect]]/[[#ConnectPrivate]]: the version where the ConnectOption isn't user-specified uses a default value of 0x1 for it, with the same ShowError code without the bit0 check.
{| class="wikitable" border="1"
 
|-
When bit0 here is set after using the above cmds, the sdknso funcs will use [[Error_Applet|ShowError]] with the returned Result if: (rc & 0x3FE1FF) == 0xE0CB.
!  Value
 
!  Description
This must be <=0x1, besides this validation ConnectOption is ignored by [[#Connect]]/[[#ConnectPrivate]].
|-
 
| 0 || AlwaysAccept
= DisconnectReason =
|-
This is "nn::ldn::DisconnectReason".
| 1 || AlwaysReject
|-
| 2 || BlackList (addresses in the [[#AddAcceptFilterEntry|list]] are not allowed)
|-
| 3 || WhiteList (only addresses in the [[#AddAcceptFilterEntry|list]] are allowed)
|}
 
= ConnectOption =
This is "nn::ldn::ConnectOption". This is an u32 bitmask.
 
There's two versions of the sdknso funcs for [[#Connect]]/[[#ConnectPrivate]]: the version where the ConnectOption isn't user-specified uses a default value of 0x1 for it, with the same ShowError code without the bit0 check.
 
When bit0 here is set after using the above cmds, the sdknso funcs will use [[Error_Applet|ShowError]] with the returned Result if: (rc & 0x3FE1FF) == 0xE0CB.
 
This must be <=0x1, besides this validation ConnectOption is ignored by [[#Connect]]/[[#ConnectPrivate]].
 
= DisconnectReason =
This is "nn::ldn::DisconnectReason".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,291: Line 1,389:
|}
|}


= MacAddress =
= Protocol =
This is "nn::lp2p::MacAddress". Same as [[#MacAddress|MacAddress]].
This is "nn::ldn::Protocol". This is an u32 enum.
 
= 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"
{| class="wikitable" border="1"
|-
|-
! Offset
! Value
! Size
! Description
! Description
|-
| 0 || Default
|-
|-
| 0x0 || || <code>struct sockaddr</code> for the IP address.
| 1 || NX
|-
|-
| 0x24 || 0x6 || [[#MacAddress_2|MacAddress]]
| 3 || (NXAndOunce?)
|}
|}


= GroupInfo =
The Initialize* cmds configure state the same as using [[#SetProtocol|SetProtocol]] with Protocol NX.
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.
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.


[[#Scan_2|Scan]] only uses the following fields for the cmd input struct: SupportedPlatform/Priority, Frequency/Channel, and PresharedKeyBinarySize/PresharedKey.
= ActionFrameSettings =
This is "nn::ldn::ActionFrameSettings". This is a 0x80-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,326: Line 1,420:
! Description
! Description
|-
|-
| 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.
| 0x0 || 0x8 || LocalCommunicationId
|-
|-
| 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.
| 0x8 || 0x34 || Reserved
|-
|-
| 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.
| 0x3C || 0x2 || SecurityMode
|-
|-
| 0x1E || 0x21 || ServiceName ("GROUP NAME (SSID)"). NUL-terminated string. See below.
| 0x3E || 0x2 || PassphraseSize (Must be 0x10-0x40)
|-
|-
| 0x3F || 0x1 || s8 Flags count. Must be <=0x3F.
| 0x40 || 0x40 || Passphrase
|}
 
SecurityMode must be 1-2. The same SecurityMode override functionality from elsewhere is used here.
 
= MessageFlagSet =
This is "nn::ldn::MessageFlagSet". This is a BitFlagSet object for [[#MessageFlag]].
 
= MessageFlag =
This is "nn::ldn::MessageFlag".
 
{| class="wikitable" border="1"
|-
|-
| 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).
!  Value
!  Description
|-
|-
| 0x80 || 0x1 || SupportedPlatform. Must match value 1. 0 is PlatformIdNX, 1 is PlatformIdRcd.
| 0 ||  
|-
|}
| 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>.
 
|-
[[#SendActionFrame|SendActionFrame]]/[[#RecvActionFrame|RecvActionFrame]] handles bit0 the same way as the MessageFlag with lp2p [[#SendToOtherGroup|SendToOtherGroup]]/[[#RecvFromOtherGroup|RecvFromOtherGroup]].
| 0x82 || 0x1 ||
 
|-
= MacAddress =
| 0x84 || 0x2 || Frequency. Wifi frequency: 24 = 2.4GHz, 50 = 5GHz.
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"
|-
|-
| 0x86 || 0x2 || s16 Channel ("CHANNEL"). Wifi channel number. 0 = use default, otherwise this must be one of the following depending on the frequency field:
! Offset
* 24: 1, 6, 11.
! Size
* 50: 36, 40, 44, 48.
! 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 || || <code>struct sockaddr</code> for the IP address.
|-
|-
| 0x89 || 0x1 || PerformanceRequirement.
| 0x24 || 0x6 || [[#MacAddress_2|MacAddress]]
|-
|}
| 0x8A || 0x1 || Security type, used during key derivation. 0 = use defaults, 1 = plaintext, 2 = encrypted. [11.0.0+] 3: Standard WPA2-PSK.
 
|-
= GroupInfo =
| 0x8B || 0x1 || StaticAesKeyIndex. s8, used as the array-index for selecting the KeySource used with [[SPL_services#GenerateAesKek|GenerateAesKek]] during key derivation. Should be 1-2, otherwise GenerateAesKek is skipped and zeros are used for the AccessKey instead.
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
|-
| 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.
|-
|-
| 0x8D || 0x1 || Priority. Must match one of the following, depending on the used service (doesn't apply to [[#Join]]): 55 = SystemPriority (lp2p:sys), 90 = ApplicationPriority (lp2p:app and lp2p:sys).
| 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.
|-
|-
| 0x8E || 0x1 || StealthEnabled. Bool flag, controls whether the SSID is hidden.
| 0x1E || 0x21 || ServiceName ("GROUP NAME (SSID)"). NUL-terminated string. See below.
|-
|-
| 0x8F || 0x1 || If zero, a default value of 0x20 is used.
| 0x3F || 0x1 || s8 Flags count. Must be <=0x3F.
|-
|-
| 0x1C0 || 0x1 || PresharedKeyBinarySize. Must be 0x20 for PresharedKeyBinary. [11.0.0+] With WPA2-PSK, this must be value 1.
| 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).
|-
|-
| 0x1C1 || 0x3F ([9.0.0-10.2.0] 0x20) || PresharedKey. Used to derive encryption keys A and C. [11.0.0+] With WPA2-PSK, this is the passphrase string (length must be at least 8).
| 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>.
In order for the ServiceName to be valid without a new one being generated, the following checks must pass:
|-
* It loops through the characters in the string, looking for the first '_' character:
| 0x82 || 0x1 ||
** The loop will exit once a '_' character is found.
|-
** The character must be '-', or alphanumeric (lowercase/uppercase), otherwise the function will immediately return failure.
| 0x84 || 0x2 || Frequency. Wifi frequency: 24 = 2.4GHz, 50 = 5GHz.
** The loop will also exit once string_pos is >19, in which case the function will also immediately return failure.
|-
* Then it checks the 11 characters which follow the above:
| 0x86 || 0x2 || s16 Channel ("CHANNEL"). Wifi channel number. 0 = use default, otherwise this must be one of the following depending on the frequency field:
** The character must be hex: '0'-'9', or 'A-F' / 'a-'f.
* 24: 1, 6, 11.
* The following character must be a NUL-terminator.
* 50: 36, 40, 44, 48.
* The last hex character above, then the characters for the whole string prior to the last hex character are summed. return sum % 0x2B == 0. u32 is used for these calculations. (Return success when sum is a multiple of 0x2B, otherwise return failure)
|-
 
| 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.
If the above fails, then the following runs, otherwise it just returns 0:
|-
* It loops through the characters in the string.
| 0x89 || 0x1 || PerformanceRequirement.
** The character must be '-', or alphanumeric (lowercase/uppercase), otherwise the function will immediately return failure.
|-
** The loop will exit once string_pos>20 is reached, or when a NUL-terminator is reached.
| 0x8A || 0x1 || Security type, used during key derivation. 0 = use defaults, 1 = plaintext, 2 = encrypted. [11.0.0+] 3: Standard WPA2-PSK.
* Once finished, success is returned if string_pos-1 is <20, otherwise failure is returned (which also immediately occurs if the first character is a NUL-terminator).
|-
| 0x8B || 0x1 || StaticAesKeyIndex. s8, used as the array-index for selecting the KeySource used with [[SPL_services#GenerateAesKek|GenerateAesKek]] during key derivation. Should be 1-2, otherwise GenerateAesKek is skipped and zeros are used for the AccessKey instead.
|-
| 0x8D || 0x1 || Priority. Must match one of the following, depending on the used service (doesn't apply to [[#Join]]): 55 = SystemPriority (lp2p:sys), 90 = ApplicationPriority (lp2p:app and lp2p:sys).
|-
| 0x8E || 0x1 || StealthEnabled. Bool flag, controls whether the SSID is hidden.
|-
| 0x8F || 0x1 || If zero, a default value of 0x20 is used.
|-
| 0x1C0 || 0x1 || PresharedKeyBinarySize. Must be 0x20 for PresharedKeyBinary. [11.0.0+] With WPA2-PSK, this must be value 1.
|-
| 0x1C1 || 0x3F ([9.0.0-10.2.0] 0x20) || PresharedKey. Used to derive encryption keys A and C. [11.0.0+] With WPA2-PSK, this is the passphrase string (length must be at least 8).
|}


If the above fails, an error is returned, otherwise a new ServiceName is generated:
In order for the ServiceName to be valid without a new one being generated, the following checks must pass:
* Up to 20 characters are copied from the original ServiceName to the output ServiceName, stopping once the limit is reached or when a NUL-terminator is reached.
* It loops through the characters in the string, looking for the first '_' character:
* '_' is appended to the string.
** The loop will exit once a '_' character is found.
* <code>nn::util::TSNPrintf({strptr following the above character}, {remaining size}, "%02X%02X%02X%02X%02X", [[#GroupId|GroupId_byte3]], [[#GroupId|GroupId_byte4]], [[#GroupId|GroupId_byte5]], ([[SPL_services#IsDevelopment|IsDevelopment]] ? 0x80 : 0) | 0x1, 0);</code>
** The character must be '-', or alphanumeric (lowercase/uppercase), otherwise the function will immediately return failure.
* Then the last character is set to the output from a calling a function:
** The loop will also exit once string_pos is >19, in which case the function will also immediately return failure.
* Then it checks the 11 characters which follow the above:
** The character must be hex: '0'-'9', or 'A-F' / 'a-'f.
* The following character must be a NUL-terminator.
* The last hex character above, then the characters for the whole string prior to the last hex character are summed. return sum % 0x2B == 0. u32 is used for these calculations. (Return success when sum is a multiple of 0x2B, otherwise return failure)
 
If the above fails, then the following runs, otherwise it just returns 0:
* It loops through the characters in the string.
** The character must be '-', or alphanumeric (lowercase/uppercase), otherwise the function will immediately return failure.
** The loop will exit once string_pos>20 is reached, or when a NUL-terminator is reached.
* Once finished, success is returned if string_pos-1 is <20, otherwise failure is returned (which also immediately occurs if the first character is a NUL-terminator).
 
If the above fails, an error is returned, otherwise a new ServiceName is generated:
* Up to 20 characters are copied from the original ServiceName to the output ServiceName, stopping once the limit is reached or when a NUL-terminator is reached.
* '_' is appended to the string.
* <code>nn::util::TSNPrintf({strptr following the above character}, {remaining size}, "%02X%02X%02X%02X%02X", [[#GroupId|GroupId_byte3]], [[#GroupId|GroupId_byte4]], [[#GroupId|GroupId_byte5]], ([[SPL_services#IsDevelopment|IsDevelopment]] ? 0x80 : 0) | 0x1, 0);</code>
* Then the last character is set to the output from a calling a function:
** All string characters which were already written are summed same way as above. Then: <code>return character_lookup_table[sum % 0x2B];</code> (If the length passed to this function is 0, this will instead just return character_lookup_table[0])
** All string characters which were already written are summed same way as above. Then: <code>return character_lookup_table[sum % 0x2B];</code> (If the length passed to this function is 0, this will instead just return character_lookup_table[0])
*** character_lookup_table contains 0x2B entries: [V-A][k-a][5-0][Z-W].
*** character_lookup_table contains 0x2B entries: [V-A][k-a][5-0][Z-W].
Line 1,426: Line 1,584:
= 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 Acton frame.
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]] data with the specified data-size}. The [[#ActionFrame]]/data-frame keys are derived with the same func, the only difference is the input passed to this func + the passed constant data. The key derived by ldn is used directly as the static CCMP key for all data-frames (CCMP / MIC is standard).
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,436: Line 1,596:
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,465: Line 1,625:
| 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 || 0x3 || Unused, zeros.
| 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,477: Line 1,639:
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 || See below.
| 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 || || 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 || 0x10 || Only present with AuthEncryptionType1: AES-128-GCM MAC tag.
|-
| 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.


Station->AccessPoint frame, relative to +0x0 above (frame size depends on whether +0xAC is enabled):
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,498: Line 1,667:
! Description
! Description
|-
|-
| 0x38 || 0x10 || The Station sets this to random data. Unused by the AccessPoint, except for copying into the response.
| 0x0 || 0x20 || [[#UserConfig]]+0. Copied into state by the AccessPoint.
|-
|-
| 0x48 || 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.
|-
|-
| 0x68 || 0x2 || Big-endian LocalCommunicationVersion. Byte-swapped by the AccessPoint then copied into state.
| 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.
|-
|-
| 0x6A || 0x1E || Zeros, unused by the AccessPoint.
| 0x23 || 0x1D || Zeros, unused by the AccessPoint.
|-
|-
| 0x88 || 0x24 || [6.0.0+] Zeros, unused by the AccessPoint.
| 0x40 || 0x24 || [6.0.0+] Zeros, unused by the AccessPoint.
|-
|-
| 0xAC || 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.
| 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 frame, relative to +0x0 above (frame size depends on whether +0x48/+0xCC are enabled):
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,519: Line 1,688:
! Description
! Description
|-
|-
| 0x38 || 0x10 || +0x38 from the data originally sent by the Station. The Station verifies that this matches the previously sent data.
| 0x0 || 0x1 ||  
|-
|-
| 0x48 || 0x40 || Zeros. [6.0.0+] Only included in the frame if it's enabled (+0x0 [[#AuthVersion]] >= 3). Unused by the Station.
| 0x1 || 0x3F || Zeros. [6.0.0-?] Only included in the frame if it's enabled (+0x0 [[#AuthVersion]] >= 3). Unused by the Station.
|-
|-
| 0x88 || 0x44 || [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.
|-
|-
| 0xCC || 0x100 || [6.0.0+] If enabled, Authentication challenge response data. Not included in the frame if it's not enabled.
| 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,540: Line 1,711:
|-
|-
| 3 || [6.0.0+]
| 3 || [6.0.0+]
|-
| 4 || [19.0.0+]
|}
|}


Line 1,574: Line 1,747:
| 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 = encrypted, {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.
| 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, must be <=0x500, and must match {total frame size relative to +0x0 above} + 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}. This is encrypted with AES-128-CTR. The key is derived from the raw 0x20-bytes at +0x0. The CTR is {raw Counter above without byte-swap}, with the rest cleared to zeros.
|}
 
 
The content data at +0x48 follows, which has the size specified above (which must be >=0x500), where all fields are big-endian:
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:
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x10 || [[#NetworkInfo]]+0x50
|-
| 0x10 || 0x2 || [[#NetworkInfo]]+0x60
|-
| 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 [[#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 ||
|-
| 0x6 || 0x2 ||
|}
 
Then the actual data follows (all fields big-endian):
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x1 || [[#AuthVersion]]
|-
|-
| 0x0 || 0x10 || [[#NetworkInfo]]+0x50
| 0x1 || 0x1 || EncryptionType, must match the expected type for the current SecurityMode. 1 = plaintext, 2 = AES-128-GCM.
|-
|-
| 0x10 || 0x2 || [[#NetworkInfo]]+0x60
| 0x2 || 0x2 || Padding
|-
| 0x12 || 0x1 || [[#NetworkInfo]]+0x62
|-
| 0x13 || 0x3 || Unused
|-
| 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
| 0x4 || 0x4 || Counter
|-
|-
| 0x1DA || 0x2 || [[#NetworkInfo]]+0x26A
| 0x8 || 0x8 || LocalCommunicationId
|-
|-
| 0x1DC || 0x180 || [[#NetworkInfo]]+0x26C
| 0x10 || 0x10 || Used with key derivation.
|-
|-
| 0x35C || 0x19C || Unused
| 0x20 || 0x10 || EncryptionType2: AES-128-GCM MAC tag.
|-
|-
| 0x4F8 || 0x8 || [6.0.0+] [[#NetworkInfo]]+0x478
| 0x30 || Remaining frame size || Data payload
|}
|}


The data here is copied into [[#NetworkInfo]].
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.


Node data used in the above array (all fields big-endian), which are copied into the [[#NetworkInfo]] [[#NodeInfo|NodeInfo]] array:
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}.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x4 || [[#Ipv4Address]]
|-
| 0x4 || 0x6 || [[#MacAddress|MacAddress]]
|-
| 0xA || 0x1 || bool IsConnected
|-
| 0xB || 0x1 || Unused
|-
| 0xC || 0x20 || First 0x20-bytes of [[#UserConfig]].
|-
| 0x2C || 0x2 || s16 LocalCommunicationVersion
|-
| 0x2E || 0xA || Unused
|}


== lp2p ==
== lp2p ==
Retrieved from "https://switchbrew.org/wiki/LDN_services"