Skip to content

Commit 4127ccc

Browse files
* Bumped artifact version
* Edited README
1 parent aafa02c commit 4127ccc

File tree

7 files changed

+19
-18
lines changed

7 files changed

+19
-18
lines changed

Phosphor/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<parent>
99
<groupId>edu.gmu.swe.phosphor</groupId>
1010
<artifactId>phosphor-parent</artifactId>
11-
<version>0.1.0-SNAPSHOT</version>
11+
<version>0.1.0</version>
1212
</parent>
1313
<dependencies>
1414
<dependency>

README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,12 @@ The first time you run this command, Maven will invoke the Phosphor Maven plugin
6767
Phosphor-instrumented Java installations.
6868
These instrumented Java installation are cached for future use and will not be recreated unless one of the
6969
Phosphor JARs, the configuration used to create them, or the value of `JAVA_HOME` changes.
70-
Once the Phosphor Maven plugin finishes creating the instrumented Java installations the tests will run.
70+
Once the Phosphor Maven plugin finishes creating the instrumented Java installations, the tests will run.
7171
These tests demonstrate how Phosphor can be used and are a good reference when first learning Phosphor.
7272

7373
## Creating an Instrumented Java Installation
7474

75-
In order to track the flow of information through classes in the Java Class Library (JCL), such as `java.lang.String`
75+
To track the flow of information through classes in the Java Class Library (JCL), such as `java.lang.String`
7676
and `java.util.List`, Phosphor must instrument the bytecode of JCL classes.
7777
Therefore, the first step when using Phosphor is to create an instrumented Java installation
7878
(i.e., Java Development Kit or Java Runtime Environment).
@@ -83,19 +83,19 @@ Once you have obtained a Java installation, it can be instrumented either using
8383
We discuss both options below.
8484

8585
**Important note on OpenJDK vs Oracle's Java installations:**
86-
Oracle's Java installations requires that the JAR that contains the cryptography routines `jce.jar` be signed by
86+
Oracle's Java installations require that the JAR that contains the cryptography routines `jce.jar` be signed by
8787
Oracle for export control purposes.
8888
OpenJDK does not.
8989
Phosphor instrumentation will break these signatures.
9090
Therefore, it is not possible to use Phosphor with Oracle's Java installation *and* use the cryptography functionality.
9191

9292
### Driver
9393

