CryptoKey.xml 1.1 KB

12345678910111213141516171819202122232425262728293031
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CryptoKey" inherits="Resource" version="3.3">
  3. <brief_description>
  4. A cryptographic key (RSA).
  5. </brief_description>
  6. <description>
  7. The CryptoKey class represents a cryptographic key. Keys can be loaded and saved like any other [Resource].
  8. They can be used to generate a self-signed [X509Certificate] via [method Crypto.generate_self_signed_certificate] and as private key in [method StreamPeerSSL.accept_stream] along with the appropriate certificate.
  9. [b]Note:[/b] Not available in HTML5 exports.
  10. </description>
  11. <tutorials>
  12. </tutorials>
  13. <methods>
  14. <method name="load">
  15. <return type="int" enum="Error" />
  16. <argument index="0" name="path" type="String" />
  17. <description>
  18. Loads a key from [code]path[/code] ("*.key" file).
  19. </description>
  20. </method>
  21. <method name="save">
  22. <return type="int" enum="Error" />
  23. <argument index="0" name="path" type="String" />
  24. <description>
  25. Saves a key to the given [code]path[/code] (should be a "*.key" file).
  26. </description>
  27. </method>
  28. </methods>
  29. <constants>
  30. </constants>
  31. </class>