summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/connman-docs.xml1
-rw-r--r--include/security.h6
-rw-r--r--src/security.c14
4 files changed, 22 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index a2e92058..213deb54 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -18,7 +18,7 @@ HFILE_GLOB = $(top_srcdir)/include/*.h
CFILE_GLOB = $(top_srcdir)/src/*.c $(top_srcdir)/src/*.h
IGNORE_HFILES = connman connman.h supplicant.h \
- iface.h rtnl.h dbus.h element.h property.h driver.h security.h
+ iface.h rtnl.h dbus.h element.h property.h driver.h
HTML_IMAGES =
diff --git a/doc/connman-docs.xml b/doc/connman-docs.xml
index 4674a627..0460192c 100644
--- a/doc/connman-docs.xml
+++ b/doc/connman-docs.xml
@@ -66,6 +66,7 @@
</partintro>
<xi:include href="xml/log.xml" />
<xi:include href="xml/plugin.xml" />
+ <xi:include href="xml/security.xml" />
</reference>
<appendix id="license">
diff --git a/include/security.h b/include/security.h
index 104ca7cf..895464ab 100644
--- a/include/security.h
+++ b/include/security.h
@@ -28,6 +28,12 @@ extern "C" {
#include <connman/element.h>
+/**
+ * SECTION:security
+ * @title: Security premitives
+ * @short_description: Functions for registering security modules
+ */
+
#define CONNMAN_SECURITY_PRIORITY_LOW -100
#define CONNMAN_SECURITY_PRIORITY_DEFAULT 0
#define CONNMAN_SECURITY_PRIORITY_HIGH 100
diff --git a/src/security.c b/src/security.c
index f81fc465..05766509 100644
--- a/src/security.c
+++ b/src/security.c
@@ -36,6 +36,14 @@ static gint compare_priority(gconstpointer a, gconstpointer b)
return security2->priority - security1->priority;
}
+/**
+ * connman_security_register:
+ * @security: security module
+ *
+ * Register a new security module
+ *
+ * Returns: %0 on success
+ */
int connman_security_register(struct connman_security *security)
{
DBG("security %p name %s", security, security->name);
@@ -50,6 +58,12 @@ int connman_security_register(struct connman_security *security)
return 0;
}
+/**
+ * connman_security_unregister:
+ * @security: security module
+ *
+ * Remove a previously registered security module
+ */
void connman_security_unregister(struct connman_security *security)
{
DBG("security %p name %s", security, security->name);