CryptoKey.xml 1.1 KB

1234567891011121314151617181920212223242526272829303132333435
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CryptoKey" inherits="Resource" version="3.2">
  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. </return>
  17. <argument index="0" name="path" type="String">
  18. </argument>
  19. <description>
  20. Loads a key from [code]path[/code] ("*.key" file).
  21. </description>
  22. </method>
  23. <method name="save">
  24. <return type="int" enum="Error">
  25. </return>
  26. <argument index="0" name="path" type="String">
  27. </argument>
  28. <description>
  29. Saves a key to the given [code]path[/code] (should be a "*.key" file).
  30. </description>
  31. </method>
  32. </methods>
  33. <constants>
  34. </constants>
  35. </class>