1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-11 05:21:08 +01:00

Add support for XEP-0420: Stanza Content Encryption

This commit is contained in:
Paul Schaub 2020-07-23 11:02:28 +02:00
parent 00acdfcb9e
commit 78f37a909e
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
19 changed files with 1220 additions and 0 deletions

View file

@ -0,0 +1,156 @@
/**
*
* Copyright 2020 Paul Schaub
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.smackx.stanza_content_encryption.element;
import static org.jivesoftware.smack.test.util.XmlAssertUtil.assertXmlSimilar;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.text.ParseException;
import java.util.Date;
import org.junit.jupiter.api.Test;
import org.jxmpp.jid.EntityBareJid;
import org.jxmpp.jid.impl.JidCreate;
import org.jxmpp.util.XmppDateTime;
public class AffixElementsTest {
public static final EntityBareJid JID_HOUSTON = JidCreate.entityBareFromOrThrowUnchecked("missioncontrol@houston.nasa.gov");
public static final EntityBareJid JID_OPPORTUNITY = JidCreate.entityBareFromOrThrowUnchecked("opportunity@mars.planet");
/**
* Test serialization of 'to' affix element.
*
* @see <a href="https://xmpp.org/extensions/xep-0420.html#example-1">XEP-420 Example 1</a>
*/
@Test
public void testToAffixElement() {
ToAffixElement to = new ToAffixElement(JID_HOUSTON);
String expectedXml = "<to jid='missioncontrol@houston.nasa.gov'/>";
assertXmlSimilar(expectedXml, to.toXML());
assertEquals(JID_HOUSTON, to.getJid());
}
@Test
public void testToAffixElementEquals() {
ToAffixElement to1 = new ToAffixElement(JID_HOUSTON);
ToAffixElement to2 = new ToAffixElement(JID_HOUSTON);
assertEquals(to1, to2);
assertEquals(to1, to1);
assertEquals(to1.hashCode(), to2.hashCode());
assertFalse(to1.equals(null));
}
@Test
public void toElementNullArgThrows() {
assertThrows(IllegalArgumentException.class, () -> new ToAffixElement(null));
}
/**
* Test serialization of 'from' affix element.
*
* @see <a href="https://xmpp.org/extensions/xep-0420.html#example-1">XEP-420 Example 1</a>
*/
@Test
public void testFromAffixElement() {
FromAffixElement from = new FromAffixElement(JID_OPPORTUNITY);
String expectedXml = "<from jid='opportunity@mars.planet'/>";
assertXmlSimilar(expectedXml, from.toXML());
assertEquals(JID_OPPORTUNITY, from.getJid());
}
@Test
public void testFromAffixElementEquals() {
FromAffixElement from1 = new FromAffixElement(JID_HOUSTON);
FromAffixElement from2 = new FromAffixElement(JID_HOUSTON);
assertEquals(from1, from2);
assertEquals(from1, from1);
assertEquals(from1.hashCode(), from2.hashCode());
assertFalse(from1.equals(null));
}
@Test
public void fromElementNullArgThrows() {
assertThrows(IllegalArgumentException.class, () -> new FromAffixElement(null));
}
@Test
public void testTimestampAffixElement() throws ParseException {
Date date = XmppDateTime.parseDate("2004-01-25T05:05:00.000+00:00");
TimestampAffixElement timestamp = new TimestampAffixElement(date);
String expectedXml = "<time stamp='2004-01-25T05:05:00.000+00:00'/>";
assertXmlSimilar(expectedXml, timestamp.toXML());
assertEquals(date, timestamp.getTimestamp());
}
@Test
public void timestampElementNullArgThrows() {
assertThrows(IllegalArgumentException.class, () -> new TimestampAffixElement(null));
}
@Test
public void testTimestampElementEquals() throws ParseException {
TimestampAffixElement t1 = new TimestampAffixElement(XmppDateTime.parseDate("2004-01-25T05:05:00.000+00:00"));
TimestampAffixElement t2 = new TimestampAffixElement(t1.getTimestamp());
assertEquals(t1, t2);
assertEquals(t1, t1);
assertEquals(t1.hashCode(), t2.hashCode());
assertFalse(t1.equals(null));
}
@Test
public void testRandomPaddingElement() {
RandomPaddingAffixElement rpad = new RandomPaddingAffixElement();
assertNotNull(rpad.getPadding());
assertTrue(rpad.getPadding().length() < 200);
}
@Test
public void testRandomPaddingEquals() {
RandomPaddingAffixElement rpad1 = new RandomPaddingAffixElement();
RandomPaddingAffixElement rpad2 = new RandomPaddingAffixElement(rpad1.getPadding());
assertEquals(rpad1, rpad2);
assertEquals(rpad1, rpad1);
assertEquals(rpad1.hashCode(), rpad2.hashCode());
assertFalse(rpad1.equals(null));
}
@Test
public void testRandomPaddingSerialization() {
RandomPaddingAffixElement rpad = new RandomPaddingAffixElement();
String expectedXml = "<rpad>" + rpad.getPadding() + "</rpad>";
assertXmlSimilar(expectedXml, rpad.toXML());
}
@Test
public void rpadElementNullArgThrows() {
assertThrows(IllegalArgumentException.class, () -> new RandomPaddingAffixElement(null));
}
}

View file

