Xmpp學習之Android-smack入門指導
版權聲明:本文為博主原創文章,未經博主允許不得轉載。
快速導航
尷尬TOC目錄模板不管用了,那就簡單來個目錄圖片。
在此為后面的smack學習做筆記,以作備忘。
以下是本次采用的Demo環境:
- Openfire 4.3.8.2
- smack4.2.1
smack之登錄
xmpp首次登錄,可以通過自定義的Socket去進行連接服務器,如果你服務器不是配置了非常特殊TLS連接,一般可以是用Smack中的XMPPConnection
類建立連接(我推薦通過API中的XMPPConnection
去連接,能省去很多復雜的過程),下面我講一下XMPPConnection
的連接配置。
基礎配置
XMPPConnection
的連接需要通過XMPPTCPConnectionConfiguration.builder()
配置你在Openfire設置的配置,代碼如下:
XMPPTCPConnectionConfiguration.Builder builder = XMPPTCPConnectionConfiguration.builder();
builder.setXmppDomain("server domain");
builder.setHostAddress(InetAddress.getByName("you host address"));
//default port 5222
builder.setPort(you port);
builder.setDebuggerEnabled(true);
builder.setCompressionEnabled(true);
builder.setSendPresence(false);
builder.setUsernameAndPassword("username", "password");
像如上代碼中的,XmppDomain是必須配置(這里的XmppDomain
會拼接在首次建立Socket
的IQ中的to和from中),HostAddress是你運行服務器的域名或IP地址,Port是你登錄的端口,在Openfire中默認是5222端口,但如果你的服務器使用的是Nginx做前置機,那么這里你需要填入你的Nginx配置的端口。
進階配置
可能看到這里,你會覺得很奇怪,為什么還有個進階配置,難道Openfire難道登錄就是一個普通的Socket登錄嗎?這樣很容易被黑吧,沒錯,實際上還有進階配置滿足加密連接和自定義的要求,如TLS登錄或SSL登錄或者壓縮通訊,如下例子:
- 如自定義的TLS登錄
TLS的登錄方式,具體筆者也沒實踐過,歡迎拍磚。
SSLContext sslContext = SSLContext.getInstance("TLS");
MemorizingTrustManager mtm = new MemorizingTrustManager(getApplicationContext());
MemorizingKeyManager memorizingKeyManager = new MemorizingKeyManager(getApplicationContext(), "123456");
sslContext.init(new X509KeyManager[]{(X509KeyManager) memorizingKeyManager}
, new X509TrustManager[]{mtm}, new java.security.SecureRandom());
builder.setCustomSSLContext(sslContext);
builder.setHostnameVerifier(mtm.wrapHostnameVerifier(new org.apache.http.conn.ssl.StrictHostnameVerifier()));
以上的代碼需要注意一點是內中的MemorizingTrustManager
,他來自於MemorizingTrustManager,而另外一個MemorizingKeyManager
是自定義的類,內中的代碼其實就是自定義了一個繼承自X509TrustManager
的類,這里不做深究,如有需要可以聯系我。
- 使用舊的TLS連接
實際上這里的意思是關閉安全模式,可以通過如下代碼關閉安全模式
* 其他的兼容方式
實際上就是沿用上面的那個函數```builder.setSecurityMode```中填入的另外兩種方式,以下是這三種方式的注釋和描述:
```JavaDoc
/**
* Security via TLS encryption is required in order to connect. If the server
* does not offer TLS or if the TLS negotiation fails, the connection to the server
* will fail.
*/
required,
/**
* Security via TLS encryption is used whenever it's available. This is the
* default setting.
* <p>
* <b>Do not use this setting</b> unless you can't use {@link #required}. An attacker could easily perform a
* Man-in-the-middle attack and prevent TLS from being used, leaving you with an unencrypted (and
* unauthenticated) connection.
* </p>
*/
ifpossible,
/**
* Security via TLS encryption is disabled and only un-encrypted connections will
* be used. If only TLS encryption is available from the server, the connection
* will fail.
*/
disabled
- 開啟通訊壓縮
這里的通訊壓縮開啟后,傳輸的流量將節省90%
builder.setCompressionEnabled(true);
- SASL認證
Openfire服務器默認支持PLAIN 、ANONYMOUS 、JIVE-SHAREDSECRET
,這里我的服務器開啟的是 PLAIN ,所以我使用 PLAIN
SASLAuthentication.blacklistSASLMechanism(SASLPlainMechanism.NAME);
登錄服務器
通過了上面的配置后,咱們可以登錄Openfire系統了,相當簡單:
if (!xmpptcpConnection.isConnected()) {
xmpptcpConnection.connect();
}else{
System.out.println("Already connected");
}
如果以上的配置和服務器的自定義不匹配,在建立連接的這一步會拋出異常,具體的異常可以通過對應方案處理,這里不詳談。
登錄底層報文通訊簡要解析
作為程序猿,難道會使用API夠了嗎?不,我們繼續折騰,下面一起來看一下底層的通訊報文流程。
- 在建立了Socket后,client會向服務器發出一條xml
SENT
<stream:stream
xmlns='jabber:client'
to='server domain'
xmlns:stream='http://etherx.jabber.org/streams'
version='1.0'
from='username@server domain'
xml:lang='en'>
- 服務器解析到上面的指令后,會返回用於告訴client可選的SASL方式
RECV
<?xml version='1.0' encoding='UTF-8'?>
<stream:stream xmlns:stream="http://etherx.jabber.org/streams"
xmlns="jabber:client"
from="im"
id="c997c3a8"
xml:lang="en"
version="1.0">
<stream:features>
<starttls xmlns="urn:ietf:params:xml:ns:xmpp-tls">
</starttls>
<mechanisms xmlns="urn:ietf:params:xml:ns:xmpp-sasl">
<mechanism>PLAIN</mechanism>
<mechanism>ANONYMOUS</mechanism>
<mechanism>JIVE-SHAREDSECRET</mechanism>
</mechanisms>
<compression xmlns="http://jabber.org/features/compress">
<method>zlib</method>
</compression>
<auth xmlns="http://jabber.org/features/iq-auth"/>
<register xmlns="http://jabber.org/features/iq-register"/>
</stream:features>
- 客戶端選擇
ANONYMOUS
認證方式
SENT
<auth
xmlns='urn:ietf:params:xml:ns:xmpp-sasl'
mechanism='ANONYMOUS'>=</auth>
- 服務器通過計算加密后的密碼后,服務器將返回
RECV
<success xmlns="urn:ietf:params:xml:ns:xmpp-sasl"/>
- 當客戶端收到以上命令后,將首次發起連接的id發送到服務器
SENT
<stream:stream
xmlns='jabber:client'
to='server domain'
xmlns:stream='http://etherx.jabber.org/streams'
version='1.0'
from='username@server domain'
id='c997c3a8'
xml:lang='en'>
- 這時服務器會返回如下內容說明此時的已經成功綁定了當前的Socket,
RECV
<?xml version='1.0' encoding='UTF-8'?>
<stream:stream
xmlns:stream="http://etherx.jabber.org/streams"
xmlns="jabber:client"
from="im"
id="c997c3a8"
xml:lang="en"
version="1.0">
<stream:features>
<compression
xmlns="http://jabber.org/features/compress">
<method>zlib</method>
</compression>
<bind
xmlns="urn:ietf:params:xml:ns:xmpp-bind"/>
<session
xmlns="urn:ietf:params:xml:ns:xmpp-session"/>
</stream:features>
- 客戶端在接收到如上的內容后會告訴服務器開啟壓縮
SENT
<compress xmlns='http://jabber.org/protocol/compress'><method>zlib</method></compress>
- 服務器返回
RECV
<compressed xmlns='http://jabber.org/protocol/compress'/>
- 客戶端收到服務器的響應命令后,重新建立一個Socket,發送指令
SENT
<stream:stream
xmlns='jabber:client'
to='server domain'
xmlns:stream='http://etherx.jabber.org/streams'
version='1.0'
from='username@server domain'
id='c997c3a8'
xml:lang='en'>
- 服務器將返回,不知道你有沒有發現,這里的
id="c997c3a8"
還是那個id
RECV
<?xml version='1.0' encoding='UTF-8'?>
<stream:stream
xmlns:stream="http://etherx.jabber.org/streams"
xmlns="jabber:client"
from="im"
id="c997c3a8"
xml:lang="en"
version="1.0">
<stream:features>
<mechanisms
xmlns="urn:ietf:params:xml:ns:xmpp-sasl">
<mechanism>PLAIN</mechanism>
<mechanism>ANONYMOUS</mechanism>
<mechanism>JIVE-SHAREDSECRET</mechanism>
</mechanisms>
<bind
xmlns="urn:ietf:params:xml:ns:xmpp-bind"/>
<session
xmlns="urn:ietf:params:xml:ns:xmpp-session"/>
</stream:features>
*實際上到這里客戶端的登錄已經完成了,但是還沒算成功,接下來可以開始做綁定Socket的操作了
SENT
<iq
id='b86j8-4'
type='set'>
<bind xmlns='urn:ietf:params:xml:ns:xmpp-bind'>
</bind>
</iq>
*服務器返回綁定了JID = c997c3a8
的客戶端
RECV
<iq
type="result"
id="b86j8-4"
to="im/c997c3a8">
<bind
xmlns="urn:ietf:params:xml:ns:xmpp-bind">
<jid>c997c3a8@im/c997c3a8</jid>
</bind>
</iq>
- 客戶端繼續請求,開啟一個session
SENT
<iq id='b86j8-6' type='set'><session xmlns='urn:ietf:params:xml:ns:xmpp-session'/></iq>
- 這時服務器返回
RECV
<iq
type="result"
id="b86j8-6"
to="c997c3a8@im/c997c3a8"/>
- 到此,整個登錄流程已經成功了,接下來可以做一些用戶信息的獲取等操作。
結尾
本篇帶領大家了解如何利用smack登錄Openfire和XMPP的報文流程,下一個章節將會帶大家進入xmpp的里面,看看獲取用戶信息等具體的操作。
引用
https://download.igniterealtime.org/smack/docs/latest/documentation/gettingstarted.html/