-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1,607 changed files
with
322,086 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <classpath> | ||
| <classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/4"/> | ||
| <classpathentry including="**/*.java" kind="src" output="target/classes" path="src"> | ||
| <attributes> | ||
| <attribute name="optional" value="true"/> | ||
| <attribute name="maven.pomderived" value="true"/> | ||
| </attributes> | ||
| </classpathentry> | ||
| <classpathentry excluding="**" kind="src" output="target/classes" path="resources"> | ||
| <attributes> | ||
| <attribute name="maven.pomderived" value="true"/> | ||
| </attributes> | ||
| </classpathentry> | ||
| <classpathentry kind="lib" path="lib/junit/org.hamcrest.core_1.3.0.v201303031735.jar"/> | ||
| <classpathentry kind="lib" path="lib/junit/concurrent-junit-1.0.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/swagger-annotations-1.5.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/swagger-core-1.5.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/swagger-jaxrs-1.5.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/swagger-jersey2-jaxrs-1.5.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/swagger-models-1.5.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/aopalliance-repackaged-2.5.0-b32.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/cdi-api-1.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/commons-lang3-3.2.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/el-api-2.2.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/guava-15.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/hk2-api-2.5.0-b32.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/hk2-locator-2.5.0-b32.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/hk2-utils-2.5.0-b32.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jackson-annotations-2.4.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jackson-core-2.4.2.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jackson-databind-2.4.2.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/javassist-3.20.0-GA.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/javax.annotation-api-1.2.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/javax.inject-1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/javax.inject-2.5.0-b32.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/javax.json-1.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/javax.json-api-1.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/javax.json.bind-api-1.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/javax.servlet-api-3.0.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/javax.ws.rs-api-2.0.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jaxb-api-2.2.12-b140109.1041.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jboss-interceptors-api_1.1_spec-1.0.0.Beta1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-client-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-common-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-container-servlet-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-container-servlet-core-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-core-1.19.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-entity-filtering-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-guava-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-hk2.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-media-jaxb-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-media-json-binding.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-media-moxy-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-media-multipart-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-media-sse-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jersey-server-2.25.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/jsr250-api-1.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/org.eclipse.persistence.moxy-2.6.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/org.osgi.core-4.2.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/osgi-resource-locator-1.0.1.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/persistence-api-1.0.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/reflections-0.9.9.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/validation-api-1.1.0.Final.jar"/> | ||
| <classpathentry kind="lib" path="WebContent/WEB-INF/lib/yasson-1.0.jar"/> | ||
| <classpathentry kind="lib" path="lib/neo4j/neo4j-3.3.4.jar"/> | ||
| <classpathentry kind="lib" path="lib/neo4j/neo4j-graphdb-api-3.3.4.jar"/> | ||
| <classpathentry kind="lib" path="lib/neo4j/neo4j-java-driver-1.5.1.jar"/> | ||
| <classpathentry kind="lib" path="lib/neo4j/neo4j-kernel-3.3.4.jar"/> | ||
| <classpathentry kind="lib" path="lib/neo4j/neo4j-kernel-api-3.3.4.jar"/> | ||
| <classpathentry kind="lib" path="lib/lib4j/log4j-api-2.9.1.jar"/> | ||
| <classpathentry kind="lib" path="lib/lib4j/log4j-core-2.9.1.jar"/> | ||
| <classpathentry kind="lib" path="lib/lib4j/logback-classic-1.2.3-sources.jar"/> | ||
| <classpathentry kind="lib" path="lib/lib4j/logback-core-1.2.3-sources.jar"/> | ||
| <classpathentry kind="lib" path="lib/lib4j/logback-core-1.2.3.jar"/> | ||
| <classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER"> | ||
| <attributes> | ||
| <attribute name="maven.pomderived" value="true"/> | ||
| </attributes> | ||
| </classpathentry> | ||
| <classpathentry including="**/*.java" kind="src" output="target/classes" path="gen-src"> | ||
| <attributes> | ||
| <attribute name="optional" value="true"/> | ||
| <attribute name="maven.pomderived" value="true"/> | ||
| </attributes> | ||
| </classpathentry> | ||
| <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"> | ||
| <attributes> | ||
| <attribute name="module" value="true"/> | ||
| <attribute name="maven.pomderived" value="true"/> | ||
| </attributes> | ||
| </classpathentry> | ||
| <classpathentry kind="output" path="target/classes"/> | ||
| </classpath> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <projectDescription> | ||
| <name>firewall-analysis</name> | ||
| <comment></comment> | ||
| <projects> | ||
| </projects> | ||
| <buildSpec> | ||
| <buildCommand> | ||
| <name>org.eclipse.jdt.core.javabuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| <buildCommand> | ||
| <name>org.eclipse.wst.common.project.facet.core.builder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| <buildCommand> | ||
| <name>org.eclipse.wst.validation.validationbuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| <buildCommand> | ||
| <name>org.springframework.ide.eclipse.boot.validation.springbootbuilder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| <buildCommand> | ||
| <name>org.eclipse.m2e.core.maven2Builder</name> | ||
| <arguments> | ||
| </arguments> | ||
| </buildCommand> | ||
| </buildSpec> | ||
| <natures> | ||
| <nature>org.eclipse.m2e.core.maven2Nature</nature> | ||
| <nature>org.eclipse.jem.workbench.JavaEMFNature</nature> | ||
| <nature>org.eclipse.wst.common.modulecore.ModuleCoreNature</nature> | ||
| <nature>org.eclipse.jdt.core.javanature</nature> | ||
| <nature>org.eclipse.wst.common.project.facet.core.nature</nature> | ||
| <nature>org.eclipse.wst.jsdt.core.jsNature</nature> | ||
| </natures> | ||
| </projectDescription> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <classpath> | ||
| <classpathentry excluding="**/bower_components/*|**/node_modules/*|**/*.min.js" kind="src" path="WebContent"/> | ||
| <classpathentry kind="con" path="org.eclipse.wst.jsdt.launching.JRE_CONTAINER"/> | ||
| <classpathentry kind="con" path="org.eclipse.wst.jsdt.launching.WebProject"> | ||
| <attributes> | ||
| <attribute name="hide" value="true"/> | ||
| </attributes> | ||
| </classpathentry> | ||
| <classpathentry kind="con" path="org.eclipse.wst.jsdt.launching.baseBrowserLibrary"/> | ||
| <classpathentry kind="output" path=""/> | ||
| </classpath> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| eclipse.preferences.version=1 | ||
| org.eclipse.ltk.core.refactoring.enable.project.refactoring.history=false |
7 changes: 7 additions & 0 deletions
7
.settings/org.eclipse.wst.common.project.facet.core.prefs.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <root> | ||
| <facet id="jst.jaxrs"> | ||
| <node name="libprov"> | ||
| <attribute name="provider-id" value="jaxrs-no-op-library-provider"/> | ||
| </node> | ||
| </facet> | ||
| </root> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| org.eclipse.wst.jsdt.launching.baseBrowserLibrary |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Window |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| CASI DA CHIEDERE | ||
| - singoli web client con ip 10.0.0.1, 10.0.0.2 ecc e requisito con 10.0.0.-1. E' possibile? | ||
| - chiedere cosa succede per i predicati che, passato un NAT, non vengono trasformati | ||
|
|
||
| Ottimizzazioni da fare: | ||
| - cancellare atomic predicates con all negs | ||
| - caso in cui ci sono le porte ma nessun trasformer che lavora sulle porte (da discutere a voce con daniele) | ||
| - inserimento in lista già ordinato -> non serve fare la sort ogni volta che si chiama la compare e ai thread posso passare lo stesso elenco di predicates | ||
| (in quanto non andranno a modificarlo) | ||
|
|
||
| Da commentare (parti di Budapest che non servono più) | ||
| - VerefooNormalizer (non dovrebbe più essere necessario perchè ora il framework lavora con le wildcards) | ||
|
|
||
| TEST CASES | ||
| -APtest03 : firewall con regole complesse | ||
| -APtest031: firewall con singola regola in deny | ||
| -APtest032: firewall con wildcards | ||
| -APtest05 : esempio cartaceo con NAT | ||
| -APtest051: cartaceo con anche prototype nel requisito | ||
| -APtest052: cartaceo con porte singole nel requisito | ||
| -APtest07 : NAT e wildcards | ||
| -APtest09 : 2 clients e 2 server e tanti requisiti | ||
| -NAT01 : firewall e NAT | ||
| -NAT02 : 2 NAT in cascata | ||
| -NAT03 : 2 NAT, ognuno in uscita da una rete privata differente | ||
| -NAT04 : esempio sopra più un terzo NAT | ||
| -NAT05: natting from both directions | ||
| -NAT06: percorso circolare I | ||
| -NAT07: percorso circolare II | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,92 +1,56 @@ | ||
| # Firewall Analysis | ||
|  | ||
|
|
||
|
|
||
| ##### VEREFOO (VErified REFinement and Optimized Orchestrator) is a framework designed to provide an automatic way to allocate packet filters – the most common and traditional firewall technology – in a Service Graph defined by the service designer and an auto-configuration technique to create firewall rules with respect to the specified security requirements. | ||
|
|
||
| ## Getting started | ||
| ## Z3 library support | ||
| [Download](https://github.com/Z3Prover/z3/releases) the correct version of Z3 according to your OS and your JVM endianness. For the correct functioning of the application, you must have the Z3 native library and include it to Java Library Path. The most convenient way to do this is add the path that the library to the dynamic linking library path. | ||
|
|
||
| To make it easy for you to get started with GitLab, here's a list of recommended next steps. | ||
| * In Linux is `LD_LIBRARY_PATH` | ||
| * In MacOS is `DYLD_LIBRARY_PATH` | ||
| * In Windows is `PATH` | ||
|
|
||
| Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! | ||
| > e.g., | ||
| > * `sudo nano /etc/environment` | ||
| > * `LD_LIBRARY_PATH = $LD_LIBRARY_PATH:/home/verefoo/z3/bin/` | ||
| > * `Z3 = /home/verefoo/z3/bin/` (also required) | ||
| ## Add your files | ||
|
|
||
| - [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files | ||
| - [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: | ||
|
|
||
| ``` | ||
| cd existing_repo | ||
| git remote add origin https://gitlab1.polito.it/netgroup/software/firewall-analysis.git | ||
| git branch -M main | ||
| git push -uf origin main | ||
| ``` | ||
| ## Installing Verefoo via Maven (Spring Boot application with Embedded Tomcat) [Solution 1] | ||
| * install [jdk1.8.X YY](http://www.oracle.comntechnetwork/java/javase/downloads/jdk8-downloads-2133151.html); | ||
| * install [maven](https://maven.apache.org/install.html) | ||
| * `mvn clean package` | ||
| * `java -jar target/verifoo-0.0.1-SNAPSHOT.jar` | ||
|
|
||
| ## Integrate with your tools | ||
| Swagger documentation can be accessed at [localhost:8085/verefoo](localhost:8085/verefoo). | ||
|
|
||
| - [ ] [Set up project integrations](https://gitlab1.polito.it/netgroup/software/firewall-analysis/-/settings/integrations) | ||
| ## Installing Verefoo via Ant (Apache Tomcat required) [Solution 2] | ||
| - install [jdk1.8.X YY](http://www.oracle.comntechnetwork/java/javase/downloads/jdk8-downloads-2133151.html); | ||
| - install [Apache Tomcat 8](https://tomcat.apache.org/download-80.cgi); | ||
| - set CATALINA HOME ambient variable to the directory where you installed Apache; | ||
| - (optional) configure Tomcat Manager: | ||
| - open the file ``%CATALINA_HOME%\conf\tomcat-users.xml`` | ||
| - under the ``tomcat-users`` tag place, initialize an user with roles "tomcat, manager-gui, manager-script". An example is the following content: | ||
| ``xml <role rolename="manager-gui"/> <role rolename="manager-script"/> <role rolename="admin-gui"/> <role rolename="admin-script"/> <user username="admin" password="admin" roles="manager-gui,manager-script,admin-scripts"/>`` | ||
| - edit the "to\_be\_defined" fields in tomcat-build.xml with the before | ||
| defined credentials; | ||
| - execute the `generate` ant task in order to generate the .war; | ||
| - launch Tomcat 8 with the startup script ``%CATALINA_HOME%\bin\startup.bat`` or by the start-tomcat task ant; | ||
| - (optional) if you previously configured Tomcat Manager you can open a browser and navigate to `this link <http://localhost:8080/manager>` and login using the proper username and password (e.g., ``admin/admin`` in the previous example); | ||
| - (optional) you can `deploy/undeploy/redeploy` the downloaded WARs through the web interface. | ||
|
|
||
| ## Collaborate with your team | ||
|
|
||
| - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) | ||
| - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) | ||
| - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) | ||
| - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) | ||
| - [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) | ||
|
|
||
| ## Test and Deploy | ||
|
|
||
| Use the built-in continuous integration in GitLab. | ||
| ## Resources: | ||
|
|
||
| - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) | ||
| - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) | ||
| - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) | ||
| - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) | ||
| - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) | ||
| * [VerifooDocs.pdf](https://github.com/netgroup-polito/verifoo/blob/master/docs/VerifooDocs.pdf) for documentation. | ||
|
|
||
| *** | ||
|
|
||
| # Editing this README | ||
| ## TODO | ||
| mvn clean compile assembly:single | ||
|
|
||
| When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. | ||
| java -jar target\verifoo-0.0.1-SNAPSHOT-jar-with-dependencies.jar 25154 60 10 100 | ||
|
|
||
| ## Suggestions for a good README | ||
| Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. | ||
|
|
||
| ## Name | ||
| Choose a self-explaining name for your project. | ||
|
|
||
| ## Description | ||
| Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. | ||
|
|
||
| ## Badges | ||
| On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. | ||
|
|
||
| ## Visuals | ||
| Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. | ||
|
|
||
| ## Installation | ||
| Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. | ||
|
|
||
| ## Usage | ||
| Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. | ||
|
|
||
| ## Support | ||
| Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. | ||
|
|
||
| ## Roadmap | ||
| If you have ideas for releases in the future, it is a good idea to list them in the README. | ||
|
|
||
| ## Contributing | ||
| State if you are open to contributions and what your requirements are for accepting them. | ||
|
|
||
| For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. | ||
|
|
||
| You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. | ||
|
|
||
| ## Authors and acknowledgment | ||
| Show your appreciation to those who have contributed to the project. | ||
|
|
||
| ## License | ||
| For open source projects, say how it is licensed. | ||
|
|
||
| ## Project status | ||
| If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. | ||
| mvn clean package && java -jar target\verifoo-0.0.1-SNAPSHOT.jar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Manifest-Version: 1.0 | ||
| Class-Path: | ||
|
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+5.49 KB
WebContent/WEB-INF/lib/jboss-interceptors-api_1.1_spec-1.0.0.Beta1.jar
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Oops, something went wrong.