docs: Fix a minor syntax error in a documentation comment
[glib.git] / gio / gtlsfiledatabase.c
blob75c01338ed091a0d2d1997c8d2dcce8216c153ac
1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright © 2010 Collabora, Ltd
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 * Author: Stef Walter <stefw@collabora.co.uk>
21 #include "config.h"
23 #include "gtlsfiledatabase.h"
25 #include "ginitable.h"
26 #include "gtlsbackend.h"
27 #include "gtlsdatabase.h"
28 #include "glibintl.h"
30 /**
31 * SECTION:gtlsfiledatabase
32 * @short_description: TLS file based database type
33 * @include: gio/gio.h
35 * #GTlsFileDatabase is implemented by #GTlsDatabase objects which load
36 * their certificate information from a file. It is an interface which
37 * TLS library specific subtypes implement.
39 * Since: 2.30
42 /**
43 * GTlsFileDatabase:
45 * Implemented by a #GTlsDatabase which allows you to load certificates
46 * from a file.
48 * Since: 2.30
50 G_DEFINE_INTERFACE (GTlsFileDatabase, g_tls_file_database, G_TYPE_TLS_DATABASE)
52 static void
53 g_tls_file_database_default_init (GTlsFileDatabaseInterface *iface)
55 /**
56 * GTlsFileDatabase:anchors:
58 * The path to a file containing PEM encoded certificate authority
59 * root anchors. The certificates in this file will be treated as
60 * root authorities for the purpose of verifying other certificates
61 * via the g_tls_database_verify_chain() operation.
63 * Since: 2.30
65 g_object_interface_install_property (iface,
66 g_param_spec_string ("anchors",
67 P_("Anchors"),
68 P_("The certificate authority anchor file"),
69 NULL,
70 G_PARAM_READWRITE |
71 G_PARAM_CONSTRUCT |
72 G_PARAM_STATIC_STRINGS));
75 /**
76 * g_tls_file_database_new:
77 * @anchors: (type filename): filename of anchor certificate authorities.
78 * @error: #GError for error reporting, or %NULL to ignore.
80 * Creates a new #GTlsFileDatabase which uses anchor certificate authorities
81 * in @anchors to verify certificate chains.
83 * The certificates in @anchors must be PEM encoded.
85 * Returns: (transfer full) (type GTlsFileDatabase): the new
86 * #GTlsFileDatabase, or %NULL on error
88 * Since: 2.30
90 GTlsDatabase*
91 g_tls_file_database_new (const gchar *anchors,
92 GError **error)
94 GObject *database;
95 GTlsBackend *backend;
97 backend = g_tls_backend_get_default ();
98 database = g_initable_new (g_tls_backend_get_file_database_type (backend),
99 NULL, error,
100 "anchors", anchors,
101 NULL);
102 return G_TLS_DATABASE (database);