Skip to content

Commit

Permalink
Update EncryptedProperties self tests to avoid expected failures (GH E…
Browse files Browse the repository at this point in the history 
…SAPI#721)

Several of ReferenceEncryptedProperties's methods were deprecated and now throw an UnsupportedOperation exception. This commit tests whether the methods are available before running the tests. Also see KWW's comments in GH ESAPI#721.
  • Loading branch information
@noloader
noloader committed Jul 19, 2022
1 parent d6251b5 commit d7bfa79
Show file tree
Hide file tree
Showing 2 changed files with 154 additions and 104 deletions.
20 changes: 19 additions & 1 deletion src/test/java/org/owasp/esapi/reference/crypto/EncryptedPropertiesUtilsTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ private final File getTempPropertiesFile() throws IOException {
* @throws Exception Any exception that occurs
*/
@Test public void testCreateNew() throws Exception {

// https://github.com/ESAPI/esapi-java-legacy/issues/721
System.out.println("testCreateNew removed due to deprecation of EncryptedPropertiesUtils.storeProperties()");

/*
File encryptedFile = getTempPropertiesFile();
//create a new properties with no input
Expand All @@ -98,6 +103,7 @@ private final File getTempPropertiesFile() throws IOException {
assertEquals(VALUE1, loadedProps.getProperty(KEY1));
assertEquals(VALUE2, loadedProps.getProperty(KEY2));
*/
}

/**
Expand All @@ -110,10 +116,15 @@ private final File getTempPropertiesFile() throws IOException {
* @throws Exception Any exception that occurs
*/
@Test public void testLoadPlaintextAndEncrypt() throws Exception {

// https://github.com/ESAPI/esapi-java-legacy/issues/721
System.out.println("testLoadPlaintextAndEncrypt removed due to deprecation of EncryptedPropertiesUtils.storeProperties()");

/*
File encryptedFile = getTempPropertiesFile();
File plainTextFile = getTempPropertiesFile();
//write an initial plaintext properties file
//write an initial plaintext properties file
Properties props = new Properties();
props.setProperty(KEY3, VALUE3);
props.setProperty(KEY4, VALUE4);
Expand All @@ -136,6 +147,7 @@ private final File getTempPropertiesFile() throws IOException {
assertEquals(VALUE3, loadedProps.getProperty(KEY3));
assertEquals(VALUE4, loadedProps.getProperty(KEY4));
*/
}

/**
Expand All @@ -148,6 +160,11 @@ private final File getTempPropertiesFile() throws IOException {
* @throws Exception Any exception that occurs
*/
@Test public void testLoadEncryptedAndAdd() throws Exception {

// https://github.com/ESAPI/esapi-java-legacy/issues/721
System.out.println("testLoadEncryptedAndAdd removed due to deprecation of EncryptedPropertiesUtils.storeProperties()");

/*
File encryptedFile = getTempPropertiesFile();
File encryptedFile2 = getTempPropertiesFile();
//load the plaintext properties file
Expand All @@ -171,6 +188,7 @@ private final File getTempPropertiesFile() throws IOException {
//test the values read in
assertEquals(VALUE1, loadedProps.getProperty(KEY1));
assertEquals(VALUE2, loadedProps.getProperty(KEY2));
*/
}

}
238 changes: 135 additions & 103 deletions src/test/java/org/owasp/esapi/reference/crypto/ReferenceEncryptedPropertiesTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,124 +146,134 @@ else if(key.equals("two"))
*/
@Test public void testStoreLoad() throws Exception
{
ReferenceEncryptedProperties toLoad = new ReferenceEncryptedProperties();
ByteArrayOutputStream baos = new ByteArrayOutputStream();
ByteArrayInputStream bais;
boolean sawOne = false;
boolean sawTwo = false;
boolean sawSeuss = false;

ReferenceEncryptedProperties toStore = new ReferenceEncryptedProperties();
toStore.setProperty("one", "two");
toStore.setProperty("two", "three");
toStore.setProperty("seuss.schneier", "one fish, twofish, red fish, blowfish");
toStore.store(baos, "testStore");

bais = new ByteArrayInputStream(baos.toByteArray());
toLoad.load(bais);

for(Iterator i=toLoad.keySet().iterator();i.hasNext();)
{
String key = (String)i.next();

assertNotNull("key returned from keySet() iterator was null", key);
if(key.equals("one"))
if(sawOne)
fail("Key one seen more than once.");
else
{
sawOne = true;
assertEquals("Key one's value was not two", "two", toLoad.getProperty("one"));
}
else if(key.equals("two"))
if(sawTwo)
fail("Key two seen more than once.");
else
{
sawTwo = true;
assertEquals("Key two's value was not three", "three", toLoad.getProperty("two"));
}
else if(key.equals("seuss.schneier"))
if(sawSeuss)
fail("Key seuss.schneier seen more than once.");
if ( hasSettersAndStores() == false ) {
// https://github.com/ESAPI/esapi-java-legacy/issues/721
System.out.println("testStoreLoad removed due to deprecation of ReferenceEncryptedProperties.store()");
}
else {
ReferenceEncryptedProperties toLoad = new ReferenceEncryptedProperties();
ByteArrayOutputStream baos = new ByteArrayOutputStream();
ByteArrayInputStream bais;
boolean sawOne = false;
boolean sawTwo = false;
boolean sawSeuss = false;

ReferenceEncryptedProperties toStore = new ReferenceEncryptedProperties();
toStore.setProperty("one", "two");
toStore.setProperty("two", "three");
toStore.setProperty("seuss.schneier", "one fish, twofish, red fish, blowfish");
toStore.store(baos, "testStore");

bais = new ByteArrayInputStream(baos.toByteArray());
toLoad.load(bais);

for(Iterator i=toLoad.keySet().iterator();i.hasNext();)
{
String key = (String)i.next();

assertNotNull("key returned from keySet() iterator was null", key);
if(key.equals("one"))
if(sawOne)
fail("Key one seen more than once.");
else
{
sawSeuss = true;
assertEquals("Key seuss.schneier's value was not expected value",
"one fish, twofish, red fish, blowfish",
toStore.getProperty("seuss.schneier"));
sawOne = true;
assertEquals("Key one's value was not two", "two", toLoad.getProperty("one"));
}
else
fail("Unset key " + key + " returned from keySet().iterator()");
else if(key.equals("two"))
if(sawTwo)
fail("Key two seen more than once.");
else
{
sawTwo = true;
assertEquals("Key two's value was not three", "three", toLoad.getProperty("two"));
}
else if(key.equals("seuss.schneier"))
if(sawSeuss)
fail("Key seuss.schneier seen more than once.");
else
{
sawSeuss = true;
assertEquals("Key seuss.schneier's value was not expected value",
"one fish, twofish, red fish, blowfish",
toStore.getProperty("seuss.schneier"));
}
else
fail("Unset key " + key + " returned from keySet().iterator()");
}
assertTrue("Key one was never seen", sawOne);
assertTrue("Key two was never seen", sawTwo);
}
assertTrue("Key one was never seen", sawOne);
assertTrue("Key two was never seen", sawTwo);
}

/**
* Test storing and loading of encrypted properties.
*/
@Test public void testStoreLoadWithReader() throws Exception
{
/*
//create an EncryptedProperties to store
ReferenceEncryptedProperties toStore = new ReferenceEncryptedProperties();
toStore.setProperty("one", "two");
toStore.setProperty("two", "three");
toStore.setProperty("seuss.schneier", "one fish, twofish, red fish, blowfish");
//store properties to a Writer
CharArrayWriter writer = new CharArrayWriter();
//toStore.store(writer, "testStore");
//read it back in from a Reader
Reader reader = new CharArrayReader(writer.toCharArray());
ReferenceEncryptedProperties toLoad = new ReferenceEncryptedProperties();
toLoad.load(reader);
//test the resulting loaded properties
boolean sawOne = false;
boolean sawTwo = false;
boolean sawSeuss = false;
for(Iterator i=toLoad.keySet().iterator();i.hasNext();)
{
String key = (String)i.next();
assertNotNull("key returned from keySet() iterator was null", key);
if(key.equals("one"))
if(sawOne)
fail("Key one seen more than once.");
else
{
sawOne = true;
assertEquals("Key one's value was not two", "two", toLoad.getProperty("one"));
}
else if(key.equals("two"))
if(sawTwo)
fail("Key two seen more than once.");
else
{
sawTwo = true;
assertEquals("Key two's value was not three", "three", toLoad.getProperty("two"));
}
else if(key.equals("seuss.schneier"))
if(sawSeuss)
fail("Key seuss.schneier seen more than once.");
if ( hasSettersAndStores() == false ) {
// https://github.com/ESAPI/esapi-java-legacy/issues/721
System.out.println("testStoreLoadWithReader removed due to deprecation of ReferenceEncryptedProperties.store()");
}
else {
//create an EncryptedProperties to store
ReferenceEncryptedProperties toStore = new ReferenceEncryptedProperties();
toStore.setProperty("one", "two");
toStore.setProperty("two", "three");
toStore.setProperty("seuss.schneier", "one fish, twofish, red fish, blowfish");

//store properties to a Writer
CharArrayWriter writer = new CharArrayWriter();
//toStore.store(writer, "testStore");

//read it back in from a Reader
Reader reader = new CharArrayReader(writer.toCharArray());

ReferenceEncryptedProperties toLoad = new ReferenceEncryptedProperties();
toLoad.load(reader);

//test the resulting loaded properties
boolean sawOne = false;
boolean sawTwo = false;
boolean sawSeuss = false;

for(Iterator i=toLoad.keySet().iterator();i.hasNext();)
{
String key = (String)i.next();

assertNotNull("key returned from keySet() iterator was null", key);
if(key.equals("one"))
if(sawOne)
fail("Key one seen more than once.");
else
{
sawSeuss = true;
assertEquals("Key seuss.schneier's value was not expected value",
"one fish, twofish, red fish, blowfish",
toStore.getProperty("seuss.schneier"));
sawOne = true;
assertEquals("Key one's value was not two", "two", toLoad.getProperty("one"));
}
else
fail("Unset key " + key + " returned from keySet().iterator()");
else if(key.equals("two"))
if(sawTwo)
fail("Key two seen more than once.");
else
{
sawTwo = true;
assertEquals("Key two's value was not three", "three", toLoad.getProperty("two"));
}
else if(key.equals("seuss.schneier"))
if(sawSeuss)
fail("Key seuss.schneier seen more than once.");
else
{
sawSeuss = true;
assertEquals("Key seuss.schneier's value was not expected value",
"one fish, twofish, red fish, blowfish",
toStore.getProperty("seuss.schneier"));
}
else
fail("Unset key " + key + " returned from keySet().iterator()");
}
assertTrue("Key one was never seen", sawOne);
assertTrue("Key two was never seen", sawTwo);
}
assertTrue("Key one was never seen", sawOne);
assertTrue("Key two was never seen", sawTwo);
*/
}

/**
Expand Down Expand Up @@ -496,4 +506,26 @@ else if(key.equals("seuss.schneier"))
}
}

/**
* Test whether ReferenceEncryptedProperties has setters and stores available.
*
* It appears we need to catch for both exceptions. I think setProperty() relies on store().
* Also see https://github.com/ESAPI/esapi-java-legacy/issues/721.
*/
protected boolean hasSettersAndStores() {
try {
ReferenceEncryptedProperties props = new ReferenceEncryptedProperties();
props.setProperty("x", "y");
props.store(new ByteArrayOutputStream(new byte[]{'A','B','C'}), "XYZ");
}
catch (UnsupportedOperationException ex) {
return false;
}
catch (IOException ex) {
return false;
}

return true;
}

}

0 comments on commit d7bfa79

Please sign in to comment.