/*
* Created on Jul 10, 2005
* Created by Alon Rohter
* Copyright (C) 2005, 2006 Aelitis, All Rights Reserved.
*
* 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.
*
* AELITIS, SAS au capital de 46,603.30 euros
* 8 Allee Lenotre, La Grille Royale, 78600 Le Mesnil le Roi, France.
*
*/
package org.gudy.azureus2.plugins.download.session;
import java.util.Map;
import org.gudy.azureus2.plugins.peers.Peer;
import org.gudy.azureus2.plugins.utils.PooledByteBuffer;
/**
* A session authenticator handles secure torrent session handshaking and
* data encryption/decryption on behalf of a download.
*/
public interface SessionAuthenticator {
/**
* Create bencode-able map info for outgoing session syn.
* @param peer with session
* @return syn info
*/
public Map createSessionSyn( Peer peer );
/**
* Decode and verify the given (bencoded) map of incoming session SYN information,
* and create the session ACK reply.
* @param peer with session
* @param syn_info incoming session syn info
* @return bencode-able map info for session ack reply
* @throws SessionAuthenticatorException on verify error / failure
*/
public Map verifySessionSyn( Peer peer, Map syn_info ) throws SessionAuthenticatorException;
/**
* Decode and verify the given (bencoded) map of outgoing session ACK information.
* @param peer with session
* @param ack_info incoming session ack info
* @throws SessionAuthenticatorException on verify error / failure
*/
public void verifySessionAck( Peer peer, Map ack_info ) throws SessionAuthenticatorException;
/**
* Decode the given (possibly encrypted) session data into clean form.
* @param peer with session
* @param encoded_data to decode
* @return decoded form of data
* @throws SessionAuthenticatorException on decode error / failure
*/
public PooledByteBuffer decodeSessionData( Peer peer, PooledByteBuffer encoded_data ) throws SessionAuthenticatorException;
/**
* Encode the given clean session data into (possibly encrypted) encoded form.
* @param peer with session
* @param decoded_data to encode
* @return encoded form of data
* @throws SessionAuthenticatorException on encode error / failure
*/
public PooledByteBuffer encodeSessionData( Peer peer, PooledByteBuffer decoded_data ) throws SessionAuthenticatorException;
}