/usr/include/giomm-2.4/giomm/tlsinteraction.h is in libglibmm-2.4-dev 2.42.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_TLSINTERACTION_H
#define _GIOMM_TLSINTERACTION_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2012 The giomm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/object.h>
#include <giomm/asyncresult.h>
#include <giomm/tlsconnection.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GTlsInteraction GTlsInteraction;
typedef struct _GTlsInteractionClass GTlsInteractionClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class TlsInteraction_Class; } // namespace Gio
namespace Gio
{
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var TlsInteractionResult TLS_INTERACTION_UNHANDLED
* The interaction was unhandled (i.e.\ not implemented).
*
* @var TlsInteractionResult TLS_INTERACTION_HANDLED
* The interaction completed, and resulting data is available.
*
* @var TlsInteractionResult TLS_INTERACTION_FAILED
* The interaction has failed, or was cancelled. and the operation should be aborted.
*
* @enum TlsInteractionResult
*
* TlsInteractionResult is returned by various functions in TlsInteraction
* when finishing an interaction request.
*
* @newin{2,30}
* @ingroup giommEnums
*/
enum TlsInteractionResult
{
TLS_INTERACTION_UNHANDLED,
TLS_INTERACTION_HANDLED,
TLS_INTERACTION_FAILED
};
} // namespace Gio
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gio::TlsInteractionResult> : public Glib::Value_Enum<Gio::TlsInteractionResult>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
/**
* @var TlsCertificateRequestFlags TLS_CERTIFICATE_REQUEST_NONE
* No flags.
*
* @enum TlsCertificateRequestFlags
*
* Flags for g_tls_interaction_request_certificate(),
* g_tls_interaction_request_certificate_async(), and
* g_tls_interaction_invoke_request_certificate().
*
* @newin{2,40}
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%TlsCertificateRequestFlags operator|(TlsCertificateRequestFlags, TlsCertificateRequestFlags)</tt><br>
* <tt>%TlsCertificateRequestFlags operator&(TlsCertificateRequestFlags, TlsCertificateRequestFlags)</tt><br>
* <tt>%TlsCertificateRequestFlags operator^(TlsCertificateRequestFlags, TlsCertificateRequestFlags)</tt><br>
* <tt>%TlsCertificateRequestFlags operator~(TlsCertificateRequestFlags)</tt><br>
* <tt>%TlsCertificateRequestFlags& operator|=(TlsCertificateRequestFlags&, TlsCertificateRequestFlags)</tt><br>
* <tt>%TlsCertificateRequestFlags& operator&=(TlsCertificateRequestFlags&, TlsCertificateRequestFlags)</tt><br>
* <tt>%TlsCertificateRequestFlags& operator^=(TlsCertificateRequestFlags&, TlsCertificateRequestFlags)</tt><br>
*/
enum TlsCertificateRequestFlags
{
TLS_CERTIFICATE_REQUEST_NONE = 0x0
};
/** @ingroup giommEnums */
inline TlsCertificateRequestFlags operator|(TlsCertificateRequestFlags lhs, TlsCertificateRequestFlags rhs)
{ return static_cast<TlsCertificateRequestFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline TlsCertificateRequestFlags operator&(TlsCertificateRequestFlags lhs, TlsCertificateRequestFlags rhs)
{ return static_cast<TlsCertificateRequestFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline TlsCertificateRequestFlags operator^(TlsCertificateRequestFlags lhs, TlsCertificateRequestFlags rhs)
{ return static_cast<TlsCertificateRequestFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline TlsCertificateRequestFlags operator~(TlsCertificateRequestFlags flags)
{ return static_cast<TlsCertificateRequestFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline TlsCertificateRequestFlags& operator|=(TlsCertificateRequestFlags& lhs, TlsCertificateRequestFlags rhs)
{ return (lhs = static_cast<TlsCertificateRequestFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline TlsCertificateRequestFlags& operator&=(TlsCertificateRequestFlags& lhs, TlsCertificateRequestFlags rhs)
{ return (lhs = static_cast<TlsCertificateRequestFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline TlsCertificateRequestFlags& operator^=(TlsCertificateRequestFlags& lhs, TlsCertificateRequestFlags rhs)
{ return (lhs = static_cast<TlsCertificateRequestFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gio
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gio::TlsCertificateRequestFlags> : public Glib::Value_Flags<Gio::TlsCertificateRequestFlags>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
class Cancellable;
class TlsPassword;
/** TlsInteraction - Interaction with the user during TLS operations.
* TlsInteraction provides a mechanism for the TLS connection and database code
* to interact with the user. It can be used to ask the user for passwords.
*
* To use a TlsInteraction with a TLS connection use
* Gio::TlsConnection::set_interaction().
*
* Callers should instantiate a derived class that implements the various
* interaction methods to show the required dialogs.
*
* Callers should use the 'invoke' functions like invoke_ask_password() to run
* interaction methods. These functions make sure that the interaction is
* invoked in the main loop and not in the current thread, if the current
* thread is not running the main loop.
*
* Derived classes can choose to implement whichever interactions methods
* they'd like to support by overriding those virtual methods. Any interactions
* not implemented will return Gio::TLS_INTERACTION_UNHANDLED. If a derived
* class implements an async method, it must also implement the corresponding
* finish method.
* @newin{2,36}
*/
class TlsInteraction : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef TlsInteraction CppObjectType;
typedef TlsInteraction_Class CppClassType;
typedef GTlsInteraction BaseObjectType;
typedef GTlsInteractionClass BaseClassType;
private: friend class TlsInteraction_Class;
static CppClassType tlsinteraction_class_;
private:
// noncopyable
TlsInteraction(const TlsInteraction&);
TlsInteraction& operator=(const TlsInteraction&);
protected:
explicit TlsInteraction(const Glib::ConstructParams& construct_params);
explicit TlsInteraction(GTlsInteraction* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~TlsInteraction();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GTlsInteraction* gobj() { return reinterpret_cast<GTlsInteraction*>(gobject_); }
///Provides access to the underlying C GObject.
const GTlsInteraction* gobj() const { return reinterpret_cast<GTlsInteraction*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GTlsInteraction* gobj_copy();
private:
protected:
TlsInteraction();
public:
/** Run synchronous interaction to ask the user for a password. In general,
* g_tls_interaction_invoke_ask_password() should be used instead of this
* function.
*
* Derived subclasses usually implement a password prompt, although they may
* also choose to provide a password from elsewhere. The @a password value will
* be filled in and then @a callback will be called. Alternatively the user may
* abort this password request, which will usually abort the TLS connection.
*
* If the interaction is cancelled by the cancellation object, or by the
* user then TLS_INTERACTION_FAILED will be returned with an error that
* contains a IO_ERROR_CANCELLED error code. Certain implementations may
* not support immediate cancellation.
*
* @newin{2,30}
*
* @param password A TlsPassword object.
* @param cancellable An optional Cancellable cancellation object.
* @return The status of the ask password interaction.
*/
TlsInteractionResult ask_password(const Glib::RefPtr<TlsPassword>& password, const Glib::RefPtr<Cancellable>& cancellable);
/// A ask_password() convenience overload.
TlsInteractionResult ask_password(const Glib::RefPtr<TlsPassword>& password);
/** Run asynchronous interaction to ask the user for a password. In general,
* g_tls_interaction_invoke_ask_password() should be used instead of this
* function.
*
* Derived subclasses usually implement a password prompt, although they may
* also choose to provide a password from elsewhere. The @a password value will
* be filled in and then @a slot will be called. Alternatively the user may
* abort this password request, which will usually abort the TLS connection.
*
* If the interaction is cancelled by the cancellation object, or by the
* user then TLS_INTERACTION_FAILED will be returned with an error that
* contains a IO_ERROR_CANCELLED error code. Certain implementations may
* not support immediate cancellation.
*
* Certain implementations may not support immediate cancellation.
*
* @newin{2,30}
*
* @param password A TlsPassword object.
* @param cancellable An optional Cancellable cancellation object.
* @param slot Will be called when the interaction completes.
*/
void ask_password_async(const Glib::RefPtr<TlsPassword>& password, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable);
/// A ask_password_async() convenience overload.
void ask_password_async(const Glib::RefPtr<TlsPassword>& password, const SlotAsyncReady& slot);
/// A ask_password_async() convenience overload.
void ask_password_async(const Glib::RefPtr<TlsPassword>& password, const Glib::RefPtr<Cancellable>& cancellable);
/// A ask_password_async() convenience overload.
void ask_password_async(const Glib::RefPtr<TlsPassword>& password);
/** Complete an ask password user interaction request. This should be once
* the g_tls_interaction_ask_password_async() completion callback is called.
*
* If TLS_INTERACTION_HANDLED is returned, then the TlsPassword passed
* to g_tls_interaction_ask_password() will have its password filled in.
*
* If the interaction is cancelled by the cancellation object, or by the
* user then TLS_INTERACTION_FAILED will be returned with an error that
* contains a IO_ERROR_CANCELLED error code.
*
* @newin{2,30}
*
* @param result The result passed to the callback.
* @return The status of the ask password interaction.
*/
TlsInteractionResult ask_password_finish(const Glib::RefPtr<AsyncResult>& result);
/** Invoke the interaction to ask the user for a password. It invokes this
* interaction in the main loop, specifically the MainContext returned by
* Glib::main_context_get_thread_default() when the interaction is created. This
* is called by called by TlsConnection or TlsDatabase to ask the user
* for a password.
*
* Derived subclasses usually implement a password prompt, although they may
* also choose to provide a password from elsewhere. The @a password value will
* be filled in and then @a callback will be called. Alternatively the user may
* abort this password request, which will usually abort the TLS connection.
*
* The implementation can either be a synchronous (eg: modal dialog) or an
* asynchronous one (eg: modeless dialog). This function will take care of
* calling which ever one correctly.
*
* If the interaction is cancelled by the cancellation object, or by the
* user then TLS_INTERACTION_FAILED will be returned with an error that
* contains a IO_ERROR_CANCELLED error code. Certain implementations may
* not support immediate cancellation.
*
* @newin{2,30}
*
* @param password A TlsPassword object.
* @param cancellable An optional Cancellable cancellation object.
* @return The status of the ask password interaction.
*/
TlsInteractionResult invoke_ask_password(const Glib::RefPtr<TlsPassword>& password, const Glib::RefPtr<Cancellable>& cancellable);
/// A invoke_ask_password() convenience overload.
TlsInteractionResult invoke_ask_password(const Glib::RefPtr<TlsPassword>& password);
/** Invoke the interaction to ask the user to choose a certificate to
* use with the connection. It invokes this interaction in the main
* loop, specifically the MainContext returned by
* Glib::main_context_get_thread_default() when the interaction is
* created. This is called by called by TlsConnection when the peer
* requests a certificate during the handshake.
*
* Derived subclasses usually implement a certificate selector,
* although they may also choose to provide a certificate from
* elsewhere. Alternatively the user may abort this certificate
* request, which may or may not abort the TLS connection.
*
* The implementation can either be a synchronous (eg: modal dialog) or an
* asynchronous one (eg: modeless dialog). This function will take care of
* calling which ever one correctly.
*
* If the interaction is cancelled by the cancellation object, or by the
* user then TLS_INTERACTION_FAILED will be returned with an error that
* contains a IO_ERROR_CANCELLED error code. Certain implementations may
* not support immediate cancellation.
*
* @newin{2,40}
*
* @param connection A TlsConnection object.
* @param flags Flags providing more information about the request.
* @param cancellable An optional Cancellable cancellation object.
* @return The status of the certificate request interaction.
*/
TlsInteractionResult invoke_request_certificate(const Glib::RefPtr<TlsConnection>& connection, TlsCertificateRequestFlags flags, const Glib::RefPtr<Cancellable>& cancellable);
/// A invoke_request_certificate() convenience overload.
TlsInteractionResult invoke_request_certificate(const Glib::RefPtr<TlsConnection>& connection, TlsCertificateRequestFlags flags);
/** Run synchronous interaction to ask the user to choose a certificate to use
* with the connection. In general, g_tls_interaction_invoke_request_certificate()
* should be used instead of this function.
*
* Derived subclasses usually implement a certificate selector, although they may
* also choose to provide a certificate from elsewhere. Alternatively the user may
* abort this certificate request, which will usually abort the TLS connection.
*
* If TLS_INTERACTION_HANDLED is returned, then the TlsConnection
* passed to g_tls_interaction_request_certificate() will have had its
* TlsConnection::property_certificate() filled in.
*
* If the interaction is cancelled by the cancellation object, or by the
* user then TLS_INTERACTION_FAILED will be returned with an error that
* contains a IO_ERROR_CANCELLED error code. Certain implementations may
* not support immediate cancellation.
*
* @newin{2,40}
*
* @param connection A TlsConnection object.
* @param flags Flags providing more information about the request.
* @param cancellable An optional Cancellable cancellation object.
* @return The status of the request certificate interaction.
*/
TlsInteractionResult request_certificate(const Glib::RefPtr<TlsConnection>& connection, TlsCertificateRequestFlags flags, const Glib::RefPtr<Cancellable>& cancellable);
/// A request_certificate() convenience overload.
TlsInteractionResult request_certificate(const Glib::RefPtr<TlsConnection>& connection, TlsCertificateRequestFlags flags);
/** Run asynchronous interaction to ask the user for a certificate to use with
* the connection. In general, g_tls_interaction_invoke_request_certificate() should
* be used instead of this function.
*
* Derived subclasses usually implement a certificate selector, although they may
* also choose to provide a certificate from elsewhere. @a slot will be called
* when the operation completes. Alternatively the user may abort this certificate
* request, which will usually abort the TLS connection.
*
* @newin{2,40}
*
* @param connection A TlsConnection object.
* @param flags Flags providing more information about the request.
* @param cancellable An optional Cancellable cancellation object.
* @param slot Will be called when the interaction completes.
*/
void request_certificate_async(const Glib::RefPtr<TlsConnection>& connection, TlsCertificateRequestFlags flags, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable);
/// A request_certificate_async() convenience overload.
void request_certificate_async(const Glib::RefPtr<TlsConnection>& connection, TlsCertificateRequestFlags flags, const SlotAsyncReady& slot);
/// A request_certificate_async() convenience overload.
void request_certificate_async(const Glib::RefPtr<TlsConnection>& connection, TlsCertificateRequestFlags flags, const Glib::RefPtr<Cancellable>& cancellable);
/// A request_certificate_async() convenience overload.
void request_certificate_async(const Glib::RefPtr<TlsConnection>& connection, TlsCertificateRequestFlags flags);
/** Complete an request certificate user interaction request. This should be once
* the g_tls_interaction_request_certificate_async() completion callback is called.
*
* If TLS_INTERACTION_HANDLED is returned, then the TlsConnection
* passed to g_tls_interaction_request_certificate_async() will have had its
* TlsConnection::property_certificate() filled in.
*
* If the interaction is cancelled by the cancellation object, or by the
* user then TLS_INTERACTION_FAILED will be returned with an error that
* contains a IO_ERROR_CANCELLED error code.
*
* @newin{2,40}
*
* @param result The result passed to the callback.
* @return The status of the request certificate interaction.
*/
TlsInteractionResult request_certificate_finish(const Glib::RefPtr<AsyncResult>& result);
/// @throws Glib::Error.
virtual TlsInteractionResult ask_password_vfunc(const Glib::RefPtr<TlsPassword>& password, const Glib::RefPtr<Cancellable>& cancellable);
virtual void ask_password_async_vfunc(const Glib::RefPtr<TlsPassword>& password, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable);
/// @throws Glib::Error.
virtual TlsInteractionResult ask_password_finish_vfunc(const Glib::RefPtr<AsyncResult>& result);
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::TlsInteraction
*/
Glib::RefPtr<Gio::TlsInteraction> wrap(GTlsInteraction* object, bool take_copy = false);
}
#endif /* _GIOMM_TLSINTERACTION_H */
|