SPL services

SPL ("Secure Platform services") is responsible for handling all cryptographic operations within the system and relaying them to the Secure Monitor when necessary.

During [1.0.0-3.0.2], the only existing services were "csrng" and "spl:". However, in [4.0.0+] the "spl:" service was refactored and split into new services with different permission levels. Each service exposes the IPC command list differently in order to prevent cryptographic operations to take place in the wrong context.

csrng

This is "nn::spl::detail::IRandomInterface".

Cmd	Name
0	#GenerateRandomBytes

GenerateRandomBytes

Takes a type-6 buffer and fills it with random data from GetRandomBytes SMC. Same command for "spl:" and "csrng" services.

spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu

These are "nn::spl::detail::IGeneralInterface", "nn::spl::detail::ICryptoInterface", "nn::spl::detail::IFsInterface", "nn::spl::detail::ISslInterface", "nn::spl::detail::IEsInterface" and "nn::spl::detail::IManuInterface".

[2.0.0+] Where previously only one AES keyslot was used, there is now support for 4 of them.

[2.0.0+] When the session closes, all allocated AES keyslots are automatically freed.

Cmd	Name	Permissions
0	#GetConfig	spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
1	#ExpMod	spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
2	#GenerateAesKek	spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
3	#LoadAesKey	spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
4	#GenerateAesKey	spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
5	#SetConfig	spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
7	#GenerateRandomBytes	spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
9	#ImportLotusKey	spl:fs
10	#DecryptLotusMessage	spl:fs
11	#IsDevelopment	spl:, spl:mig, spl:fs, spl:ssl spl:es, spl:manu
12	#GenerateSpecificAesKey	spl:fs
13	#DecryptRsaPrivateKey	spl:ssl, spl:es, spl:manu
14	#DecryptAesKey	spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
15	#CryptAesCtr	spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
16	#ComputeCmac	spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
17	#ImportEsKey	spl:es
18	#UnwrapTitleKey	spl:es
19	#LoadTitleKey	spl:fs
20	[2.0.0+] #UnwrapCommonTitleKey	spl:es
21	[2.0.0+] #AllocateAesKeyslot	spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
22	[2.0.0+] #FreeAesKeyslot	spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
23	[2.0.0+] #GetAesKeyslotAvailableEvent	spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
24	[3.0.0+] #SetBootReason	spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
25	[3.0.0+] #GetBootReason	spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
26	[5.0.0+] ImportSslKey	spl:ssl
27	[5.0.0+] SslExpMod	spl:ssl
28	[5.0.0+] ImportDrmKey	spl:es
29	[5.0.0+] DrmExpMod	spl:es
30	[5.0.0+] ReEncryptRsaPrivateKey	spl:manu
31	[5.0.0+] GetPackage2Hash	spl:fs
31	[6.0.0+] UnwrapElicenseKey	spl:es
32	[6.0.0+] #LoadElicenseKey	spl:es

GetConfig

Wrapper for GetConfig SMC.

Takes a u32 (ConfigItem), and returns one or more u64s (ConfigVal).

ExpMod

Wrapper for ExpMod SMC.

Takes one type-10 (C descriptor) buffer (data_out_buf) and 3 type-9 (X descriptor) buffers (data_in_buf, exp_in_buf and mod_in_buf).

Performs asymmetric crypto with user supplied modulus and exponent.

GenerateAesKek

Wrapper for GenerateAesKek SMC.

Takes a 16-byte EKS (Encryption Key Source) and two words (KeyGeneration and option) as input.

Returns a scrambled sealed KEK (Key Encryption Key used as key_x).

LoadAesKey

Wrapper for LoadAesKey SMC.

Takes a u32 (keyslot) and two 16-byte keys (key_x and key_y).

Sets the specified keyslot with a key generated from key_x and key_y.

[2.0.0+] Now verifies that the keyslot in use (0..3) is allocated by the current spl session, otherwise errors with 0xD21A. Previously, keyslot was hardcoded to 0.

GenerateAesKey

Takes a 16-byte KEK (key_x) and a 16-byte encrypted key (enc_key).

Generates a new key by decrypting (AES-ECB) enc_key with a key generated from the supplied key_x and a fixed key_y set with LoadAesKey SMC.

[2.0.0+] Previously, it always used keyslot 0. Now it tries to allocate a keyslot to be used and returns 0xD01A if they're all busy. When the command is done, the keyslot is released.

SetConfig

Wrapper for SetConfig SMC.

Takes a u32 (ConfigItem) and a u64 (ConfigVal).

ConfigItem	Name
13	IsChargerHiZModeEnabled

Any other ConfigItem, besides 13, can't be set.

ImportLotusKey

Wrapper for ImportLotusKey SMC.

Takes one type-9 (X descriptor) buffer (enc_privk_in_buf), a 16-byte KEK (key_x), a 16-byte key (key_y) and a u32 (version). version is 0 for normal keys or 1 for extended keys.

