Onion-Router(Løk-Ruter)🧅

Last build:

Lenke til siste CI/CD Kjøring:

• Onion-Router
• Onion-RouterRestServer

Dette er et frivillig prosjekt tatt for å forbedre karakteren vår i emnet IDATT2104 - Nettverksprogrammering.

📜 Oppgaven:

"Implementer onion routing enten som programvare eller programvarebibliotek i et valgfritt programmeringsspråk"

💻 Vår løsning

• Utviklet i Java☕️.

• For kryptering brukes både RSA og AES. RSA for sending av nøkler, og AES for sending av lag-kryptert melding. Løsningen vår har en klient samt et nettverk av noder som er holdt styr på med en Rest server (https://github.com/MadLadsTechnology/Onion-RouterRestServer)

• Klienten kan sende inn en url som viser til en API og motta et svar i form av en string.

• JavaDoc for dette prosjektet:

  • Noder og klient
  • Server

Slik ser vår implementasjon ut(med bilder😎):

1️⃣ Noder sender til serveren at de er aktive. Dersom de blir avslått, blir de også fjernet fra serveren

2️⃣ Klienten gjør et kall til serveren og mottar en liste med alle aktive noder og generer en tilfeldig rute med et gitt antall noder.

3️⃣ Klienten sender så sin Public Key (RSA) til hver av nodene i ruten. Nodene bruker denne nøkkelen til å kryptere sin AES krypteringsnøkkel og sende den til klienten. Klienten har nå en symmetrisk nøkkel for hver node som kan brukes til kryptering og dekryptering.

4️⃣ Klienten krypterer nå adressen til API’en den vil gjøre et kall til med de symmetriske nøklene til nodene i ruten. Med hvert lag sender vi også med adressen til neste node i ruten. For hver node meldingen ankommer fjernes et lag med kryptering. Når vi ankommer siste node gjøres et api kall til den gitte adressen fra klienten.

5️⃣ For å sende svaret tilbake brukes samme rute. Hver av nodene legger nå på et lag kryptering med sin symmetriske nøkkel. Når svaret så ankommer klienten kan den dekryptere alle lagene og lese meldingen.

🧰 Implementert funksjonalitet:

• Sende og motta meldinger som blir kryptert i et nettverk av noder
• AES kryptere meldinger
• En restServer for å holde oversikt over aktive noder
  • Altså ingen meldinger blir sendt til inaktive noder
• RSA kryptering for henting av AES nøkler fra noder
• API-kall fra siste node
• Responsen blir kryptert lagvis på vei tilbake, og dekrypteres av klienten.
• Nettverket har ingen grense på antall aktive noder, jo flere jo sikrere.
• Ruten er tilfeldig generert fra et gitt antall noder fra poolen.
  • Ruten er aldri sendt ut fra klienten
  • Nodene kan kun lese neste punkt i ruten, og vet forrige punkt.

🔜 Svakheter og mulige utvidelser:

• Kun enkle API kall som returnerer en String
• Dårlig feilhåndtering
• Ingen brukergrensesnitt
• Ingen proxy funksjonalitet

☁️ Eksterne Avhengigheter

• Maven
  • Importere JUnit og JSON-Simple
• JUnit
  • Brukes til testing av ulik funksjonalitet i programmet. For eksempel, testing av kryptering- og dekrypyteringsmetodene.
• JSON-Simple
  • Brukes til å formatere json både hos klienten og rest-serveren.
• SpringBoot
  • Vi bruker en springboot rest server for å lagre alle nodene vi har tilgjengelige. Her kan vi hente ut alle aktive noder, samt registrere og slette individuelle noder.

💾 Installasjon og bruk:

Disse instruksjonene vil gi deg en fungerende tjeneste på et lokalt nettverk.

For å kjøre tjenesten kreves det:

✅ At Backendserveren kjører og at port 8080 er ledig

✅ I hvert fall 3 nodes som kjører og er koblet opp til serveren

✅ En tilgjengelig rest api som returnerer en streng,json,xml

📡 Server:

Dersom du vil hoste en egen server last ned OnionServer.jar

⬇️ Server

Deretter er det bare å kjøre kommandoen under i samme katalog som filen

java -jar OnionServer.jar

Dette vil starte en Spring Boot server som kjører på port 8080 Dersom du ønsker at denne skal være tilgjengelig for andre utenfor ditt lokale nettverk blir du nødt til å portforwarde Link til hjelp

📠 Noder:

For å kjøre din egen node må du først laste ned OnionNode.jar

⬇️ Node

Kjør deretter kommandoen under i samme katalog som filen

java -jar OnionNode.jar

Etter at du har kjørt denne kommandoen må du spesifisere hvilken port du ønsker at noden skal kjøre på. Det er da lurt å velge porter som ikke er låste eller brukes av andre tjenester Du blir deretter nødt til å spesifisere ip adressen på Serveren over, dersom du kjører begge på lokal maskin blir det da localhost. Etter dette vil noden koble seg til og printe ut 200:ok hvis alt stemte.

💻 Klient:

For å kjøre en klient er det bare å laste ned OnionClient.jar

⬇️ Klient

Kjør deretter kommandoen under i samme katalog som filen

java -jar OnionClient.jar

Denne kommandoen vil starte opp en klient som du kan benytte for å koble deg til Onion nettverket. Etter at du skrevet kommandoen må du oppgi ip adressen til serveren (localhost hvis den kjører på den samme maskinen) Deretter må du skrive inn en api som du kan hente informasjon fra.

Noen gode APIer:

Her er noen APIer som vi synes er morsomme

Kanye West quote generator:

https://api.kanye.rest

Insult generator:

https://evilinsult.com/generate_insult.php?lang=en&type=json

🧪 Kjøring av tester

Testene i repoet er allerede testet med github actions, og du kan se resultatet av siste build øverst i denne readme'en eller under "Actions" i menyen over.

Dersom du ønsker å kjøre testene selv kan du gjøre det ved å:

1️⃣ Klone repoet

2️⃣ Kjøre kommandoen under i samme katalog som det klonede prosjektet

mvn test