Release 0.7.1 to include upstream copyrights

[moonshot-ui.git] / libmoonshot / libmoonshot.h

diff --git a/libmoonshot/libmoonshot.h b/libmoonshot/libmoonshot.h
index d4af826..d7830c2 100644 (file)
--- a/libmoonshot/libmoonshot.h
+++ b/libmoonshot/libmoonshot.h
@@ -35,6 +35,17 @@
 #ifndef __LIBMOONSHOT_H
 #define __LIBMOONSHOT_H
 
+/**
+ * moonshot_free:
+ * @pointer: pointer to be freed
+ *
+ * All the strings returned by the get_identity() functions must be
+ * freed using this function when they are no longer needed.
+ *
+ * @pointer may be %NULL, in which case no action is taken.
+ */
+void moonshot_free (void *data);
+
 typedef enum {
     MOONSHOT_ERROR_UNABLE_TO_START_SERVICE,
     MOONSHOT_ERROR_NO_IDENTITY_SELECTED,
@@ -44,10 +55,17 @@ typedef enum {
 } MoonshotErrorCode;
 
 typedef struct {
-    MoonshotErrorCode  code;
-    char              *message;
+    int   code;    /* A MoonshotErrorCode */
+    char *message;
 } MoonshotError;
 
+/**
+ * moonshot_error_free:
+ * @error: A #MoonshotError
+ *
+ * Releases the memory used by @error. This function must be called if
+ * a function has returned an error, once it has been reported.
+ */
 void moonshot_error_free (MoonshotError *error);
 
 /**
@@ -116,7 +134,7 @@ int moonshot_get_identity (const char     *nai,
  *
  * Return value: %TRUE if an identity was available, otherwise %FALSE.
  */
-int moonshot_default_get_identity (char          **nai_out,
+int moonshot_get_default_identity (char          **nai_out,
                                    char          **password_out,
                                    char          **server_certificate_hash_out,
                                    char          **ca_certificate_out,
@@ -124,4 +142,49 @@ int moonshot_default_get_identity (char          **nai_out,
                                    char          **subject_alt_name_constraint_out,
                                    MoonshotError **error);
 
+
+/**
+ * moonshot_install_id_card:
+ * @display_name: Display name of card
+ * @user_name: Username for identity, or %NULL
+ * @password: Password for identity, or %NULL
+ * @realm: Realm for identity, or %NULL
+ * @rules_patterns: Array of patterns for the service matching rules
+ * @rules_patterns_length: Length of @rules_patterns and @rules_always_confirm arrays
+ * @rules_always_confirm: Array of 'always confirm' flags corresponding to patterns
+ * @rules_always_confirm_length: Length of @rules_patterns and @rules_always_confirm arrays
+ * @services: Array of strings listing the services this identity provides
+ * @services_length: Length of @services array
+ * @ca_cert: The CA certificate, or %NULL
+ * @subject: Subject name constraint for @ca_cert, or %NULL
+ * @subject_alt: Subject alternative name constraint for @ca_cert, or %NULL
+ * @server_cert: Hash of the server certificate; required if @ca_cert is %NULL
+ * @error: Return location for a #MoonshotError.
+ *
+ * Calls the Moonshot server to add a new identity. The user will be prompted
+ * if they would like to add the ID card.
+ *
+ * The values for @rules_patterns_length and @rules_always_confirm_length should
+ * always be the same. They are present as separate parameters as a concession to
+ * the Vala bindings.
+ *
+ * Return value: %TRUE if the ID card was successfully added, %FALSE otherwise
+ */
+int moonshot_install_id_card (const char     *display_name,
+                              const char     *user_name,
+                              const char     *password,
+                              const char     *realm,
+                              char           *rules_patterns[],
+                              int             rules_patterns_length,
+                              char           *rules_always_confirm[],
+                              int             rules_always_confirm_length,
+                              char           *services[],
+                              int             services_length,
+                              const char     *ca_cert,
+                              const char     *subject,
+                              const char     *subject_alt,
+                              const char     *server_cert,
+                              int             force_flat_file_store,
+                              MoonshotError **error);
+
 #endif