diff options
Diffstat (limited to 'dbus/dbus-auth-script.c')
-rw-r--r-- | dbus/dbus-auth-script.c | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/dbus/dbus-auth-script.c b/dbus/dbus-auth-script.c index 21a9f996..4dccfe9f 100644 --- a/dbus/dbus-auth-script.c +++ b/dbus/dbus-auth-script.c @@ -170,6 +170,16 @@ auth_state_to_string (DBusAuthState state) return "unknown"; } +/** + * Runs an "auth script" which is a script for testing the + * authentication protocol. Scripts send and receive data, and then + * include assertions about the state of both ends of the connection + * after processing the data. A script succeeds if these assertions + * hold. + * + * @param filename the file containing the script to run + * @returns #TRUE if the script succeeds, #FALSE otherwise + */ dbus_bool_t _dbus_auth_script_run (const DBusString *filename) { |