Decrypts enc_privk_in_buf with a key generated from key_x and key_y and imports it for later usage.

[5.0.0+] This now calls ReEncryptRsaPrivateKey SMC instead.

DecryptLotusMessage

Takes 3 type-9 (X descriptor) buffers (data_in_buf, mod_in_buf and label_hash_in_buf).

Uses SecureExpMod SMC to decrypt data_in_buf using the private key imported with #ImportLotusKey and the supplied mod_in_buf and label_hash_in_buf.

IsDevelopment

No input params.

Uses #GetConfig internally with id=6. Returns true if output from that is 0, or if the SMC returned error 2.

Returns an u8 flag for whether the system is devunit. Output flag is 0 on retail.

GenerateSpecificAesKey

Wrapper for GenerateSpecificAesKey SMC.

Takes a 16-byte seed (key_seed) and two words (KeyGeneration and option) as input.

Returns a scrambled key (key_a).

DecryptRsaPrivateKey

Wrapper for DecryptRsaPrivateKey SMC.

Takes one type-10 (C descriptor) buffer (dec_privk_out_buf), one type-9 (X descriptor) buffer (enc_privk_in_buf), a 16-byte KEK (key_x), a 16-byte key (key_y) and a u32 (version). version is 0 for normal keys or 1 for extended keys.

Decrypts enc_privk_in_buf into dec_privk_out_buf with a key generated from key_x and key_y.

Used by SSL-sysmodule for TLS client-privk.

[5.0.0+] This now calls DecryptOrImportRsaPrivateKey SMC instead.

DecryptAesKey

Takes a 16-byte encrypted key (enc_key) and two words (KeyGeneration and option) as input.

Decrypts (AES-ECB) enc_key with a key generated from fixed key_x and key_y set with LoadAesKey SMC and returns a 16-byte decrypted key (dec_key).

[2.0.0+] Introduced same keyslot allocation code as for #GenerateAesKey.

CryptAesCtr

Takes a type-0x46 (B descriptor) buffer (data_out_buf), a u32 (keyslot), a type-0x45 (A descriptor) buffer (data_in_buf) and a 16-byte CTR (aes_ctr).

Uses ComputeAes SMC to decrypt data_in_buf into data_out_buf, using the key set in the specified keyslot.

[2.0.0+] Verifies the keyslot was allocated in the current session.

ComputeCmac

Wrapper for ComputeCmac SMC.

Takes one type-9 (X descriptor) buffer (data_in_buf) and a u32 (type?).

Returns a 16-byte CMAC calculated over data_in_buf.

[2.0.0+] Verifies the keyslot was allocated in the current session.

ImportEsKey

Wrapper for ImportEsKey SMC.

Takes one type-9 (X descriptor) buffer (enc_privk_in_buf), a 16-byte KEK (key_x), a 16-byte key (key_y) and a u32 (version). version is 0 for normal keys or 1 for extended keys.

Decrypts enc_privk_in_buf with a key generated from key_x and key_y and imports it for later usage.

[5.0.0+] This now calls ReEncryptRsaPrivateKey SMC instead.

UnwrapTitleKey

Wrapper for UnwrapTitleKey SMC.

Takes one type-10 (C descriptor) buffer (data_out_buf) and 3 type-9 (X descriptor) buffers (data_in_buf, mod_in_buf and label_hash_in_buf).

[3.0.0+] Now takes an additional 4-bytes of input.

Decrypts data_in_buf into data_out_buf using the private key imported with #ImportEsKey and the supplied mod_in_buf. Afterwards, verifies RSA-OAEP encoding using label_hash_in_buf.

Returns an u32 (dec_data_size).

LoadTitleKey

Wrapper for LoadTitleKey SMC.

Takes a u32 (keyslot) and a 16-byte sealed titlekey.

Sets the specified keyslot with the titlekey.

[2.0.0+] Verifies the keyslot was allocated in the current session.

UnwrapCommonTitleKey

Wrapper for UnwrapCommonTitleKey SMC.

Takes a 16-byte EKS (Encryption Key Source).

[3.0.0+] Now takes an additional 4-bytes of input.

Returns a sealed titlekey.

AllocateAesKeyslot

Returns an allocated keyslot, or 0xD01A if all keyslots are taken. You need to allocate a keyslot before using AES functions.

FreeAesKeyslot

Takes a single u32 and frees the keyslot. The keyslot must have been allocated by current session otherwise 0xD21A will be returned.

GetAesKeyslotAvailableEvent

Returns an event handle for synchronizing with the AES keyslots.

SetBootReason

Sets a static dword in spl .bss to the input u32 BootReason.

[4.0.0+] returns 0xD41A if a value has been previously set without being gotten.

GetBootReason

Returns the static dword BootReason in spl .bss that can be set via #SetBootReason.

[4.0.0+] returns 0xD61A if a value has not previously been set, and unsets the value after getting it.

LoadElicenseKey

Same as LoadTitleKey.