/*******************************************************************************
 * shroudBNC - an object-oriented framework for IRC                            *
 * Copyright (C) 2005-2011 Gunnar Beutner                                      *
 *                                                                             *
 * This program is free software; you can redistribute it and/or               *
 * modify it under the terms of the GNU General Public License                 *
 * as published by the Free Software Foundation; either version 2              *
 * of the License, or (at your option) any later version.                      *
 *                                                                             *
 * This program 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 General Public License for more details.                                *
 *                                                                             *
 * You should have received a copy of the GNU General Public License           *
 * along with this program; if not, write to the Free Software                 *
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. *
 *******************************************************************************/

#ifndef KEYRING_H
#define KEYRING_H

/**
 * CKeyring
 *
 * A keyring used for storing channel keys.
 */
class SBNCAPI CKeyring : public CObject<CKeyring, CUser> {
private:
	CConfig *m_Config; /**< the config object for storing the channel keys */

public:
#ifndef SWIG
	CKeyring(CConfig *Config, CUser *Owner);
#endif /* SWIG */

	RESULT<bool> SetKey(const char *Channel, const char *Key = NULL);
	RESULT<const char *> GetKey(const char *Channel);
	bool RemoveRedundantKeys(void);
};

#endif /* KEYRING_H */