class_x509certificate.rst 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the X509Certificate.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_X509Certificate:
  6. X509Certificate
  7. ===============
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. An X509 certificate (e.g. for SSL).
  13. Methods
  14. -------
  15. +---------------------------------------+---------------------------------------------------------------------------------------------+
  16. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load<class_X509Certificate_method_load>` **(** :ref:`String<class_String>` path **)** |
  17. +---------------------------------------+---------------------------------------------------------------------------------------------+
  18. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save<class_X509Certificate_method_save>` **(** :ref:`String<class_String>` path **)** |
  19. +---------------------------------------+---------------------------------------------------------------------------------------------+
  20. Description
  21. -----------
  22. The X509Certificate class represents an X509 certificate. Certificates can be loaded and saved like any other :ref:`Resource<class_Resource>`.
  23. They can be used as the server certificate in :ref:`StreamPeerSSL.accept_stream<class_StreamPeerSSL_method_accept_stream>` (along with the proper :ref:`CryptoKey<class_CryptoKey>`), and to specify the only certificate that should be accepted when connecting to an SSL server via :ref:`StreamPeerSSL.connect_to_stream<class_StreamPeerSSL_method_connect_to_stream>`.
  24. Method Descriptions
  25. -------------------
  26. .. _class_X509Certificate_method_load:
  27. - :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
  28. Loads a certificate from ``path`` ("\*.crt" file).
  29. .. _class_X509Certificate_method_save:
  30. - :ref:`Error<enum_@GlobalScope_Error>` **save** **(** :ref:`String<class_String>` path **)**
  31. Saves a certificate to the given ``path`` (should be a "\*.crt" file).