Changes

Jump to navigation Jump to search
1,583 bytes added ,  18:44, 12 May 2020
no edit summary
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 =
== GenerateRandomBytes ==
Takes a an output type-6 0xA buffer and fills it with random data from [[SMC#GetRandomBytesGenerateRandomBytes|GetRandomBytes GenerateRandomBytes 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 except for 4 of thembuffer-type.
[2.0.0+] When the session closes, all allocated AES keyslots are automatically freed= spl: =This is "nn::spl::detail::IGeneralInterface".
{| class="wikitable" border="1"
|-
! 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 0 || [[#DecryptRsaPrivateKeyGetConfig]] || spl:ssl, spl:es, spl:manu
|-
| 14 1 || [[#DecryptAesKeyModularExponentiate]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
|-
| 15 5 || [[#CryptAesCtrSetConfig]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
|-
| 16 7 || [[#ComputeCmacGenerateRandomBytes]] || spl:mig, spl:fs, spl:ssl, spl:es, spl:manu
|-
| 17 11 || [[#ImportEsKeyIsDevelopment]] || spl:es
|-
| 18 24 || [3.0.0+] [[#UnwrapTitleKeySetBootReason]] || 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
|}
Wrapper for [[SMC#GetConfig|GetConfig SMC]].
Takes a an input u32 ('''ConfigItem'''), and returns . Returns one or more output u64s ('''ConfigValConfigValue''').
== ExpMod ModularExponentiate ==Wrapper for [[SMC#ExpModModularExponentiate|ExpMod ModularExponentiate SMC]].
Takes one an output type-10 (C descriptor) 0xA buffer ('''data_out_bufDataOut''') and 3 input type-9 (X descriptor) 0x9 buffers ('''data_in_bufDataIn''', '''exp_in_bufExpIn''' and '''mod_in_bufModIn''').
Performs asymmetric crypto with user supplied modulus and exponent.
Wrapper for [[SMC#GenerateAesKek|GenerateAesKek SMC]].
Takes a an input 16-byte EKS ('''Encryption Key SourceKeySource''') and two words (input u32s '''KeyGenerationGeneration''' and '''optionOption''') as input. Returns a scrambled sealed KEK ('''Key Encryption Key''' used as an output 16-byte '''key_xAccessKey''').
== LoadAesKey ==
Wrapper for [[SMC#LoadAesKey|LoadAesKey SMC]].
Takes a an input u32 ('''keyslotKeyslot''') and two , an input 16-byte keys ('''key_xAccessKey''' and an input 16-byte '''key_yKeySource''').
Sets the specified '''keyslotKeyslot''' with a key generated from '''key_xAccessKey''' and '''key_yKeySource'''.
[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 an input 16-byte KEK ('''key_xAccessKey''') and a an input 16-byte encrypted key ('''enc_keyKeySource'''. Returns an output 16-byte '''AesKey''').
Generates a new key by decrypting (AES-ECB) '''enc_keyKeySource''' with a key generated from the supplied '''key_xAccessKey''' and a fixed '''key_y''' 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.
Wrapper for [[SMC#SetConfig|SetConfig SMC]].
Takes a an input u32 ('''ConfigItem''') and a an input u64 ('''ConfigValConfigValue''').
{| class="wikitable" border="1"|-! ConfigItem || Name|-| 13 || IsChargerHiZModeEnabled|} Any other Only '''ConfigItem''', besides 13, (IsChargerHiZModeEnabled) can't be set.
== ImportLotusKey ==
Wrapper for [[SMC#ImportLotusKeyDecryptAndImportLotusKey|ImportLotusKey DecryptAndImportLotusKey SMC]].
Takes one an input type-9 (X descriptor) 0x9 buffer ('''enc_privk_in_bufDataIn'''), a an input 16-byte KEK ('''key_xAccessKey'''), a an input 16-byte key ('''key_yKeySource''') and a an input u32 ('''versionVersion''').'''version''' is (0 for normal keys or 1 for extended keys).
Decrypts '''enc_privk_in_bufDataIn''' with a key generated from '''key_xAccessKey''' and '''key_yKeySource''' and imports it for later usage.
[5.0.0+] This The '''Version''' argument was removed and this now calls the [[SMC#ReEncryptRsaPrivateKeyReencryptDeviceUniqueData|ReEncryptRsaPrivateKey ReencryptDeviceUniqueData SMC]] instead.
== DecryptLotusMessage ==
Takes 3 input type-9 (X descriptor) 0x9 buffers ('''data_in_bufDataIn''', '''mod_in_bufModIn''' and '''label_hash_in_bufLabelHashIn''').
Uses the [[SMC#SecureExpModModularExponentiateByStorageKey|SecureExpMod ModularExponentiateByStorageKey SMC]] to decrypt '''data_in_bufDataIn''' using the private key imported with [[#ImportLotusKey]] and the supplied '''mod_in_bufModIn''' and '''label_hash_in_bufLabelHashIn'''.
== IsDevelopment ==
No input params. 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. Returns an u8 flag for whether the system is devunit. Output flag is 0 on retail.
== GenerateSpecificAesKey ==
Wrapper for [[SMC#GenerateSpecificAesKey|GenerateSpecificAesKey SMC]].
Takes a an input 16-byte seed ('''key_seedKeySource''') and two words (input u32s '''KeyGenerationGeneration''' and '''optionOption'''. Returns an output 16-byte '''AesKey''') as input.
Returns a scrambled key ('''key_a''')== DecryptDeviceUniqueData ==Wrapper for [[SMC#DecryptDeviceUniqueData|DecryptDeviceUniqueData SMC]].
== DecryptRsaPrivateKey ==Wrapper 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 [[SMC#DecryptRsaPrivateKey|DecryptRsaPrivateKey SMC]]normal keys or 1 for extended keys).
Takes one type-10 (C descriptor) buffer (Decrypts '''dec_privk_out_bufDataIn'''), one type-9 (X descriptor) buffer (into '''enc_privk_in_bufDataOut'''), with a 16-byte KEK ('''key_x'''), a 16-byte key (generated from '''key_yAccessKey''') and a u32 ('''version''').'''versionKeySource''' 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_services|SSL]] for TLS client-privk.
Used by [[SSL_services|SSL]]-sysmodule for TLS client-privk. [5.0.0+] This now calls [[SMC#DecryptOrImportRsaPrivateKey|DecryptOrImportRsaPrivateKey SMC]] insteadThe '''Version''' argument was removed.
== DecryptAesKey ==
Takes a an input 16-byte encrypted key ('''enc_keyKeySource''') and two words (input u32s '''KeyGenerationGeneration''' and '''optionOption'''. Returns an output 16-byte '''AesKey''') as input.
Decrypts (AES-ECB) '''enc_keyKeySource''' 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''').
[2.0.0+] Introduced same keyslot allocation code as for [[#GenerateAesKey]].
== CryptAesCtr ==
Takes a an output type-0x46 (B descriptor) buffer ('''data_out_bufDataOut'''), a an input u32 ('''keyslotKeyslot'''), a an input type-0x45 (A descriptor) buffer ('''data_in_bufDataIn''') and a an input 16-byte CTR ('''aes_ctrIvCtr''').
Uses [[SMC#ComputeAes|ComputeAes SMC]] to decrypt '''data_in_bufDataIn''' into '''data_out_bufDataOut''', using the key set in the specified '''keyslotKeyslot'''.
[2.0.0+] Verifies the keyslot was allocated in by the current session.
== ComputeCmac ==
Wrapper for [[SMC#ComputeCmac|ComputeCmac SMC]].
Takes one an input type-9 (X descriptor) 0x9 buffer ('''data_in_bufDataIn''') and a an input u32 ('''type?Keyslot'''). Returns a an output 16-byte CMAC calculated over '''data_in_bufCmac'''.
[2.0.0+] Verifies the keyslot was allocated in by the current session.
== ImportEsKey ==
Wrapper for [[SMC#ImportEsKeyDecryptAndImportEsDeviceKey|ImportEsKey DecryptAndImportEsDeviceKey SMC]].
Takes one an input type-9 (X descriptor) 0x9 buffer (enc_privk_in_buf)'''DataIn''', a an input 16-byte KEK (key_x)'''AccessKey''', a an input 16-byte key (key_y) '''KeySource''' and a an input u32 '''Version''' (version). version is 0 for normal keys or 1 for extended keys).
Decrypts enc_privk_in_buf '''DataIn''' with a key generated from key_x '''AccessKey''' and key_y '''KeySource''' and imports it for later usage.
[5.0.0+] This The '''Version''' argument was removed and this now calls the [[SMC#ReEncryptRsaPrivateKeyReencryptDeviceUniqueData|ReEncryptRsaPrivateKey ReencryptDeviceUniqueData SMC]] instead.
== UnwrapTitleKey ==
Wrapper for [[SMC#UnwrapTitleKeyPrepareEsDeviceUniqueKey|UnwrapTitleKey PrepareEsDeviceUniqueKey SMC]].
Takes one an output type-10 (C descriptor) 0xA buffer ('''data_out_bufDataOut''') and 3 input type-9 (X descriptor) 0x9 buffers ('''data_in_bufDataIn''', '''mod_in_bufModIn''' and '''label_hash_in_bufLabelHashIn'''. Returns an output u32 '''DataOutSize''').
Decrypts '''data_in_buf''' into '''data_out_buf''' using the private key imported with [[#ImportEsKey]3.0.0+] and the supplied '''mod_in_buf'''. Afterwards, verifies RSA-OAEP encoding using Now takes an input u32 '''label_hash_in_bufGeneration'''.
Returns an u32 (Decrypts '''dec_data_sizeDataIn''' into '''DataOut''' using the private key imported with [[#ImportEsKey]] and the supplied '''ModIn'''. Afterwards, verifies RSA-OAEP encoding using '''LabelHashIn''').
== LoadTitleKey ==
Wrapper for [[SMC#LoadTitleKeyLoadPreparedAesKey|LoadTitleKey LoadPreparedAesKey SMC]].
Takes a an input u32 ('''keyslotKeyslot''') and a an input 16-byte sealed titlekey. Sets the specified '''keyslotAccessKey''' with the titlekey.
[2.0.0+] Verifies the keyslot was allocated in the current session.
== UnwrapCommonTitleKey ==
Wrapper for [[SMC#UnwrapCommonTitleKeyPrepareEsCommonKey|UnwrapCommonTitleKey PrepareEsCommonKey SMC]].
Takes a an input 16-byte EKS ('''Encryption Key SourceKeySource'''. Returns an output 16-byte '''AccessKey''').
Returns a sealed titlekey[3.0.0+] Now takes an input u32 '''Generation'''.
== AllocateAesKeyslot ==
Returns an allocated keyslot, or output u32 '''Keyslot'''. Returns error 0xD01A if all keyslots are taken. You need to allocate a keyslot before using AES functions == DeallocateAesKeySlot ==Takes an input u32 '''Keyslot'''.
== FreeAesKeyslot ==Takes a single u32 and frees Returns error 0xD21A if the keyslot. The keyslot must have been wasn't allocated by current session otherwise 0xD21A will be returned.
== GetAesKeyslotAvailableEvent ==
Returns an output event handle for synchronizing with the AES keyslots.
== SetBootReason ==
Sets a static dword in spl .bss to the Takes an input u32 '''BootReason'''.
[4.0.0+] returns Returns 0xD41A if a value has been previously set without being [[#GetBootReason|gotten]].
== GetBootReason ==
Returns the static dword an output u32 '''BootReason''' in spl .bss that can be set via [[#SetBootReason]].
[4.0.0+] returns Returns 0xD61A if a value has not previously been set, and unsets the value after getting it.
== LoadElicenseKey LoadPreparedAesKey ==
Same as [[#LoadTitleKey|LoadTitleKey]].
 
= spl:mig =
This is "nn::spl::detail::ICryptoInterface".
 
{| 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.0.0+] [[#DeallocateAesKeySlot]]
|-
| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]
|}
 
= spl:fs =
This is "nn::spl::detail::IFsInterface".
 
{| 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.0.0+] [[#DeallocateAesKeySlot]]
|-
| 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"
|-
! 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.0.0+] [[#DeallocateAesKeySlot]]
|-
| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]
|-
| 13 || [[#DecryptDeviceUniqueData]]
|-
| 26 || [5.0.0+] DecryptAndStoreSslClientCertKey
|-
| 27 || [5.0.0+] ModularExponentiateWithSslClientCertKey
|}
 
= spl:es =
This is "nn::spl::detail::IEsInterface".
 
{| 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.0.0+] [[#DeallocateAesKeySlot]]
|-
| 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]]
|}
 
= spl:manu =
This is "nn::spl::detail::IManuInterface".
 
{| 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.0.0+] [[#DeallocateAesKeySlot]]
|-
| 23 || [2.0.0+] [[#GetAesKeyslotAvailableEvent]]
|-
| 13 || [[#DecryptDeviceUniqueData]]
|-
| 30 || [5.0.0+] ReencryptDeviceUniqueData
|}
[[Category:Services]]

Navigation menu