Difference between revisions of "SPL services"

From Nintendo Switch Brew
Jump to navigation Jump to search
Line 2: Line 2:
  
 
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.
 
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 =
 
= csrng =
Line 14: Line 16:
  
 
== GenerateRandomBytes ==
 
== GenerateRandomBytes ==
Takes a type-0xA buffer and fills it with random data from [[SMC#GetRandomBytes|GetRandomBytes SMC]]. Same command for "spl:" and "csrng" services, except for buffer-type.
+
Takes an output type-0xA buffer and fills it with random data from [[SMC#GetRandomBytes|GetRandomBytes SMC]]. Same command for "spl:" and "csrng" services, except for buffer-type.
  
= spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu =
+
= spl: =
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".
+
This is "nn::spl::detail::IGeneralInterface".
  
[2.0.0+] Where previously only one AES keyslot was used, there is now support for 4 of them.
+
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || [[#GetConfig]]
 +
|-
 +
| 1 || [[#ExpMod]]
 +
|-
 +
| 5 || [[#SetConfig]]
 +
|-
 +
| 7 || [[#GenerateRandomBytes]]
 +
|-
 +
| 11 || [[#IsDevelopment]]
 +
|-
 +
| 24 || [3.0.0+] [[#SetBootReason]]
 +
|-
 +
| 25 || [3.0.0+] [[#GetBootReason]]
 +
|}
 +
 
 +
= spl:mig =
 +
This is "nn::spl::detail::ICryptoInterface".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || [[#GetConfig]]
 +
|-
 +
| 1 || [[#ExpMod]]
 +
|-
 +
| 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.0.0+] [[#FreeAesKeyslot]]
 +
|-
 +
| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]
 +
|}
  
[2.0.0+] When the session closes, all allocated AES keyslots are automatically freed.
+
= spl:fs =
 +
This is "nn::spl::detail::IFsInterface".
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
! Cmd || Name || Permissions
+
! Cmd || Name
 +
|-
 +
| 0 || [[#GetConfig]]
 +
|-
 +
| 1 || [[#ExpMod]]
 
|-
 
|-
| 0 || [[#GetConfig]] || spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 5 || [[#SetConfig]]
 
|-
 
|-
| 1 || [[#ExpMod]] || spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 7 || [[#GenerateRandomBytes]]
 
|-
 
|-
| 2 || [[#GenerateAesKek]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 11 || [[#IsDevelopment]]
 
|-
 
|-
| 3 || [[#LoadAesKey]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 24 || [3.0.0+] [[#SetBootReason]]
 
|-
 
|-
| 4 || [[#GenerateAesKey]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 25 || [3.0.0+] [[#GetBootReason]]
 
|-
 
|-
| 5 || [[#SetConfig]] || spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 2 || [[#GenerateAesKek]]
 
|-
 
|-
| 7 || [[#GenerateRandomBytes]] || spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 3 || [[#LoadAesKey]]
 
|-
 
|-
| 9 || [[#ImportLotusKey]] || spl:fs
+
| 4 || [[#GenerateAesKey]]
 
|-
 
|-
| 10 || [[#DecryptLotusMessage]] || spl:fs
+
| 14 || [[#DecryptAesKey]]
 
|-
 
|-
| 11 || [[#IsDevelopment]] || spl:, spl:mig, spl:fs, spl:ssl spl:es, spl:manu
+
| 15 || [[#CryptAesCtr]]
 
|-
 
|-
| 12 || [[#GenerateSpecificAesKey]] || spl:fs
+
| 16 || [[#ComputeCmac]]
 
|-
 
|-
| 13 || [[#DecryptRsaPrivateKey]] || spl:ssl, spl:es, spl:manu
+
| 21 || [2.0.0+] [[#AllocateAesKeyslot]]
 +
|-
 +
| 22 || [2.0.0+] [[#FreeAesKeyslot]]
 +
|-
 +
| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]
 +
|-
 +
| 9 || [[#ImportLotusKey]]
 +
|-
 +
| 10 || [[#DecryptLotusMessage]]
 +
|-
 +
| 12 || [[#GenerateSpecificAesKey]]
 +
|-
 +
| 19 || [[#LoadTitleKey]]
 +
|-
 +
| 31 || [5.0.0+] GetPackage2Hash
 +
|}
 +
 
 +
= spl:ssl =
 +
This is "nn::spl::detail::ISslInterface".
 +
 
 +
{| class="wikitable" border="1"
 
|-
 
|-
| 14 || [[#DecryptAesKey]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
! Cmd || Name
 
|-
 
|-
| 15 || [[#CryptAesCtr]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 0 || [[#GetConfig]]
 
|-
 
|-
| 16 || [[#ComputeCmac]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 1 || [[#ExpMod]]
 
|-
 
|-
| 17 || [[#ImportEsKey]] || spl:es
+
| 5 || [[#SetConfig]]
 
|-
 
|-
| 18 || [[#UnwrapTitleKey]] || spl:es
+
| 7 || [[#GenerateRandomBytes]]
 
|-
 
|-
| 19 || [[#LoadTitleKey]] || spl:fs
+
| 11 || [[#IsDevelopment]]
 
|-
 
|-
| 20 || [2.0.0+] [[#UnwrapCommonTitleKey]] || spl:es
+
| 24 || [3.0.0+] [[#SetBootReason]]
 
|-
 
|-
| 21 || [2.0.0+] [[#AllocateAesKeyslot]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 25 || [3.0.0+] [[#GetBootReason]]
 
|-
 
|-
| 22 || [2.0.0+] [[#FreeAesKeyslot]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 2 || [[#GenerateAesKek]]
 
|-
 
|-
| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 3 || [[#LoadAesKey]]
 
|-
 
|-
| 24 || [3.0.0+] [[#SetBootReason]] || spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 4 || [[#GenerateAesKey]]
 
|-
 
|-
| 25 || [3.0.0+] [[#GetBootReason]] || spl:, spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
+
| 14 || [[#DecryptAesKey]]
 
|-
 
|-
| 26 || [5.0.0+] ImportSslKey || spl:ssl
+
| 15 || [[#CryptAesCtr]]
 
|-
 
|-
| 27 || [5.0.0+] SslExpMod || spl:ssl
+
| 16 || [[#ComputeCmac]]
 
|-
 
|-
| 28 || [5.0.0+] ImportDrmKey || spl:es
+
| 21 || [2.0.0+] [[#AllocateAesKeyslot]]
 
|-
 
|-
| 29 || [5.0.0+] DrmExpMod || spl:es
+
| 22 || [2.0.0+] [[#FreeAesKeyslot]]
 
|-
 
|-
| 30 || [5.0.0+] ReEncryptRsaPrivateKey || spl:manu
+
| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]
 
|-
 
|-
| 31 || [5.0.0+] GetPackage2Hash || spl:fs
+
| 13 || [[#DecryptRsaPrivateKey]]
 
|-
 
|-
| 31 || [6.0.0+] UnwrapElicenseKey || spl:es
+
| 26 || [5.0.0+] ImportSslKey
 
|-
 
|-
| 32 || [6.0.0+] [[#LoadElicenseKey]] || spl:es
+
| 27 || [5.0.0+] SslExpMod
 +
|}
 +
 
 +
= spl:es =
 +
This is "nn::spl::detail::IEsInterface".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || [[#GetConfig]]
 +
|-
 +
| 1 || [[#ExpMod]]
 +
|-
 +
| 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.0.0+] [[#FreeAesKeyslot]]
 +
|-
 +
| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]
 +
|-
 +
| 13 || [[#DecryptRsaPrivateKey]]
 +
|-
 +
| 17 || [[#ImportEsKey]]
 +
|-
 +
| 18 || [[#UnwrapTitleKey]]
 +
|-
 +
| 20 || [2.0.0+] [[#UnwrapCommonTitleKey]]
 +
|-
 +
| 28 || [5.0.0+] ImportDrmKey
 +
|-
 +
| 29 || [5.0.0+] DrmExpMod
 +
|-
 +
| 31 || [6.0.0+] UnwrapElicenseKey
 +
|-
 +
| 32 || [6.0.0+] [[#LoadElicenseKey]]
 +
|}
 +
 
 +
= spl:manu =
 +
This is "nn::spl::detail::IManuInterface".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || [[#GetConfig]]
 +
|-
 +
| 1 || [[#ExpMod]]
 +
|-
 +
| 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.0.0+] [[#FreeAesKeyslot]]
 +
|-
 +
| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]
 +
|-
 +
| 13 || [[#DecryptRsaPrivateKey]]
 +
|-
 +
| 30 || [5.0.0+] ReEncryptRsaPrivateKey
 
|}
 
|}
  
Line 95: Line 279:
 
Wrapper for [[SMC#GetConfig|GetConfig SMC]].
 
Wrapper for [[SMC#GetConfig|GetConfig SMC]].
  
Takes a u32 ('''ConfigItem'''), and returns one or more u64s ('''ConfigVal''').
+
Takes an input u32 '''ConfigItem'''. Returns one or more output u64s '''ConfigValue'''.
  
 
== ExpMod ==
 
== ExpMod ==
 
Wrapper for [[SMC#ExpMod|ExpMod SMC]].
 
Wrapper for [[SMC#ExpMod|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''').
+
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.
 
Performs asymmetric crypto with user supplied modulus and exponent.
Line 107: Line 291:
 
Wrapper for [[SMC#GenerateAesKek|GenerateAesKek SMC]].
 
Wrapper for [[SMC#GenerateAesKek|GenerateAesKek SMC]].
  
Takes a 16-byte EKS ('''Encryption Key Source''') and two words ('''KeyGeneration''' and '''option''') as input.
+
Takes an input 16-byte '''KeySource''' and two input u32s '''Generation''' and '''Option'''. Returns an output 16-byte '''AccessKey'''.
 
 
Returns a scrambled sealed KEK ('''Key Encryption Key''' used as '''key_x''').
 
  
 
== LoadAesKey ==
 
== LoadAesKey ==
 
Wrapper for [[SMC#LoadAesKey|LoadAesKey SMC]].
 
Wrapper for [[SMC#LoadAesKey|LoadAesKey SMC]].
  
Takes a u32 ('''keyslot''') and two 16-byte keys ('''key_x''' and '''key_y''').
+
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 '''key_x''' and '''key_y'''.
+
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.
 
[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 ==
 
== GenerateAesKey ==
Takes a 16-byte KEK ('''key_x''') and a 16-byte encrypted key ('''enc_key''').
+
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) '''enc_key''' with a key generated from the supplied '''key_x''' and a fixed '''key_y''' set with [[SMC#LoadAesKey|LoadAesKey SMC]].
+
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.
 
[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.
Line 130: Line 312:
 
Wrapper for [[SMC#SetConfig|SetConfig SMC]].
 
Wrapper for [[SMC#SetConfig|SetConfig SMC]].
  
Takes a u32 ('''ConfigItem''') and a u64 ('''ConfigVal''').
+
Takes an input u32 '''ConfigItem''' and an input u64 '''ConfigValue'''.
  
{| class="wikitable" border="1"
+
Only '''ConfigItem''' 13 (IsChargerHiZModeEnabled) can be set.
|-
 
! ConfigItem || Name
 
|-
 
| 13 || IsChargerHiZModeEnabled
 
|}
 
 
 
Any other '''ConfigItem''', besides 13, can't be set.
 
  
 
== ImportLotusKey ==
 
== ImportLotusKey ==
 
Wrapper for [[SMC#ImportLotusKey|ImportLotusKey SMC]].
 
Wrapper for [[SMC#ImportLotusKey|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''').
+
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).
'''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.
+
Decrypts '''DataIn''' with a key generated from '''AccessKey''' and '''KeySource''' and imports it for later usage.
  
[5.0.0+] The '''version''' param was removed, and this now calls [[SMC#ReEncryptRsaPrivateKey|ReEncryptRsaPrivateKey SMC]] instead.
+
[5.0.0+] The '''Version''' argument was removed and this now calls the [[SMC#ReEncryptRsaPrivateKey|ReEncryptRsaPrivateKey SMC]] instead.
  
 
== DecryptLotusMessage ==
 
== DecryptLotusMessage ==
Takes 3 type-9 (X descriptor) buffers ('''data_in_buf''', '''mod_in_buf''' and '''label_hash_in_buf''').
+
Takes 3 input type-0x9 buffers '''DataIn''', '''ModIn''' and '''LabelHashIn'''.
  
Uses [[SMC#SecureExpMod|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'''.
+
Uses the [[SMC#SecureExpMod|SecureExpMod SMC]] to decrypt '''DataIn''' using the private key imported with [[#ImportLotusKey]] and the supplied '''ModIn''' and '''LabelHashIn'''.
  
 
== IsDevelopment ==
 
== IsDevelopment ==
No input params.
+
No input. Returns an output u8 bool.
  
Uses [[#GetConfig]] internally with id=6. Returns true if output from that is 0, or if the SMC returned error 2.
+
Uses [[#GetConfig]] internally.
 
 
Returns an u8 flag for whether the system is devunit. Output flag is 0 on retail.
 
  
 
== GenerateSpecificAesKey ==
 
== GenerateSpecificAesKey ==
 
Wrapper for [[SMC#GenerateSpecificAesKey|GenerateSpecificAesKey SMC]].
 
Wrapper for [[SMC#GenerateSpecificAesKey|GenerateSpecificAesKey SMC]].
  
Takes a 16-byte seed ('''key_seed''') and two words ('''KeyGeneration''' and '''option''') as input.
+
Takes an input 16-byte '''KeySource''' and two input u32s '''Generation''' and '''Option'''. Returns an output 16-byte '''AesKey'''.
 
 
Returns a scrambled key ('''key_a''').
 
  
 
== DecryptRsaPrivateKey ==
 
== DecryptRsaPrivateKey ==
 
Wrapper for [[SMC#DecryptRsaPrivateKey|DecryptRsaPrivateKey SMC]].
 
Wrapper for [[SMC#DecryptRsaPrivateKey|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''').
+
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).
'''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'''.
+
Decrypts '''DataIn''' into '''DataOut''' with a key generated from '''AccessKey''' and '''KeySource'''.
  
Used by [[SSL_services|SSL]]-sysmodule for TLS client-privk.
+
Used by [[SSL_services|SSL]] for TLS client-privk.
  
[5.0.0+] The '''version''' param was removed, and this now calls [[SMC#DecryptOrImportRsaPrivateKey|DecryptOrImportRsaPrivateKey SMC]] instead.
+
[5.0.0+] The '''Version''' argument was removed and this now calls [[SMC#DecryptOrImportRsaPrivateKey|DecryptOrImportRsaPrivateKey SMC]] instead.
  
 
== DecryptAesKey ==
 
== DecryptAesKey ==
Takes a 16-byte encrypted key ('''enc_key''') and two words ('''KeyGeneration''' and '''option''') as input.
+
Takes an input 16-byte '''KeySource''' and two input u32s '''Generation''' and '''Option'''. Returns an output 16-byte '''AesKey'''.
  
Decrypts (AES-ECB) '''enc_key''' with a key generated from fixed '''key_x''' and '''key_y''' set with [[SMC#LoadAesKey|LoadAesKey SMC]] and returns a 16-byte decrypted key ('''dec_key''').
+
Decrypts (AES-ECB) '''KeySource''' with a key set with [[SMC#LoadAesKey|LoadAesKey SMC]].
  
 
[2.0.0+] Introduced same keyslot allocation code as for [[#GenerateAesKey]].
 
[2.0.0+] Introduced same keyslot allocation code as for [[#GenerateAesKey]].
  
 
== CryptAesCtr ==
 
== 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''').
+
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 '''data_in_buf''' into '''data_out_buf''', using the key set in the specified '''keyslot'''.
+
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 in the current session.
+
[2.0.0+] Verifies the keyslot was allocated by the current session.
  
 
== ComputeCmac ==
 
== ComputeCmac ==
 
Wrapper for [[SMC#ComputeCmac|ComputeCmac SMC]].
 
Wrapper for [[SMC#ComputeCmac|ComputeCmac SMC]].
  
Takes one type-9 (X descriptor) buffer ('''data_in_buf''') and a u32 ('''type?''').
+
Takes an input type-0x9 buffer '''DataIn''' and an input u32 '''Keyslot'''. Returns an output 16-byte '''Cmac'''.
 
 
Returns a 16-byte CMAC calculated over '''data_in_buf'''.
 
  
[2.0.0+] Verifies the keyslot was allocated in the current session.
+
[2.0.0+] Verifies the keyslot was allocated by the current session.
  
 
== ImportEsKey ==
 
== ImportEsKey ==
 
Wrapper for [[SMC#ImportEsKey|ImportEsKey SMC]].
 
Wrapper for [[SMC#ImportEsKey|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.
+
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 enc_privk_in_buf with a key generated from key_x and key_y and imports it for later usage.
+
Decrypts '''DataIn''' with a key generated from '''AccessKey''' and '''KeySource''' and imports it for later usage.
  
[5.0.0+] The '''version''' param was removed, and this now calls [[SMC#ReEncryptRsaPrivateKey|ReEncryptRsaPrivateKey SMC]] instead.
+
[5.0.0+] The '''Version''' argument was removed and this now calls the [[SMC#ReEncryptRsaPrivateKey|ReEncryptRsaPrivateKey SMC]] instead.
  
 
== UnwrapTitleKey ==
 
== UnwrapTitleKey ==
 
Wrapper for [[SMC#UnwrapTitleKey|UnwrapTitleKey SMC]].
 
Wrapper for [[SMC#UnwrapTitleKey|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''').
+
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 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'''.
+
[3.0.0+] Now takes an input u32 '''Generation'''.
  
Returns an u32 ('''dec_data_size''').
+
Decrypts '''DataIn''' into '''DataOut''' using the private key imported with [[#ImportEsKey]] and the supplied '''ModIn'''. Afterwards, verifies RSA-OAEP encoding using '''LabelHashIn'''.
  
 
== LoadTitleKey ==
 
== LoadTitleKey ==
 
Wrapper for [[SMC#LoadTitleKey|LoadTitleKey SMC]].
 
Wrapper for [[SMC#LoadTitleKey|LoadTitleKey SMC]].
  
Takes a u32 ('''keyslot''') and a 16-byte sealed titlekey.
+
Takes an input u32 '''Keyslot''' and an input 16-byte '''AccessKey'''.
 
 
Sets the specified '''keyslot''' with the titlekey.
 
  
 
[2.0.0+] Verifies the keyslot was allocated in the current session.
 
[2.0.0+] Verifies the keyslot was allocated in the current session.
Line 237: Line 400:
 
Wrapper for [[SMC#UnwrapCommonTitleKey|UnwrapCommonTitleKey SMC]].
 
Wrapper for [[SMC#UnwrapCommonTitleKey|UnwrapCommonTitleKey SMC]].
  
Takes a 16-byte EKS ('''Encryption Key Source''').
+
Takes an input 16-byte '''KeySource'''. Returns an output 16-byte '''AccessKey'''.
  
[3.0.0+] Now takes an additional 4-bytes of input.
+
[3.0.0+] Now takes an input u32 '''Generation'''.
  
Returns a sealed titlekey.
+
== AllocateAesKeyslot ==
 +
Returns an output u32 '''Keyslot'''.
  
== AllocateAesKeyslot ==
+
Returns error 0xD01A if all keyslots are taken.
Returns an allocated keyslot, or 0xD01A if all keyslots are taken. You need to allocate a keyslot before using AES functions.
 
  
 
== FreeAesKeyslot ==
 
== FreeAesKeyslot ==
Takes a single u32 and frees the keyslot. The keyslot must have been allocated by current session otherwise 0xD21A will be returned.
+
Takes an input u32 '''Keyslot'''.
 +
 
 +
Returns error 0xD21A if the keyslot wasn't allocated by current session.
  
 
== GetAesKeyslotAvailableEvent ==
 
== GetAesKeyslotAvailableEvent ==
Returns an event handle for synchronizing with the AES keyslots.
+
Returns an output event handle for synchronizing with the AES keyslots.
  
 
== SetBootReason ==
 
== SetBootReason ==
Sets a static dword in spl .bss to the input u32 '''BootReason'''.
+
Takes an input u32 '''BootReason'''.
  
[4.0.0+] returns 0xD41A if a value has been previously set without being [[#GetBootReason|gotten]].
+
[4.0.0+] Returns 0xD41A if a value has been previously set without being [[#GetBootReason|gotten]].
  
 
== GetBootReason ==
 
== GetBootReason ==
Returns the static dword '''BootReason''' in spl .bss that can be set via [[#SetBootReason]].
+
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.
+
[4.0.0+] Returns 0xD61A if a value has not previously been set and unsets the value after getting it.
  
 
== LoadElicenseKey ==
 
== LoadElicenseKey ==

Revision as of 20:18, 5 May 2020

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.

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".

Cmd Name
0 #GenerateRandomBytes

GenerateRandomBytes

Takes an output type-0xA buffer and fills it with random data from GetRandomBytes SMC. Same command for "spl:" and "csrng" services, except for buffer-type.

spl:

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

Cmd Name
0 #GetConfig
1 #ExpMod
5 #SetConfig
7 #GenerateRandomBytes
11 #IsDevelopment
24 [3.0.0+] #SetBootReason
25 [3.0.0+] #GetBootReason

spl:mig

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

Cmd Name
0 #GetConfig
1 #ExpMod
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.0.0+] #FreeAesKeyslot
23 [2.0.0+] #GetAesKeyslotAvailableEvent

spl:fs

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

Cmd Name
0 #GetConfig
1 #ExpMod
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.0.0+] #FreeAesKeyslot
23 [2.0.0+] #GetAesKeyslotAvailableEvent
9 #ImportLotusKey
10 #DecryptLotusMessage
12 #GenerateSpecificAesKey
19 #LoadTitleKey
31 [5.0.0+] GetPackage2Hash

spl:ssl

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

Cmd Name
0 #GetConfig
1 #ExpMod
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.0.0+] #FreeAesKeyslot
23 [2.0.0+] #GetAesKeyslotAvailableEvent
13 #DecryptRsaPrivateKey
26 [5.0.0+] ImportSslKey
27 [5.0.0+] SslExpMod

spl:es

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

Cmd Name
0 #GetConfig
1 #ExpMod
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.0.0+] #FreeAesKeyslot
23 [2.0.0+] #GetAesKeyslotAvailableEvent
13 #DecryptRsaPrivateKey
17 #ImportEsKey
18 #UnwrapTitleKey
20 [2.0.0+] #UnwrapCommonTitleKey
28 [5.0.0+] ImportDrmKey
29 [5.0.0+] DrmExpMod
31 [6.0.0+] UnwrapElicenseKey
32 [6.0.0+] #LoadElicenseKey

spl:manu

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

Cmd Name
0 #GetConfig
1 #ExpMod
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.0.0+] #FreeAesKeyslot
23 [2.0.0+] #GetAesKeyslotAvailableEvent
13 #DecryptRsaPrivateKey
30 [5.0.0+] ReEncryptRsaPrivateKey

GetConfig

Wrapper for GetConfig SMC.

Takes an input u32 ConfigItem. Returns one or more output u64s ConfigValue.

ExpMod

Wrapper for ExpMod 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 GenerateAesKek SMC.

Takes an input 16-byte KeySource and two input u32s Generation and Option. Returns an output 16-byte AccessKey.

LoadAesKey

Wrapper for 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 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 an input u32 ConfigItem and an input u64 ConfigValue.

Only ConfigItem 13 (IsChargerHiZModeEnabled) can be set.

ImportLotusKey

Wrapper for ImportLotusKey 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 ReEncryptRsaPrivateKey SMC instead.

DecryptLotusMessage

Takes 3 input type-0x9 buffers DataIn, ModIn and LabelHashIn.

Uses the SecureExpMod 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 GenerateSpecificAesKey SMC.

Takes an input 16-byte KeySource and two input u32s Generation and Option. Returns an output 16-byte AesKey.

DecryptRsaPrivateKey

Wrapper for DecryptRsaPrivateKey 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 for TLS client-privk.

[5.0.0+] The Version argument was removed and this now calls DecryptOrImportRsaPrivateKey SMC instead.

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 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 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 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 ImportEsKey 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 ReEncryptRsaPrivateKey SMC instead.

UnwrapTitleKey

Wrapper for UnwrapTitleKey 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 LoadTitleKey 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 UnwrapCommonTitleKey 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.

FreeAesKeyslot

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

LoadElicenseKey

Same as LoadTitleKey.