otr4j主要接口简介

阅读更多

otr4j定义了3个主要接口，OtrEngine，OtrKeyManager和OtrEngineHost。

OtrEngine

定义：
public interface OtrEngine {

        public String transformReceiving(SessionID sessionID, String content);
        public String transformSending(SessionID sessionID, String content);
       
        public void startSession(SessionID sessionID);
        public void endSession(SessionID sessionID);
        public void refreshSession(SessionID sessionID);
       
        public void addOtrEngineListener(OtrEngineListener l);
        public void removeOtrEngineListener(OtrEngineListener l);
        public SessionStatus getSessionStatus(SessionID sessionID);
       
        public PublicKey getRemotePublicKey(SessionID sessionID);
}
OtrEngine定义Off-the-Record 功能，OtrEngineImpl是一个OtrEngine的实现。主要用于：
1、管理加密会话（startSession, endSession, refreshSession）
2、加密输出，解密输入(transformSending, transformReceiving)
3、获取会话状态 (getSessionStatus) 通知会话状态的改变 (通过OtrEngineListener).


OtrEngineHost

定义：
public interface OtrEngineHost {
        public void injectMessage(SessionID sessionID, String msg);
        public void showWarning(SessionID sessionID, String warning);
        public void showError(SessionID sessionID, String error);
        public OtrPolicy getSessionPolicy(SessionID sessionID);
        public KeyPair getKeyPair(SessionID sessionID);
}
OtrEngineHost定义主程序必须提供给OtrEngine的功能。OtrEngineHost作为一个参数传递给OtrEngineImpl构造器。OtrEngineHost被OtrEngine用来：
1、注入消息，例如在认证密钥交换
2、通知主程序警告和错误
3、获取Off-the-Record会话政策
4、获取长会话密钥对。在此方法的实现中你要调用OtrKeyManager.loadLocalKeyPair（），并且如果返回null，调用OtrKeyManager.generateLocalKeyPair（）。


OtrKeyManager

定义：
public interface OtrKeyManager {

        public void addListener(OtrKeyManagerListener l);
        public void removeListener(OtrKeyManagerListener l);
        public void verify(SessionID sessionID);
        public void unverify(SessionID sessionID);
        public boolean isVerified(SessionID sessionID);
       
        public String getRemoteFingerprint(SessionID sessionID);
        public String getLocalFingerprint(SessionID sessionID);
       
        public void savePublicKey(SessionID sessionID, PublicKey pubKey);
        public void generateLocalKeyPair(SessionID sessionID);
       
        public PublicKey loadRemotePublicKey(SessionID sessionID);
        public KeyPair loadLocalKeyPair(SessionID sessionID);
}
OtrKeyManager定义key管理功能。OtrKeymanagerImpl是OtrKeyManager的一个实现。它完全解耦与OtrEngine，所以你可以实现一个替代的OtrKeyManager，用于通过特殊的方式加载或存储keys。
它用来：
1、确认/取消验证会话（通过各自的方法）
2、获取会话的验证状态(isVerified)，并且告知有关验证状态的改变(通过OtrKeyManagerListener)
3、获取指纹用于主应用程序显示(getRemoteFingerprint, getLocalFingerprint)
4、保存远程各方公钥。主应用程序有一个加密的会话状态发生变化时，调用此方法。（这是可以改善的，公共密钥的保存不应该是主应用程序的责任）。
5、装入本地密钥对，或产生新的密钥对（这通常是在OtrEngineHost.getKeyPair（）中进行，如上面所述）。
6、加载远程公共密钥。当一个加密的会话进行时，主应用程序将要检查是否远程公共密钥等于由OtrKeyManager存储的，如果是，检查该密钥是否被验证。