-
Notifications
You must be signed in to change notification settings - Fork 68
LDN Protocol
This page describes the wireless protocol that is used to communicate with nearby consoles in LDN mode, which is the default mode for local multiplayer on Nintendo Switch.
Unless specified otherwise, everything is encoded in big-endian byte order.
- Overview
- Changelog
- WLAN channels
- SSID
- Authentication
- Encryption keys
-
IP stack
- Advertisement frame
- Authentication frame
- Disconnect frame
LDN enables communication between nearby consoles. LDN operates at the data link layer, so it requires a good understanding of the IEEE 802.11 specification.
The host of the session acts as an access point and broadcasts a vendor-specific action frame every 100 milliseconds. To find nearby consoles, the console scans for these action frames. During host migration the network is destroyed and a new network is created by the new host, after which all consoles reconnect.
Also see: Local Wireless Communication on PC.
System version | LDN version | Changes |
---|---|---|
2.0.0 - 5.1.0 | 2 | Initial version |
6.0.0 - 18.1.0 | 3 | Challenge was added to authentication frame |
19.0.0 - 19.0.1 | 4 | Unknown difference |
The channel on which LDN operates can be specified by games. Allowed channels are:
Band | Channels |
---|---|
2.4 GHz | 1, 6, 11 |
5 GHz | 36, 40, 44, 48 |
By default, LDN operates on one of the channels of the 2.4 GHz band (chosen arbitrarily).
During scanning, Nintendo uses a dwell time of 110 milliseconds.
The SSID of the network contains 32 random hex digits. The network is hidden from other devices by zeroing the SSID in the beacon frame. To find the SSIDs of nearby networks, the console scans for advertisement frames.
When a suitable network has been found (by scanning for advertisement frames on a given set of channels) the console may try to join the network, but Nintendo uses a custom authentication procedure:
- The console joins the network using the open system authentication method. This is standard.
- The console sends an encrypted authentication request to the access point. If the console does not send an authentication request within 5 seconds after step 1, the access point disassociates the console from the network.
- The access point verifies the authentication request and sends an authentication response back to the console. If the console does not receive an authentication response from the access point within 700 milliseconds it resends the authentication request. After three attempts it gives up.
- The console verifies the authentication response. If it is valid, and indicates success, the console is now part of the network and may communicate with other consoles.
LDN supports three different security levels:
- Both advertisement frames and data frames are encrypted.
- Advertisement frames are encrypted, data frames are plaintext.
- Advertisement frames and data frames are both plaintext.
The security level is specified during network creation and is broadcasted as part of the advertisement frame. In practice, the security level will always be set to 1, because security level 2 and 3 are only allowed during development.
Given a 16-byte input key and a buffer of arbitrary size, encryption keys are derived as follows:
-
aes_kek_generation_source
is decrypted with master key generation 0. - The input key is decrypted with the key from step 1.
-
aes_key_generation_source
is decrypted with the key from step 2. - The first 16 bytes of the SHA-256 hash of the input buffer are decrypted with the key from step 3.
For data frames, the input key is f1e7018419a84f711da714c2cf919c9c
and the input buffer looks as follows:
Offset | Size | Description |
---|---|---|
0x0 | 16 | Network key (generated when the network is created) |
0x10 | N | Password specified by game (optional, up to 64 bytes) |
For advertisement frames, see below.
When a console joins the network, the access point immediately assigns it an unused IP address. After joining the network, the console reads its own IP address and the IP addresses of the other consoles from the next advertisement frame. It then keeps monitoring advertisement frames to get notified when a console joins or leaves the network.
IP addresses are of the form 169.254.X.Y
where X is a randomly generated during network creation, and Y is assigned to each station by the host. Because the host is always the first participant of the network, its IP address is always 169.254.X.1
. The broadcast address is 169.254.X.255
.
This is a vendor-specific action frame that is broadcasted by the access point every 100 milliseconds.
Offset | Size | Description |
---|---|---|
0x0 | 1 | Category (127 = vendor-specific) |
0x1 | 3 | OUI (00:22:AA ) |
0x4 | 1 | Protocol id (4 = LDN) |
0x5 | 1 | Padding (always 0) |
0x6 | 2 | Packet type (257 = advertisement) |
0x8 | 2 | Must be 0 |
0xA | 2 | Padding (always 0) |
0xC | Advertisement payload |
Offset | Size | Description |
---|---|---|
0x0 | 32 | Session info |
0x20 | 1 | LDN version |
0x21 | 1 | Encryption type (1=plain, 2=AES-CTR) |
0x22 | 2 | Advertisement data size |
0x24 | 4 | Nonce for AES-CTR algorithm |
0x28 | 32 | SHA-256 hash, calculated over the whole advertisement payload with the hash set to zero |
0x48 | Advertisement data |
If encryption is enabled, the hash and advertisement data are encrypted with AES-CTR. The input buffer for key derivation is the session info, and the input key is 191884743e24c77d87c69e4207d0c438
.
Offset | Size | Description |
---|---|---|
0x0 | 16 | Network key |
0x10 | 2 | Security level |
0x12 | 1 | Station accept policy: 0 = Open participation 1 = Closed participation 2 = Blacklist (provided by game) 3 = Whitelist (provided by game) |
0x13 | 3 | Padding (always 0) |
0x16 | 1 | Maximum number of participants |
0x17 | 1 | Current number of participants |
0x18 | 56 x 8 | Participant list |
0x1D8 | 2 | Padding (always 0) |
0x1DA | 2 | Application data size |
0x1DC | 384 | Application data |
0x35C | 412 | Padding (always 0) |
0x4F8 | 8 | Authentication token (random) |
The authentication token is generated when the network is created and was added in LDN version 3. In previous versions it is set to 0. It is used during authentication.
Offset | Size | Description |
---|---|---|
0x0 | 4 | IP address |
0x4 | 6 | MAC address |
0xA | 1 | Is connected |
0xB | 1 | Padding (always 0) |
0xC | 32 | Username |
0x2C | 2 | Application communication version |
0x2E | 10 | Padding (always 0) |
This is a data frame with ethertype 0x88B7 (OUI extended). It is usually encrypted.
Offset | Size | Description |
---|---|---|
0x0 | 3 | OUI (00:22:AA ) |
0x3 | 2 | Packet type (258 = authentication) |
0x5 | 1 | Padding (always 0) |
0x6 | Authentication data |
Offset | Size | Description |
---|---|---|
0x0 | 1 | LDN version |
0x1 | 1 | Payload size (size & 0xFF ) |
0x2 | 1 | Status code |
0x3 | 1 | 0 = request, 1 = response |
0x4 | 1 | Payload size (size >> 8 ) |
0x5 | 3 | Padding (always 0) |
0x8 | 32 | Session info in little-endian byte order |
0x28 | 16 | Network key |
0x38 | 16 | Authentication key (random bytes) |
0x48 | Authentication payload (request or response) |
This is set to 0 in an authentication request. In an authentication response, it is set to one of the following values:
Value | Description |
---|---|
0 | Success |
1 | Participation denied by policy |
2 | Malformed authentication request |
4 | Authentication request has invalid version number |
5 | Authentication request is unexpected |
6 | Authentication challenge is invalid |
Offset | Size | Description |
---|---|---|
0x0 | 32 | Username |
0x20 | 2 | Application communication version |
0x22 | 30 | Padding (always 0) |
LDN version 3 and later:
Offset | Size | Description |
---|---|---|
0x40 | 0x24 | Always 0 |
0x64 | 0x300 | Authentication challenge (only present if enabled) |
The challenge is always enabled for games, but not for system titles.
LDN version 3 and later:
Offset | Size | Description |
---|---|---|
0x0 | 0x84 | Unknown |
0x84 | 0x100 | Challenge response (only present if enabled) |
The challenge was added to the authentication frame in LDN version 3. Its purpose is to make sure that the game was purchased separately on all communicating consoles. If a single purchase is used on multiple consoles, an error dialog is shown.
Offset | Size | Description |
---|---|---|
0x0 | 4 | Always 0 |
0x4 | 32 | HMAC-SHA256 |
0x24 | 12 | Always 0 |
0x30 | 1 | Always 0 |
0x31 | 1 | Always 0 |
0x32 | 1 | P |
0x33 | 1 | Q |
0x34 | 1 | Debug check (always 0) |
0x35 | 3 | Padding (always 0) |
0x38 | 8 | Authentication token (see advertisement frame) |
0x40 | 8 | Authentication nonce (random) |
0x48 | 8 | Device id |
0x50 | 0x70 | Always 0 |
0xC0 | 0x40 | Unknown (8*P bytes) |
0x100 | 0x200 | Unknown (8*Q bytes) |
The HMAC is calculated over bytes 0x30 - 0x300 and the key is f84b487fb37251c263bf11609036589266af70ca79b44c93c7370c5769c0f602
.
Offset | Size | Description |
---|---|---|
0x0 | 4 | Always 0 |
0x4 | 32 | HMAC-SHA256 |
0x24 | 12 | Always 0 |
0x30 | 1 | Always 0 |
0x31 | 1 | Always 0 |
0x32 | 6 | Padding (always 0) |
0x38 | 8 | Authentication nonce from request |
0x40 | 8 | Device id from request |
0x48 | 8 | Own device id |
0x50 | 0xB0 | Always 0 |
The HMAC is calculated over bytes 0x30 - 0x100 and the key is f84b487fb37251c263bf11609036589266af70ca79b44c93c7370c5769c0f602
.
This is a data frame with ethertype 0x88B7 (OUI extended). It is usually encrypted. This frame is sent when the access point disconnects a station from the network.
Offset | Size | Description |
---|---|---|
0x0 | 3 | OUI (00:22:AA ) |
0x3 | 2 | Packet type (259 = disconnect) |
0x5 | 1 | Padding (always 0) |
0x6 | Disconnect data |
Offset | Size | Description |
---|---|---|
0x0 | 1 | Disconnect reason |
0x1 | 31 | Unused (always 0) |
Value | Description |
---|---|
3 | Network is destroyed by host |
4 | Network is destroyed forcefully (e.g. when the host closes the game during a match) |
5 | Station is rejected by host |
Offset | Size | Description |
---|---|---|
0x0 | 8 | Local communication id (usually the title id) |
0x8 | 2 | Padding (always 0) |
0xA | 2 | Game mode |
0xC | 4 | Padding (always 0) |
0x10 | 16 | SSID (random bytes) |
- Home
-
NEX
- PRUDP Protocol
- RMC Protocol
-
NEX Services
- Common
- Nintendo
- Kerberos Authentication
- Hpp Server
- NPLN
- Pia
- Switch Servers
- Other Pages