SPL services: Difference between revisions

From Nintendo Switch Brew
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
= csrng =
= spl: =
{| class="wikitable" border="1"
[2.0.0+] Where previously only one AES engine was utilized, there is now support for 4 of them.
|-
! Cmd || Name
|-
| 0 || [[#GetRandomBytes]]
|}
 
== GetRandomBytes ==
Takes a type-6 buffer and fills it with random data.


= spl: =
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 21: Line 12:
| 2 || [[#GenerateAesKek]] || wrapper for [[SMC#KeygenAndSealX|KeygenAndSealX]]
| 2 || [[#GenerateAesKek]] || wrapper for [[SMC#KeygenAndSealX|KeygenAndSealX]]
|-
|-
| 3 || LoadAesKey || wrapper for [[SMC#SetKeyslotFromXY|SetKeyslotFromXY]]
| 3 || [[#LoadAesKey]] || wrapper for [[SMC#SetKeyslotFromXY|SetKeyslotFromXY]]
|-
|-
| 4 || GenerateAesKey || decrypts 0x10 bytes using AES ECB, uses [[SMC#SetKeyslotFromXY|SetKeyslotFromXY]] with a fixed Y
| 4 || [[#GenerateAesKey]] || decrypts 0x10 bytes using AES ECB, uses [[SMC#SetKeyslotFromXY|SetKeyslotFromXY]] with a fixed Y
|-
|-
| 5 || [[#SetConfig]] || wrapper for [[SMC#SetConfig|SetConfig]]
| 5 || [[#SetConfig]] || wrapper for [[SMC#SetConfig|SetConfig]]
Line 39: Line 30:
| 13 || [[#DecryptExpModParamsWithXY]] || wrapper for [[SMC#DecryptExpModParamsWithXY|DecryptExpModParamsWithXY]]
| 13 || [[#DecryptExpModParamsWithXY]] || wrapper for [[SMC#DecryptExpModParamsWithXY|DecryptExpModParamsWithXY]]
|-
|-
| 14 || || decrypts 0x10 bytes using AES ECB, uses [[SMC#SetKeyslotFromXY|SetKeyslotFromXY]] with fixed X and Y
| 14 || [[#GenerateAesKeyOther]] || decrypts 0x10 bytes using AES ECB, uses [[SMC#SetKeyslotFromXY|SetKeyslotFromXY]] with fixed X and Y
|-
|-
| 15 || DecryptAesCtr || wrapper for [[SMC#SymmetricCrypto|SymmetricCrypto]]
| 15 || [[#DecryptAesCtr]] || wrapper for [[SMC#SymmetricCrypto|SymmetricCrypto]]
|-
|-
| 16 || ComputeCmac || wrapper for [[SMC#CMAC|CMAC]]
| 16 || [[#ComputeCmac]] || wrapper for [[SMC#CMAC|CMAC]]
|-
|-
| 17 || || wrapper for [[SMC#ImportParamsFor10WithXY|ImportParamsFor10WithXY]]
| 17 || || wrapper for [[SMC#ImportParamsFor10WithXY|ImportParamsFor10WithXY]]
Line 49: Line 40:
| 18 || || wrapper for [[SMC#ExpModAndKeygenAndSealZ|ExpModAndKeygenAndSealZ]]
| 18 || || wrapper for [[SMC#ExpModAndKeygenAndSealZ|ExpModAndKeygenAndSealZ]]
|-
|-
| 19 || || wrapper for [[SMC#SetKeyslotFromZ|SetKeyslotFromZ]]
| 19 || [[#SetKeyslotFromZ]] || wrapper for [[SMC#SetKeyslotFromZ|SetKeyslotFromZ]]
|-
|-
| 20 || || wrapper for [[SMC#KeygenAndSealZ|KeygenAndSealZ]]
| 20 || [2.0.0+] || wrapper for [[SMC#KeygenAndSealZ|KeygenAndSealZ]]
|-
|-
| 21 || [[#UninitializeSpl]] ||  
| 21 || [2.0.0+] [[#LockAesEngine]] ||  
|-
|-
| 22 || [[#InitializeSpl]] ||  
| 22 || [2.0.0+] [[#UnlockAesEngine]] ||  
|-
|-
| 23 || GetSplWaitEvent ||  
| 23 || [2.0.0+] GetSplWaitEvent ||  
|}
|}


Line 99: Line 90:


Same input gives same output. Output changes when system is rebooted.
Same input gives same output. Output changes when system is rebooted.
== LoadAesKey ==
[2.0.0+] Now verifies that the engine used (0..3) is locked/owned by the current spl session, otherwise errors with 0xD21A. Previously engine was hardcoded to 0.
== GenerateAesKey ==
[2.0.0+] Previously it used engine 0 always. Now it tries to allocate an engine to be used, returns 0xD01A if they're all busy. After command is done, the engine is released.


== SetConfig ==
== SetConfig ==
Line 107: Line 104:
! ConfigItem || Name
! ConfigItem || Name
|-
|-
| 13 || Battery profile?
| 13 || BatteryProfile?
|}
|}


Line 120: Line 117:
Last SPL cmd used by [[SSL_services|SSL]]-sysmodule for TLS client-privk.
Last SPL cmd used by [[SSL_services|SSL]]-sysmodule for TLS client-privk.


== UninitializeSpl ==
== GenerateAesKeyOther ==
Returns a single u32 (always 3?) only once.
Scrambles with a different constant than non-"other" version.
 
[2.0.0+] Introduced same engine allocation code as for [[#GenerateAesKey]].
 
== DecryptAesCtr ==
[2.0.0+] Verifies the engine is locked by current session, same change as [[#LoadAesKey]].
 
== ComputeCmac ==
[2.0.0+] Verifies the engine is locked by current session, same change as [[#LoadAesKey]].
 
== SetKeyslotFromZ ==
[2.0.0+] Verifies the engine is locked by current session, same change as [[#LoadAesKey]].
 
== LockAesEngine ==
Returns the id of the engine that was locked, or 0xD01A if all engines are busy. You need to lock an engine before using AES functions.


== InitializeSpl ==
== UnlockAesEngine ==
Takes a single u32 (always 3?) only once.
Takes a single u32 and unlocks the engine with that id. It must be owned by current session otherwise 0xD21A will be returned.

Revision as of 02:54, 7 August 2017

spl:

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

Cmd Name Notes
0 #GetConfig wrapper for GetConfig
1 user supplied modulus and exponent
2 #GenerateAesKek wrapper for KeygenAndSealX
3 #LoadAesKey wrapper for SetKeyslotFromXY
4 #GenerateAesKey decrypts 0x10 bytes using AES ECB, uses SetKeyslotFromXY with a fixed Y
5 #SetConfig wrapper for SetConfig
7 GetRandom uses PrngX931
9 wrapper for ImportParamsForFWithXY
10 wrapper for ExpMod
11 #IsDevelopment
12 GenerateSpecificAesKey wrapper for KeygenA
13 #DecryptExpModParamsWithXY wrapper for DecryptExpModParamsWithXY
14 #GenerateAesKeyOther decrypts 0x10 bytes using AES ECB, uses SetKeyslotFromXY with fixed X and Y
15 #DecryptAesCtr wrapper for SymmetricCrypto
16 #ComputeCmac wrapper for CMAC
17 wrapper for ImportParamsFor10WithXY
18 wrapper for ExpModAndKeygenAndSealZ
19 #SetKeyslotFromZ wrapper for SetKeyslotFromZ
20 [2.0.0+] wrapper for KeygenAndSealZ
21 [2.0.0+] #LockAesEngine
22 [2.0.0+] #UnlockAesEngine
23 [2.0.0+] GetSplWaitEvent

GetConfig

Takes an input word (ConfigItem), and returns a u64 with the config params.

ConfigItem Name
1 DisableProgramVerification
2 MemoryConfiguration
5 HardwareType (0=Icosa, 1=Copper)
6 IsRetail
7 IsRecoveryBoot
8 DeviceId (byte7 clear).
9 BootReason
10 MemoryArrange
11 AllowSkippingNrrSignatures. Also used by FS-sysmodule for non-RSA: when zero, bit62 in fsp-pr registration permissions are force-cleared to zero, otherwise the original is used.
13 BatteryProfile?

PM checks id1 and if non-zero, calls fsp-pr SetEnabledProgramVerification(false).

NIM checks that id8 output must match the set:cal DeviceId with byte7 cleared, otherwise panic.

[3.0.0+] RO checks id11, if set then skipping NRR rsa signatures is allowed.

GenerateAesKek

Takes a 16-byte seed ("BisEncryptionKeySourceForKek") and two words ("KeyGeneration" and "option") as input. KeyGeneration ranges from 0 to 2.

Same input gives same output. Output changes when system is rebooted.

LoadAesKey

[2.0.0+] Now verifies that the engine used (0..3) is locked/owned by the current spl session, otherwise errors with 0xD21A. Previously engine was hardcoded to 0.

GenerateAesKey

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

SetConfig

Takes two input words, a ConfigItem and the value to set.

ConfigItem Name
13 BatteryProfile?

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.

DecryptExpModParamsWithXY

Last SPL cmd used by SSL-sysmodule for TLS client-privk.

GenerateAesKeyOther

Scrambles with a different constant than non-"other" version.

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

DecryptAesCtr

[2.0.0+] Verifies the engine is locked by current session, same change as #LoadAesKey.

ComputeCmac

[2.0.0+] Verifies the engine is locked by current session, same change as #LoadAesKey.

SetKeyslotFromZ

[2.0.0+] Verifies the engine is locked by current session, same change as #LoadAesKey.

LockAesEngine

Returns the id of the engine that was locked, or 0xD01A if all engines are busy. You need to lock an engine before using AES functions.

UnlockAesEngine

Takes a single u32 and unlocks the engine with that id. It must be owned by current session otherwise 0xD21A will be returned.