Changes

Jump to navigation Jump to search
10,898 bytes added ,  18:44, 12 May 2020
no edit summary
SPL ("Secure Platform services") is responsible for handling all cryptographic operations within the system and relaying them to the [[SMC|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.
 
In [2.0.0+] where previously only one AES keyslot was used, there is now support for 4 of them and when the session closes, all allocated AES keyslots are automatically freed.
 
= csrng =
This is "nn::spl::detail::IRandomInterface".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GenerateRandomBytes]]
|}
 
== GenerateRandomBytes ==
Takes an output type-0xA buffer and fills it with random data from [[SMC#GenerateRandomBytes|GenerateRandomBytes SMC]]. Same command for "spl:" and "csrng" services, except for buffer-type.
 
= spl: =
This is "nn::spl::detail::IGeneralInterface".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetConfig]]
|-
| 1 || [[#ModularExponentiate]]
|-
| 5 || [[#SetConfig]]
|-
| 7 || [[#GenerateRandomBytes]]
|-
| 11 || [[#IsDevelopment]]
|-
| 24 || [3.0.0+] [[#SetBootReason]]
|-
| 25 || [3.0.0+] [[#GetBootReason]]
|}
 
== GetConfig ==
Wrapper for [[SMC#GetConfig|GetConfig SMC]].
 
Takes an input u32 '''ConfigItem'''. Returns one or more output u64s '''ConfigValue'''.
 
== ModularExponentiate ==
Wrapper for [[SMC#ModularExponentiate|ModularExponentiate SMC]].
 
Takes an output type-0xA buffer '''DataOut''' and 3 input type-0x9 buffers '''DataIn''', '''ExpIn''' and '''ModIn'''.
 
Performs asymmetric crypto with user supplied modulus and exponent.
 
== GenerateAesKek ==
Wrapper for [[SMC#GenerateAesKek|GenerateAesKek SMC]].
 
Takes an input 16-byte '''KeySource''' and two input u32s '''Generation''' and '''Option'''. Returns an output 16-byte '''AccessKey'''.
 
== LoadAesKey ==
Wrapper for [[SMC#LoadAesKey|LoadAesKey SMC]].
 
Takes an input u32 '''Keyslot''' , an input 16-byte '''AccessKey''' and an input 16-byte '''KeySource'''.
 
Sets the specified '''Keyslot''' with a key generated from '''AccessKey''' and '''KeySource'''.
 
[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 an input 16-byte '''AccessKey''' and an input 16-byte '''KeySource'''. Returns an output 16-byte '''AesKey'''.
 
Generates a new key by decrypting (AES-ECB) '''KeySource''' with a key generated from the supplied '''AccessKey''' and the key set with [[SMC#LoadAesKey|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 [[SMC#SetConfig|SetConfig SMC]].
 
Takes an input u32 '''ConfigItem''' and an input u64 '''ConfigValue'''.
 
Only '''ConfigItem''' 13 (IsChargerHiZModeEnabled) can be set.
 
== ImportLotusKey ==
Wrapper for [[SMC#DecryptAndImportLotusKey|DecryptAndImportLotusKey SMC]].
 
Takes an input type-0x9 buffer '''DataIn''', an input 16-byte '''AccessKey''', an input 16-byte '''KeySource''' and an input u32 '''Version''' (0 for normal keys or 1 for extended keys).
 
Decrypts '''DataIn''' with a key generated from '''AccessKey''' and '''KeySource''' and imports it for later usage.
 
[5.0.0+] The '''Version''' argument was removed and this now calls the [[SMC#ReencryptDeviceUniqueData|ReencryptDeviceUniqueData SMC]] instead.
 
== DecryptLotusMessage ==
Takes 3 input type-0x9 buffers '''DataIn''', '''ModIn''' and '''LabelHashIn'''.
 
Uses the [[SMC#ModularExponentiateByStorageKey|ModularExponentiateByStorageKey SMC]] to decrypt '''DataIn''' using the private key imported with [[#ImportLotusKey]] and the supplied '''ModIn''' and '''LabelHashIn'''.
 
== IsDevelopment ==
No input. Returns an output u8 bool.
 
Uses [[#GetConfig]] internally.
 
== GenerateSpecificAesKey ==
Wrapper for [[SMC#GenerateSpecificAesKey|GenerateSpecificAesKey SMC]].
 
Takes an input 16-byte '''KeySource''' and two input u32s '''Generation''' and '''Option'''. Returns an output 16-byte '''AesKey'''.
 
== DecryptDeviceUniqueData ==
Wrapper for [[SMC#DecryptDeviceUniqueData|DecryptDeviceUniqueData SMC]].
 
Takes an output type-0xA buffer '''DataOut''', an input type-0x9 '''DataIn''', an input 16-byte '''AccessKey''', an input 16-byte '''KeySource''' and an input u32 '''Version''' (0 for normal keys or 1 for extended keys).
 
Decrypts '''DataIn''' into '''DataOut''' with a key generated from '''AccessKey''' and '''KeySource'''.
 
Used by [[SSL_services|SSL]] for TLS client-privk.
 
[5.0.0+] The '''Version''' argument was removed.
 
== DecryptAesKey ==
Takes an input 16-byte '''KeySource''' and two input u32s '''Generation''' and '''Option'''. Returns an output 16-byte '''AesKey'''.
 
Decrypts (AES-ECB) '''KeySource''' with a key set with [[SMC#LoadAesKey|LoadAesKey SMC]].
 
[2.0.0+] Introduced same keyslot allocation code as for [[#GenerateAesKey]].
 
== CryptAesCtr ==
Takes an output type-0x46 buffer '''DataOut''', an input u32 '''Keyslot''', an input type-0x45 buffer '''DataIn''' and an input 16-byte '''IvCtr'''.
 
Uses [[SMC#ComputeAes|ComputeAes SMC]] to decrypt '''DataIn''' into '''DataOut''' using the key set in the specified '''Keyslot'''.
 
[2.0.0+] Verifies the keyslot was allocated by the current session.
 
== ComputeCmac ==
Wrapper for [[SMC#ComputeCmac|ComputeCmac SMC]].
 
Takes an input type-0x9 buffer '''DataIn''' and an input u32 '''Keyslot'''. Returns an output 16-byte '''Cmac'''.
 
[2.0.0+] Verifies the keyslot was allocated by the current session.
 
== ImportEsKey ==
Wrapper for [[SMC#DecryptAndImportEsDeviceKey|DecryptAndImportEsDeviceKey SMC]].
 
Takes an input type-0x9 buffer '''DataIn''', an input 16-byte '''AccessKey''', an input 16-byte '''KeySource''' and an input u32 '''Version''' (0 for normal keys or 1 for extended keys).
 
Decrypts '''DataIn''' with a key generated from '''AccessKey''' and '''KeySource''' and imports it for later usage.
 
[5.0.0+] The '''Version''' argument was removed and this now calls the [[SMC#ReencryptDeviceUniqueData|ReencryptDeviceUniqueData SMC]] instead.
 
== UnwrapTitleKey ==
Wrapper for [[SMC#PrepareEsDeviceUniqueKey|PrepareEsDeviceUniqueKey SMC]].
 
Takes an output type-0xA buffer '''DataOut''' and 3 input type-0x9 buffers '''DataIn''', '''ModIn''' and '''LabelHashIn'''. Returns an output u32 '''DataOutSize'''.
 
[3.0.0+] Now takes an input u32 '''Generation'''.
 
Decrypts '''DataIn''' into '''DataOut''' using the private key imported with [[#ImportEsKey]] and the supplied '''ModIn'''. Afterwards, verifies RSA-OAEP encoding using '''LabelHashIn'''.
 
== LoadTitleKey ==
Wrapper for [[SMC#LoadPreparedAesKey|LoadPreparedAesKey SMC]].
 
Takes an input u32 '''Keyslot''' and an input 16-byte '''AccessKey'''.
 
[2.0.0+] Verifies the keyslot was allocated in the current session.
 
== UnwrapCommonTitleKey ==
Wrapper for [[SMC#PrepareEsCommonKey|PrepareEsCommonKey SMC]].
 
Takes an input 16-byte '''KeySource'''. Returns an output 16-byte '''AccessKey'''.
 
[3.0.0+] Now takes an input u32 '''Generation'''.
 
== AllocateAesKeyslot ==
Returns an output u32 '''Keyslot'''.
 
Returns error 0xD01A if all keyslots are taken.
 
== DeallocateAesKeySlot ==
Takes an input u32 '''Keyslot'''.
 
Returns error 0xD21A if the keyslot wasn't allocated by current session.
 
== GetAesKeyslotAvailableEvent ==
Returns an output event handle for synchronizing with the AES keyslots.
 
== SetBootReason ==
Takes an input u32 '''BootReason'''.
 
[4.0.0+] Returns 0xD41A if a value has been previously set without being [[#GetBootReason|gotten]].
 
== GetBootReason ==
Returns an output u32 '''BootReason'''.
 
[4.0.0+] Returns 0xD61A if a value has not previously been set and unsets the value after getting it.
 
== LoadPreparedAesKey ==
Same as [[#LoadTitleKey|LoadTitleKey]].
 
= spl:mig =
This is "nn::spl::detail::ICryptoInterface".
 
{| class="wikitable" border="1"
|-
! Cmd || Name |-| Notes0 || [[#GetConfig]]|-| 1 || [[#ModularExponentiate]]|-| 5 || [[#SetConfig]]|-| 7 || [[#GenerateRandomBytes]]|-| 11 || [[#IsDevelopment]]|-| 24 || [3.0.0+] [[#SetBootReason]]
|-
| 0 || 25 || [3.0.0+] [[#GetBootReason]]
|-
| 1 2 || || Unknown marshalling.[[#GenerateAesKek]]
|-
| 2 3 || [[#ScrambleKeyALoadAesKey]] ||
|-
| 3 4 || || Always returns 0x2D1A?[[#GenerateAesKey]]
|-
| 4 14 || [[#ScrambleKeyBDecryptAesKey]] ||
|-
| 5 15 || || Always returns 0x41A?[[#CryptAesCtr]]
|-
| 11 16 || [[#GetDevunitFlagComputeCmac]] ||
|-
| 13 21 || [2.0.0+] [[#AllocateAesKeyslot]]|-| 22 || [2.0.0+] [[#DeallocateAesKeySlot]]|-| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]
|}
== Cmd0 =spl:fs =Takes input word, and returns u64This is "nn::spl::detail::IFsInterface".
* Input val8: 64bit DeviceId with byte7 clear{| class="wikitable" border="1"|-! Cmd || Name|-| 0 || [[#GetConfig]]|-| 1 || [[#ModularExponentiate]]|-| 5 || [[#SetConfig]]|-| 7 || [[#GenerateRandomBytes]]|-| 11 || [[#IsDevelopment]]|-| 24 || [3.0. Output from this when used by 0+] [[NIM_servers#SetBootReason]]|-| 25 ||NIM[3.0.0+] [[#GetBootReason]] must match the |-| 2 || [[Settings_services#GenerateAesKek]]|set:cal-| 3 || [[#LoadAesKey]]|-| 4 || [[#GenerateAesKey]] DeviceId with byte7 cleared, otherwise NIM will panic|-| 14 || [[#DecryptAesKey]]|-| 15 || [[#CryptAesCtr]]|-| 16 || [[#ComputeCmac]]|-| 21 || [2.0.0+] [[#AllocateAesKeyslot]]|-| 22 || [2.0.0+] [[#DeallocateAesKeySlot]]|-| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]|-| 9 || [[#ImportLotusKey]]|-| 10 || [[#DecryptLotusMessage]]|-| 12 || [[#GenerateSpecificAesKey]]|-| 19 || [[#LoadTitleKey]]|-| 31 || [5.0.0+] GetPackage2Hash|}
== ScrambleKeyA =spl:ssl =Takes 16-bytes as input and two u32s. Outputs random-looking 16-bytesThis is "nn::spl::detail::ISslInterface".
Same input gives same output{| class="wikitable" border="1"|-! Cmd || Name|-| 0 || [[#GetConfig]]|-| 1 || [[#ModularExponentiate]]|-| 5 || [[#SetConfig]]|-| 7 || [[#GenerateRandomBytes]]|-| 11 || [[#IsDevelopment]]|-| 24 || [3. Console unique0.0+] [[#SetBootReason]]|-| 25 || [3.0.0+] [[#GetBootReason]]|-| 2 || [[#GenerateAesKek]]|-| 3 || [[#LoadAesKey]]|-| 4 || [[#GenerateAesKey]]|-| 14 || [[#DecryptAesKey]]|-| 15 || [[#CryptAesCtr]]|-| 16 || [[#ComputeCmac]]|-| 21 || [2.0.0+] [[#AllocateAesKeyslot]]|-| 22 || [2.0.0+] [[#DeallocateAesKeySlot]]|-| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]|-| 13 || [[#DecryptDeviceUniqueData]]|-| 26 || [5.0.0+] DecryptAndStoreSslClientCertKey|-| 27 || [5.0.0+] ModularExponentiateWithSslClientCertKey|}
== ScrambleKeyB =spl:es =Behaves similar to [[#ScrambleKeyA]], but with different outputThis is "nn::spl::detail::IEsInterface".
Also console unique{| class="wikitable" border="1"|-! Cmd || Name|-| 0 || [[#GetConfig]]|-| 1 || [[#ModularExponentiate]]|-| 5 || [[#SetConfig]]|-| 7 || [[#GenerateRandomBytes]]|-| 11 || [[#IsDevelopment]]|-| 24 || [3.0.0+] [[#SetBootReason]]|-| 25 || [3.0.0+] [[#GetBootReason]]|-| 2 || [[#GenerateAesKek]]|-| 3 || [[#LoadAesKey]]|-| 4 || [[#GenerateAesKey]]|-| 14 || [[#DecryptAesKey]]|-| 15 || [[#CryptAesCtr]]|-| 16 || [[#ComputeCmac]]|-| 21 || [2.0.0+] [[#AllocateAesKeyslot]]|-| 22 || [2. This is not the inverse operation of 0.0+] [[#ScrambleKeyADeallocateAesKeySlot]]|-| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]|-| 13 || [[#DecryptDeviceUniqueData]]|-| 17 || [[#ImportEsKey]]|-| 18 || [[#UnwrapTitleKey]]|-| 20 || [2.0.0+] [[#PrepareEsCommonKey]]|-| 28 || [5.0.0+] DecryptAndStoreDrmDeviceCertKey|-| 29 || [5.0.0+] ModularExponentiateWithDrmDeviceCertKey|-| 31 || [6.0.0+] PrepareEsArchiveKey|-| 32 || [6.0.0+] [[#LoadPreparedAesKey]]|}
== GetDevunitFlag =spl:manu =No input paramsThis is "nn::spl::detail::IManuInterface".
Returns an u8 flag for whether the system is devunit it seems{| class="wikitable" border="1"|-! Cmd || Name|-| 0 || [[#GetConfig]]|-| 1 || [[#ModularExponentiate]]|-| 5 || [[#SetConfig]]|-| 7 || [[#GenerateRandomBytes]]|-| 11 || [[#IsDevelopment]]|-| 24 || [3.0.0+] [[#SetBootReason]]|-| 25 || [3. Output flag is 0 on retail.0+] [[#GetBootReason]]|-| 2 || [[#GenerateAesKek]]|-| 3 || [[#LoadAesKey]]|-| 4 || [[#GenerateAesKey]]|-| 14 || [[#DecryptAesKey]]== Cmd13 ==|-| 15 || [[#CryptAesCtr]]|-| 16 || [[#ComputeCmac]]|-| 21 || [2.0.0+] [[#AllocateAesKeyslot]]|-| 22 || [2.0.0+] [[#DeallocateAesKeySlot]]|-| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]|-| 13 || [[#DecryptDeviceUniqueData]]|-This command hasn't been used successfully so far, throws the same SPL error all the time(besides IPC fail that's not SPL specific)| 30 || [5.0.0+] ReencryptDeviceUniqueData|}
Last SPL cmd used by [[SSL_services|SSLCategory:Services]]-sysmodule for TLS client-privk.

Navigation menu