@ -0,0 +1,81 @@
/**
*
* Copyright 2020 Paul Schaub
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.smackx.stanza_content_encryption.element;
import static org.jivesoftware.smack.test.util.XmlAssertUtil.assertXmlSimilar;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.text.ParseException;
import java.util.Collections;
import org.jivesoftware.smack.packet.Message;
import org.jivesoftware.smackx.hints.element.StoreHint;
import org.jivesoftware.smackx.sid.element.StanzaIdElement;
import org.junit.jupiter.api.Test;
import org.jxmpp.util.XmppDateTime;
public class ContentElementTest {
@Test
public void testContentElement() throws ParseException {
Message.Body body = new Message.Body("en", "My battery is low and its getting dark"); // :'(
ContentElement contentElement = ContentElement.builder()
.addPayloadItem(body)
.setFrom(AffixElementsTest.JID_OPPORTUNITY)
.addTo(AffixElementsTest.JID_HOUSTON)
.setTimestamp(XmppDateTime.parseXEP0082Date("2018-06-10T00:00:00.000+00:00"))
.setRandomPadding("RANDOMPADDING")
.build();
String expectedXml = "" +
"<content xmlns='urn:xmpp:sce:0'>" +
" <to jid='missioncontrol@houston.nasa.gov'/>" +
" <from jid='opportunity@mars.planet'/>" +
" <time stamp='2018-06-10T00:00:00.000+00:00'/>" +
" <rpad>RANDOMPADDING</rpad>" +
" <payload>" +
" <body xmlns='jabber:client' xml:lang='en'>My battery is low and its getting dark</body>" +
" </payload>" +
"</content>";
assertXmlSimilar(expectedXml, contentElement.toXML());
assertEquals(Collections.singletonList(body), contentElement.getPayload().getItems());
assertEquals(4, contentElement.getAffixElements().size());
assertTrue(contentElement.getAffixElements().contains(new ToAffixElement(AffixElementsTest.JID_HOUSTON)));
assertTrue(contentElement.getAffixElements().contains(new FromAffixElement(AffixElementsTest.JID_OPPORTUNITY)));
assertTrue(contentElement.getAffixElements().contains(
new TimestampAffixElement(XmppDateTime.parseXEP0082Date("2018-06-10T00:00:00.000+00:00"))));
assertTrue(contentElement.getAffixElements().contains(new RandomPaddingAffixElement("RANDOMPADDING")));
}
@Test
public void stanzaIdForbiddenInContentElementPayload() {
assertThrows(IllegalArgumentException.class,
() -> ContentElement.builder().addPayloadItem(new StanzaIdElement("alice@wonderland.lit")));
}
@Test
public void processingHintsForbiddenInContentElementPayload() {
assertThrows(IllegalArgumentException.class,
() -> ContentElement.builder().addPayloadItem(StoreHint.INSTANCE));
}
}

View file

@ -0,0 +1,84 @@
/**
*
* Copyright 2020 Paul Schaub
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.smackx.stanza_content_encryption.provider;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.IOException;
import org.jivesoftware.smack.packet.Message;
import org.jivesoftware.smack.packet.StandardExtensionElement;
import org.jivesoftware.smack.parsing.SmackParsingException;
import org.jivesoftware.smack.test.util.TestUtils;
import org.jivesoftware.smack.util.ParserUtils;
import org.jivesoftware.smack.xml.XmlPullParserException;
import org.jivesoftware.smackx.stanza_content_encryption.element.ContentElement;
import org.jivesoftware.smackx.stanza_content_encryption.element.FromAffixElement;
import org.jivesoftware.smackx.stanza_content_encryption.element.RandomPaddingAffixElement;
import org.jivesoftware.smackx.stanza_content_encryption.element.TimestampAffixElement;
import org.jivesoftware.smackx.stanza_content_encryption.element.ToAffixElement;
import org.junit.jupiter.api.Test;
import org.jxmpp.jid.impl.JidCreate;
public class ContentElementProviderTest {
@Test
public void testParsing() throws XmlPullParserException, IOException, SmackParsingException {
String xml = "" +
"<content xmlns='urn:xmpp:sce:0'>\n" +
" <payload>\n" +
" <body xmlns='jabber:client'>Have you seen that new movie?</body>\n" +
" <x xmlns='jabber:x:oob'>\n" +
" <url>https://en.wikipedia.org/wiki/Fight_Club#Plot</url>\n" +
" </x>\n" +
" </payload>\n" +
" <from jid='ladymacbeth@shakespear.lit/castle'/>\n" +
" <to jid='doctor@shakespeare.lit/pda'/>\n" +
" <time stamp='1993-10-12T03:13:10.000+00:00'/>\n" +
" <rpad>A98D7KJF1ASDVG232sdff341</rpad>\n" +
"</content>";
ContentElementProvider provider = new ContentElementProvider();
ContentElement contentElement = provider.parse(TestUtils.getParser(xml));
assertNotNull(contentElement);
assertEquals(4, contentElement.getAffixElements().size());
assertTrue(contentElement.getAffixElements().contains(
new FromAffixElement(JidCreate.from("ladymacbeth@shakespear.lit/castle"))));
assertTrue(contentElement.getAffixElements().contains(
new ToAffixElement(JidCreate.from("doctor@shakespeare.lit/pda"))));
assertTrue(contentElement.getAffixElements().contains(
new TimestampAffixElement(ParserUtils.getDateFromXep82String("1993-10-12T03:13:10.000+00:00"))));
assertTrue(contentElement.getAffixElements().contains(
new RandomPaddingAffixElement("A98D7KJF1ASDVG232sdff341")));
assertEquals(2, contentElement.getPayload().getItems().size());
assertTrue(contentElement.getPayload().getItems().get(0) instanceof Message.Body);
Message.Body body = (Message.Body) contentElement.getPayload().getItems().get(0);
assertEquals("Have you seen that new movie?", body.getMessage());
StandardExtensionElement oob = (StandardExtensionElement) contentElement.getPayload().getItems().get(1);
assertEquals("x", oob.getElementName());
assertEquals("jabber:x:oob", oob.getNamespace());
assertEquals("https://en.wikipedia.org/wiki/Fight_Club#Plot", oob.getFirstElement("url").getText());
}
}