94-
The Phosphor driver can be used apply Phosphor instrumentation to Java classes in a Java installation,
94+
The Phosphor driver can be used to apply Phosphor instrumentation to Java classes in a Java installation,
9595
directory, or archive.
9696
If you have built Phosphor according to the directions described above in the
9797
section ["Building Phosphor"](#Building-Phosphor), then the driver JAR will be available at
98-
`phosphor-driver/target/phosphor-driver-0.1.0-SNAPSHOT.jar` relative to the root of this project.
98+
`phosphor-driver/target/phosphor-driver-VERSION.jar` relative to the root of this project.
9999
The latest snapshot of the driver JAR is available at the
100100
[Sonatype OSS Repository Hosting (OSSRH)](https://oss.sonatype.org/content/repositories/snapshots/edu/gmu/swe/phosphor/).
101101
The driver JAR can also be acquired using the Maven dependency:
@@ -174,7 +174,7 @@ application with Phosphor.
174174
Locate the JAR for Phosphor's Java agent.
175175
If you have built Phosphor according to the directions described above in the
176176
section ["Building Phosphor"](#Building-Phosphor), then the agent JAR will be available at
177-
`Phosphor/target/Phosphor-0.1.0-SNAPSHOT.jar` relative to the root of this project.
177+
`Phosphor/target/Phosphor-VERSION.jar` relative to the root of this project.
178178
The latest snapshot of the agent JAR is available at the
179179
[Sonatype OSS Repository Hosting (OSSRH)](https://oss.sonatype.org/content/repositories/snapshots/edu/gmu/swe/phosphor/).
180180
The agent JAR can also be acquired using the Maven dependency:
@@ -205,7 +205,7 @@ If running java using the `-jar` option run:
205205
[ options ] -jar file.jar [ argument ... ]
206206
```
207207

208-
Otherwise run:
208+
Otherwise, run:
209209

210210
```
211211
<INSTRUMENTED-JAVA-HOME>/bin/java \
@@ -221,9 +221,10 @@ Where:
221221

222222
## Interacting with Phosphor
223223

224-
Phosphor exposes a simple API to allow to marking data with tags, and to retrieve those tags. Key functionality is
225-
implemented in ``edu.columbia.cs.psl.phosphor.runtime.MultiTainter``. To get or set the taint tag of a primitive type,
226-
developers call the taintedX or getTaint(X) method (replacing X with each of the primitive types, e.g. taintedByte,
224+
Phosphor exposes a simple API to allow data to be labeled with tags, and to retrieve those tags.
225+
Key functionality is implemented in ``edu.columbia.cs.psl.phosphor.runtime.MultiTainter``.
226+
To get or set the taint tag of a primitive type,
227+
developers call the taintedX or getTaint(X) method (replacing X with each of the primitive types, e.g., taintedByte,
227228
etc.).
228229
Ignore the methods ending with the suffix $$PHOSPHOR, they are used internally.
229230
To get or set the taint tag of an object, first cast that object to the interface TaintedWithObjTag (Phosphor changes
@@ -232,7 +233,7 @@ all classes to implement this interface), and use the get and set methods.
232233
You can determine if a variable is derived from a particular tainted source by examining the labels on that
233234
variable's `Taint` object.
234235

235-
You *can* detaint variables with Phosphor - to do so, simply use the `MultiTainter` interface to set the taint on a
236+
You *can* detaint variables with Phosphor - to do so, use the `MultiTainter` interface to set the taint on a
236237
value to `0` (or `null`).
237238

238239
## Notes on control tracking
@@ -248,7 +249,7 @@ functionality. If you are interested in helping, please contact us.
248249
## Contact
249250

250251
Please email [Jonathan Bell](mailto:bellj@gmu.edu) with comments, suggestions, or questions.
251-
This project is still under development and we welcome any feedback.
252+
This project is still under development, and we welcome any feedback.
252253

253254
## License
254255

integration-tests/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>edu.gmu.swe.phosphor</groupId>
99
<artifactId>phosphor-parent</artifactId>
10-
<version>0.1.0-SNAPSHOT</version>
10+
<version>0.1.0</version>
1111
</parent>
1212
<properties>
1313
<test.resources.dir>${project.build.testSourceDirectory}/../resources</test.resources.dir>

phosphor-driver/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<parent>
99
<groupId>edu.gmu.swe.phosphor</groupId>
1010
<artifactId>phosphor-parent</artifactId>
11-
<version>0.1.0-SNAPSHOT</version>
11+
<version>0.1.0</version>
1212
</parent>
1313
<dependencies>
1414
<dependency>

phosphor-instrument-maven-plugin/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>edu.gmu.swe.phosphor</groupId>
99
<artifactId>phosphor-parent</artifactId>
10-
<version>0.1.0-SNAPSHOT</version>
10+
<version>0.1.0</version>
1111
</parent>
1212
<dependencies>
1313
<dependency>

phosphor-microbench/pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<parent>
66
<groupId>edu.gmu.swe.phosphor</groupId>
77
<artifactId>phosphor-parent</artifactId>
8-
<version>0.1.0-SNAPSHOT</version>
8+
<version>0.1.0</version>
99
</parent>
1010
<properties>
1111
<jmh.version>1.21</jmh.version>

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<modelVersion>4.0.0</modelVersion>
44
<groupId>edu.gmu.swe.phosphor</groupId>
55
<artifactId>phosphor-parent</artifactId>
6-
<version>0.1.0-SNAPSHOT</version>
6+
<version>0.1.0</version>
77
<packaging>pom</packaging>
88
<licenses>
99
<license>

0 commit comments

Comments
 (0)