LibreOffice LibreOffice 26.2 SDK C/C++ API Reference

Loading...
Searching...
No Matches
security.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20/*
21 * This file is part of LibreOffice published API.
22 */
23
24#ifndef INCLUDED_OSL_SECURITY_HXX
25#define INCLUDED_OSL_SECURITY_HXX
26
27#include "sal/config.h"
28
29#include <cstddef>
30
31#include "rtl/ustring.hxx"
32#include "osl/security_decl.hxx"
33
34 namespace osl
35{
36
37 inline Security::Security()
38{
39 m_handle = osl_getCurrentSecurity();
40}
41
42 inline Security::~Security()
43{
44 osl_freeSecurityHandle(m_handle);
45}
46
47 inline bool Security::logonUser(const rtl::OUString& strName,
48 const rtl::OUString& strPasswd)
49{
50 osl_freeSecurityHandle(m_handle);
51
52 m_handle = NULL;
53
54 return (osl_loginUser( strName.pData, strPasswd.pData, &m_handle)
55 == osl_Security_E_None);
56}
57
58 inline bool Security::logonUser( const rtl::OUString& strName,
59 const rtl::OUString& strPasswd,
60 const rtl::OUString& strFileServer )
61{
62 osl_freeSecurityHandle(m_handle);
63
64 m_handle = NULL;
65
66 return (osl_loginUserOnFileServer(strName.pData, strPasswd.pData, strFileServer.pData, &m_handle)
67 == osl_Security_E_None);
68}
69
70 inline bool Security::getUserIdent( rtl::OUString& strIdent) const
71{
72 return osl_getUserIdent( m_handle, &strIdent.pData );
73}
74
75
76 inline bool Security::getUserName( rtl::OUString& strName, bool bIncludeDomain ) const
77{
78 if (bIncludeDomain)
79 return osl_getUserName( m_handle, &strName.pData );
80 return osl_getShortUserName( m_handle, &strName.pData );
81}
82
83
84 inline bool Security::getHomeDir( rtl::OUString& strDirectory) const
85{
86 return osl_getHomeDir(m_handle, &strDirectory.pData );
87}
88
89
90 inline bool Security::getConfigDir( rtl::OUString& strDirectory ) const
91{
92 return osl_getConfigDir( m_handle, &strDirectory.pData );
93}
94
95 inline bool Security::isAdministrator() const
96{
97 return osl_isAdministrator(m_handle);
98}
99
100 inline oslSecurity Security::getHandle() const
101{
102 return m_handle;
103}
104
105
106}
107
108#endif // INCLUDED_OSL_SECURITY_HXX
109
110/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
config.h
ustring.hxx
osl_Security_E_None
@ osl_Security_E_None
Definition security.h:37
osl_getConfigDir
SAL_DLLPUBLIC sal_Bool osl_getConfigDir(oslSecurity Security, rtl_uString **strDirectory)
Get the directory for configuration data of the user of this security handle.
osl_getUserName
SAL_DLLPUBLIC sal_Bool osl_getUserName(oslSecurity Security, rtl_uString **strName)
Get the login name for the user of this security handle.
osl_getHomeDir
SAL_DLLPUBLIC sal_Bool osl_getHomeDir(oslSecurity Security, rtl_uString **strDirectory)
Get the home directory of the user of this security handle.
osl_getShortUserName
SAL_DLLPUBLIC sal_Bool osl_getShortUserName(oslSecurity Security, rtl_uString **strName)
Get the login name for the user of this security handle, excluding the domain name on Windows.
osl_isAdministrator
SAL_DLLPUBLIC sal_Bool osl_isAdministrator(oslSecurity Security)
Query if the user who is denotes by this security has administrator rights.
osl_freeSecurityHandle
SAL_DLLPUBLIC void osl_freeSecurityHandle(oslSecurity Security)
Free the security handle, created by osl_loginUser or osl_getCurrentSecurity.
osl_loginUserOnFileServer
SAL_DLLPUBLIC oslSecurityError osl_loginUserOnFileServer(rtl_uString *strUserName, rtl_uString *strPasswd, rtl_uString *strFileServer, oslSecurity *pSecurity)
Create a security handle for the denoted user.
osl_getCurrentSecurity
SAL_DLLPUBLIC oslSecurity osl_getCurrentSecurity(void)
Create a security handle for the current user.
osl_getUserIdent
SAL_DLLPUBLIC sal_Bool osl_getUserIdent(oslSecurity Security, rtl_uString **strIdent)
Get the login ident for the user of this security handle.
oslSecurity
void * oslSecurity
Process handle.
Definition security.h:49
osl_loginUser
SAL_DLLPUBLIC oslSecurityError osl_loginUser(rtl_uString *strUserName, rtl_uString *strPasswd, oslSecurity *pSecurity)
Deprecated API Create a security handle for the denoted user.
security_decl.hxx
osl
Definition condition.hxx:31
rtl::OUString
This String class provides base functionality for C++ like Unicode character array handling.
Definition ustring.hxx:172
osl::Security::Security
Security()
Definition security.hxx:37
osl::Security::getUserIdent
bool getUserIdent(rtl::OUString &strIdent) const
get the ident of the logged in user.
Definition security.hxx:70
osl::Security::isAdministrator
bool isAdministrator() const
Query if the user who is logged in has administrator rights.
Definition security.hxx:95
osl::Security::~Security
~Security()
Definition security.hxx:42
osl::Security::m_handle
oslSecurity m_handle
Definition security_decl.hxx:41
osl::Security::getConfigDir
bool getConfigDir(rtl::OUString &strDirectory) const
get the directory for configuration data of the logged in user.
Definition security.hxx:90
osl::Security::getHomeDir
bool getHomeDir(rtl::OUString &strDirectory) const
get the home directory of the logged in user.
Definition security.hxx:84
osl::Security::getHandle
oslSecurity getHandle() const
Returns the underlying oslSecurity handle.
Definition security.hxx:100
osl::Security::getUserName
bool getUserName(rtl::OUString &strName, bool bIncludeDomain=true) const
get the name of the logged in user.
Definition security.hxx:76
osl::Security::logonUser
bool logonUser(const rtl::OUString &strName, const rtl::OUString &strPasswd)
get the security information for one user.
Definition security.hxx:47