Opened 6 years ago

Closed 6 years ago

#12215 closed defect (implemented)

better project tree structure for obfs-flash/fog

Reported by: infinity0 Owned by: RushingWookie
Priority: Medium Milestone:
Component: Circumvention/Pluggable transport Version:
Severity: Keywords:
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

The project tree structure is quite disorganised atm. Now is probably a good time to turn it into modules, before we write too much more code.

See obfsproxy[1] and pyptlib[2] for an example of how to structure a python project.
See websocket[3] and goptlib[4] for an example of how to structure a go project.

[1] https://gitweb.torproject.org/pluggable-transports/obfsproxy.git
[2] https://gitweb.torproject.org/pluggable-transports/pyptlib.git
[3] https://gitweb.torproject.org/pluggable-transports/websocket.git
[4] https://gitweb.torproject.org/pluggable-transports/goptlib.git

Child Tickets

Change History (5)

comment:1 Changed 6 years ago by infinity0

Owner: changed from asn to RushingWookie
Status: newassigned

comment:2 Changed 6 years ago by RushingWookie

wrong ticket

Last edited 6 years ago by RushingWookie (previous) (diff)

comment:3 Changed 6 years ago by RushingWookie

Ok so here's a first version of sorting out the project structure. I've separated it into two folders, fog-client and fog-server which use python and go project structure respectively.
I'm not sure about the setup.py file as it could be either toplevel or inside fog-client
├── Makefile
├── README
├── fog-client
│   ├── bin
│   │   └── obfs-flash-client
│   ├── doc
│   ├── example-fog-config
│   ├── fog
│   │   ├── init.py
│   │   ├── socks.py
├── fog-server
│   ├── doc
│   ├── go-config
│   ├── obfs-flash-server.go
│   ├── stack.go
│   └── stack_test.go
├── setup.py
├── torrc
└── torrc-server

Last edited 6 years ago by RushingWookie (previous) (diff)

comment:4 Changed 6 years ago by infinity0

Hey, the general premise looks good. I think setup.py belongs to fog-client. If you have the separate folders why not put torrc in there too? You should also rename obfs-flash-client and obfs-flash-server.

comment:5 Changed 6 years ago by RushingWookie

Resolution: implemented
Status: assignedclosed
Note: See TracTickets for help on using tickets.