docpasswordhelper.hxx

Go to the documentation of this file.

/* -*- 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 .
 */

#ifndef INCLUDED_COMPHELPER_DOCPASSWORDHELPER_HXX
#define INCLUDED_COMPHELPER_DOCPASSWORDHELPER_HXX

#include <comphelper/comphelperdllapi.h>
#include <string_view>
#include <vector>
#include <comphelper/docpasswordrequest.hxx>
#include <comphelper/hash.hxx>

namespace com::sun::star::task { class XInteractionHandler; }
namespace com::sun::star::beans { struct PropertyValue; }
namespace com::sun::star::beans { struct NamedValue; }

namespace comphelper {

enum class DocPasswordVerifierResult
{
    OK,
    WrongPassword,
    Abort
};


class COMPHELPER_DLLPUBLIC IDocPasswordVerifier
{
public:
    virtual             ~IDocPasswordVerifier();

    virtual DocPasswordVerifierResult verifyPassword( const OUString& rPassword, css::uno::Sequence< css::beans::NamedValue >& o_rEncryptionData ) = 0;

    virtual DocPasswordVerifierResult verifyEncryptionData( const css::uno::Sequence< css::beans::NamedValue >& o_rEncryptionData ) = 0;

};


class COMPHELPER_DLLPUBLIC DocPasswordHelper
{
public:


    static css::uno::Sequence< css::beans::PropertyValue >
        GenerateNewModifyPasswordInfo( std::u16string_view aPassword );


    static bool IsModifyPasswordCorrect(
                std::u16string_view aPassword,
                const css::uno::Sequence< css::beans::PropertyValue >& aInfo );


    static sal_uInt32 GetWordHashAsUINT32(
                const OUString& aString );


    static sal_uInt16 GetXLHashAsUINT16(
                std::u16string_view aString,
                rtl_TextEncoding nEnc = RTL_TEXTENCODING_UTF8 );


    static css::uno::Sequence< sal_Int8 > GetXLHashAsSequence(
                std::u16string_view aString );


    static css::uno::Sequence<sal_Int8> GetOoxHashAsSequence(
            const OUString& rPassword,
            const OUString& rSaltValue,
            sal_uInt32 nSpinCount,
            comphelper::Hash::IterCount eIterCount,
             std::u16string_view rAlgorithmName);


    static OUString GetOoxHashAsBase64(
            const OUString& rPassword,
            const OUString& rSaltValue,
            sal_uInt32 nSpinCount,
            comphelper::Hash::IterCount eIterCount,
            std::u16string_view rAlgorithmName);


    static std::vector<unsigned char> GetOoxHashAsVector(
            const OUString& rPassword,
            const std::vector<unsigned char>& rSaltValue,
            sal_uInt32 nSpinCount,
            comphelper::Hash::IterCount eIterCount,
            std::u16string_view rAlgorithmName);


    static css::uno::Sequence< sal_Int8 > GenerateRandomByteSequence(
                sal_Int32 nLength );


    static css::uno::Sequence< sal_Int8 > GenerateStd97Key(
                const OUString& aPassword,
                const css::uno::Sequence< sal_Int8 >& aDocId );


    static css::uno::Sequence< sal_Int8 > GenerateStd97Key(
                const sal_uInt16 pPassData[16],
                const css::uno::Sequence< sal_Int8 >& aDocId );

    static css::uno::Sequence< sal_Int8 > GenerateStd97Key(
                const sal_uInt16 pPassData[16],
                const sal_uInt8 pDocId[16] );


    static css::uno::Sequence< css::beans::NamedValue > requestAndVerifyDocPassword(
                            IDocPasswordVerifier& rVerifier,
                            const css::uno::Sequence< css::beans::NamedValue >& rMediaEncData,
                            const OUString& rMediaPassword,
                            const css::uno::Reference< css::task::XInteractionHandler >& rxInteractHandler,
                            const OUString& rDocumentUrl,
                            DocPasswordRequestType eRequestType,
                            const ::std::vector< OUString >* pDefaultPasswords = nullptr,
                            bool* pbIsDefaultPassword = nullptr );

    static css::uno::Sequence< css::beans::NamedValue > decryptGpgSession(
        const css::uno::Sequence< css::uno::Sequence< css::beans::NamedValue > >& rGpgProperties);

private:
                        ~DocPasswordHelper();
};


} // namespace comphelper

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */