/usr/include/giomm-2.4/giomm/credentials.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 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_CREDENTIALS_H
#define _GIOMM_CREDENTIALS_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2010 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>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GCredentials GCredentials;
typedef struct _GCredentialsClass GCredentialsClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class Credentials_Class; } // namespace Gio
namespace Gio
{
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var CredentialsType CREDENTIALS_TYPE_INVALID
* Indicates an invalid native credential type.
*
* @var CredentialsType CREDENTIALS_TYPE_LINUX_UCRED
* The native credentials type is a <type>struct ucred</type>.
*
* @var CredentialsType CREDENTIALS_TYPE_FREEBSD_CMSGCRED
* The native credentials type is a <type>struct cmsgcred</type>.
*
* @var CredentialsType CREDENTIALS_TYPE_NETBSD_UNPCBID
* The native credentials type is a <type>struct unpcbid</type>.
*
* @var CredentialsType CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED
* The native credentials type is a <type>struct sockpeercred</type>. Added in 2.30.
*
* @var CredentialsType CREDENTIALS_TYPE_SOLARIS_UCRED
* The native credentials type is a <type>ucred_t</type>. Added in 2.40.
*
* @enum CredentialsType
*
* Enumeration describing different kinds of native credential types.
*
* @newin{2,26}
* @ingroup giommEnums
*/
enum CredentialsType
{
CREDENTIALS_TYPE_INVALID,
CREDENTIALS_TYPE_LINUX_UCRED,
CREDENTIALS_TYPE_FREEBSD_CMSGCRED,
CREDENTIALS_TYPE_NETBSD_UNPCBID,
CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED,
CREDENTIALS_TYPE_SOLARIS_UCRED
};
/** An object containing credentials.
* The Credentials type is a reference-counted wrapper for native credentials.
* This information is typically used for identifying, authenticating and
* authorizing other processes.
*
* Some operating systems supports looking up the credentials of the remote
* peer of a communication endpoint - see e.g. Gio::Socket::get_credentials().
*
* Some operating systems supports securely sending and receiving credentials
* over a Unix Domain Socket, see UnixCredentialsMessage,
* Gio::UnixConnection::send_credentials() and
* Gio::UnixConnection::receive_credentials() for details.
*
* On Linux, the native credential type is a struct ucred - see the unix(7)
* man page for details. This corresponds to
* Gio::CREDENTIALS_TYPE_LINUX_UCRED.
*
* On FreeBSD, the native credential type is a struct cmsgcred. This
* corresponds to Gio::CREDENTIALS_TYPE_FREEBSD_CMSGCRED.
*
* @newin{2,28}
*/
class Credentials : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Credentials CppObjectType;
typedef Credentials_Class CppClassType;
typedef GCredentials BaseObjectType;
typedef GCredentialsClass BaseClassType;
private: friend class Credentials_Class;
static CppClassType credentials_class_;
private:
// noncopyable
Credentials(const Credentials&);
Credentials& operator=(const Credentials&);
protected:
explicit Credentials(const Glib::ConstructParams& construct_params);
explicit Credentials(GCredentials* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Credentials();
/** 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.
GCredentials* gobj() { return reinterpret_cast<GCredentials*>(gobject_); }
///Provides access to the underlying C GObject.
const GCredentials* gobj() const { return reinterpret_cast<GCredentials*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GCredentials* gobj_copy();
private:
protected:
Credentials();
public:
static Glib::RefPtr<Credentials> create();
/** Creates a human-readable textual representation of @a credentials
* that can be used in logging and debug messages. The format of the
* returned string may change in future GLib release.
*
* @newin{2,26}
*
* @return A string that should be freed with Glib::free().
*/
Glib::ustring to_string() const;
/** Gets a pointer to native credentials of type @a native_type from
* @a credentials.
*
* It is a programming error (which will cause an warning to be
* logged) to use this method if there is no Credentials support for
* the OS or if @a native_type isn't supported by the OS.
*
* @newin{2,26}
*
* @param native_type The type of native credentials to get.
* @return The pointer to native credentials or <tt>0</tt> if the
* operation there is no Credentials support for the OS or if
* @a native_type isn't supported by the OS. Do not free the returned
* data, it is owned by @a credentials.
*/
gpointer get_native(CredentialsType native_type);
/** Copies the native credentials of type @a native_type from @a native
* into @a credentials.
*
* It is a programming error (which will cause an warning to be
* logged) to use this method if there is no Credentials support for
* the OS or if @a native_type isn't supported by the OS.
*
* @newin{2,26}
*
* @param native_type The type of native credentials to set.
* @param native A pointer to native credentials.
*/
void set_native(CredentialsType native_type, gpointer native);
/** Checks if @a credentials and @a other_credentials is the same user.
*
* This operation can fail if Credentials is not supported on the
* the OS.
*
* @newin{2,26}
*
* @param other_credentials A Credentials.
* @return <tt>true</tt> if @a credentials and @a other_credentials has the same
* user, <tt>false</tt> otherwise or if @a error is set.
*/
bool is_same_user(const Glib::RefPtr<const Credentials>& other_credentials);
#ifdef G_OS_UNIX
/** Tries to get the UNIX user identifier from @a credentials. This
* method is only available on UNIX platforms.
*
* This operation can fail if Credentials is not supported on the
* OS or if the native credentials type does not contain information
* about the UNIX user.
*
* @newin{2,26}
*
* @return The UNIX user identifier or -1 if @a error is set.
*/
uid_t get_unix_user();
#endif // G_OS_UNIX
#ifdef G_OS_UNIX
/** Tries to set the UNIX user identifier on @a credentials. This method
* is only available on UNIX platforms.
*
* This operation can fail if Credentials is not supported on the
* OS or if the native credentials type does not contain information
* about the UNIX user. It can also fail if the OS does not allow the
* use of "spoofed" credentials.
*
* @newin{2,26}
*
* @param uid The UNIX user identifier to set.
* @return <tt>true</tt> if @a uid was set, <tt>false</tt> if error is set.
*/
bool set_unix_user(uid_t uid);
#endif // G_OS_UNIX
#ifdef G_OS_UNIX
/** Tries to get the UNIX process identifier from @a credentials. This
* method is only available on UNIX platforms.
*
* This operation can fail if Credentials is not supported on the
* OS or if the native credentials type does not contain information
* about the UNIX process ID.
*
* @newin{2,36}
*
* @return The UNIX process ID, or -1 if @a error is set.
*/
pid_t get_unix_pid() const;
#endif // G_OS_UNIX
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::Credentials
*/
Glib::RefPtr<Gio::Credentials> wrap(GCredentials* object, bool take_copy = false);
}
#endif /* _GIOMM_CREDENTIALS_H */
|