b1fb6338cf
Change-Id: I744788bde9778f85ccd9d7667e19d16842900a29 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/110248 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
133 lines
4.7 KiB
C++
133 lines
4.7 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
/*
|
|
* This file is part of LibreOffice published API.
|
|
*/
|
|
|
|
#ifndef INCLUDED_OSL_SECURITY_DECL_HXX
|
|
#define INCLUDED_OSL_SECURITY_DECL_HXX
|
|
|
|
#include "rtl/ustring.hxx"
|
|
#include "osl/security.h"
|
|
|
|
namespace osl
|
|
{
|
|
|
|
/** Encapsulate security information for one user.
|
|
A object of this class is used to execute a process with the rights an
|
|
security options of a specified user.
|
|
@see Process::executeProcess
|
|
*/
|
|
class Security
|
|
{
|
|
protected:
|
|
oslSecurity m_handle;
|
|
|
|
public:
|
|
inline Security();
|
|
inline ~Security();
|
|
|
|
/** get the security information for one user.
|
|
The underlying operating system is asked for this information.
|
|
|
|
@param[in] strName denotes the name of the user
|
|
@param[in] strPasswd denotes the password of this user
|
|
|
|
@retval True, if the specified user is known by the underlying operating system
|
|
@retval False unknown user
|
|
*/
|
|
inline bool SAL_CALL logonUser(const rtl::OUString& strName,
|
|
const rtl::OUString& strPasswd);
|
|
|
|
/** get the security information for one user.
|
|
|
|
@verbatim
|
|
This method will try to login the user at the denoted file server.
|
|
If a network resource named \\server\username exists and this resource
|
|
could be connected by this user, the method will return true and getHomeDir
|
|
will return \\server\username.
|
|
@endverbatim
|
|
|
|
@param[in] strName denotes the name of the user
|
|
@param[in] strPasswd denotes the password of this user
|
|
@param[in] strFileServer denotes the file server to login to
|
|
|
|
@retval True if the specified user is known by the file server and they
|
|
could be connected
|
|
@retval False if the user is not known by the file server
|
|
*/
|
|
inline bool SAL_CALL logonUser(const rtl::OUString & strName,
|
|
const rtl::OUString & strPasswd,
|
|
const rtl::OUString & strFileServer);
|
|
|
|
/** get the ident of the logged in user.
|
|
|
|
@param[out] strIdent is the OUString which returns the name
|
|
|
|
@retval True if any user is successfully logged in
|
|
@retval False no user logged in
|
|
*/
|
|
inline bool SAL_CALL getUserIdent( rtl::OUString& strIdent) const;
|
|
|
|
/** get the name of the logged in user.
|
|
|
|
@param[out] strName is the OUString which returns the name
|
|
@param[in] bIncludeDomain Include the Domain name (like "ORG\username"). Affects Windows only.
|
|
This parameter is available since LibreOffice 5.2.
|
|
|
|
@retval True if any user is successfully logged in
|
|
@retval False if no user is logged in
|
|
*/
|
|
inline bool SAL_CALL getUserName( rtl::OUString& strName, bool bIncludeDomain=true ) const;
|
|
|
|
/** get the home directory of the logged in user.
|
|
@param[out] strDirectory is the OUString which returns the directory name
|
|
|
|
@retval True if any user is successfully logged in
|
|
@retval False if user is not logged in
|
|
*/
|
|
inline bool SAL_CALL getHomeDir( rtl::OUString& strDirectory) const;
|
|
|
|
/** get the directory for configuration data of the logged in user.
|
|
|
|
@param[out] strDirectory is the OUString which returns the directory name
|
|
|
|
@retval True if any user is successfully logged in
|
|
@retval False if user is not logged in
|
|
*/
|
|
inline bool SAL_CALL getConfigDir( rtl::OUString & strDirectory) const;
|
|
|
|
/** Query if the user who is logged in has administrator rights.
|
|
|
|
@retval True if the user has administrator rights
|
|
@retval False if the user does not have admin rights
|
|
*/
|
|
inline bool SAL_CALL isAdministrator() const;
|
|
|
|
/** Returns the underlying oslSecurity handle
|
|
*/
|
|
inline oslSecurity getHandle() const;
|
|
};
|
|
|
|
}
|
|
|
|
#endif // INCLUDED_OSL_SECURITY_DECL_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|