csrfprotection.h

/*
 * Copyright (C) 2017 Matthias Fehring <kontakt@buschmann23.de>
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef CSRFPROTECTION_H
#define CSRFPROTECTION_H
 
#include <Cutelyst/cutelyst_global.h>
#include <Cutelyst/Plugin>
 
namespace Cutelyst {
 
class Context;
class CSRFProtectionPrivate;
 
class CUTELYST_PLUGIN_CSRFPROTECTION_EXPORT CSRFProtection : public Plugin
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(CSRFProtection)
public:
    CSRFProtection(Application *parent);
 
    virtual ~CSRFProtection() override;
 
    void setDefaultDetachTo(const QString &actionNameOrPath);
 
    void setFormFieldName(const QString &fieldName);
 
    void setErrorMsgStashKey(const QString &keyName);
 
    void setIgnoredNamespaces(const QStringList &namespaces);
 
    void setUseSessions(bool useSessions);
 
    void setCookieHttpOnly(bool httpOnly);
 
    void setCookieName(const QString &cookieName);
 
    void setHeaderName(const QString &headerName);
 
    void setGenericErrorMessage(const QString &message);
 
    void setGenericErrorContentTyp(const QString &type);
 
    static QByteArray getToken(Context *c);
 
    static QString getTokenFormField(Context *c);
 
    static bool checkPassed(Context *c);
 
protected:
    CSRFProtectionPrivate *d_ptr;
 
    virtual bool setup(Application *app) override;
};
 
}
 
#endif // CSRFPROTECTION_H