From cafa4e6d11cfa9bc5574759502c6fbcee621589b Mon Sep 17 00:00:00 2001 From: Kevin Froman Date: Sat, 25 Apr 2020 02:54:56 -0500 Subject: [PATCH] improved readme# --- README.md | 35 +++++++++++++++++++++++++++-------- logo.png | Bin 0 -> 6455 bytes 2 files changed, 27 insertions(+), 8 deletions(-) create mode 100644 logo.png diff --git a/README.md b/README.md index c3fd356..e559c15 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,35 @@ -# youandme 🧑‍🤝‍🧑 +![](logo.png) -[![Build Status](https://travis-ci.org/beardog108/youandme.svg?branch=master)](https://travis-ci.org/beardog108/youandme) -Only you and the person you're talking to should know the details of the conversation. +[![Build Status](https://travis-ci.org/beardog108/youandme.svg?branch=master)](https://travis-ci.org/beardog108/youandme) ![](https://img.shields.io/pypi/wheel/youandme) ![](https://img.shields.io/github/languages/top/beardog108/youandme) ![](https://img.shields.io/badge/metadata%20surveillance-LIMITED-blue) ![](https://img.shields.io/github/languages/code-size/beardog108/youandme) + +Only you and the person you're talking to should know the details of the conversation. This includes metadata. + +This is a Python library to share data anonymously and securely* with limited traffic metadata. It is designed for generic byte streaming over a private tunnel, using Tor onion services.. + + +This library is meant to be used by other libraries or applications, however a script 'yam' is included to enable basic CLI instant messaging. -This is a Python library to share data anonymously and securely* with limited traffic metadata. It is designed for generic byte streaming, but a script 'yam' is included to enable basic CLI instant messaging. \* The ID one connects to a host with must be shared via a secure (private, authenticated) channel. +# install 📥 + `$ pip install youandme` You also need a recent Tor daemon in executable path. 0.4 Tor is what is tested. https://www.torproject.org/download/tor/ -# why +## basic chat usage 💬 + +`$ yam.py host` + +This will start a bare-bones CLI-based chat and output an address to be given to a friend. + +The friend connects: + +`$ yam.py conn --address
` + +# purpose 🧑‍🤝‍🧑 In normal socket connections, Eve can see when Alex and Bob communicate and the size of their communications. @@ -21,17 +38,19 @@ This library sends continuous streams of data (null bytes) even when no informat Anonymity and encryption is provided via Tor onion services, though this library could easily be adapted to use plaintext (and encryption by an application) or another relay like I2P. -# security +# security 🔒 As stated above, this library does no authentication. However, if the ID is shared privately and safely, the tunnel will have roughly the security of a Tor v3 onion service, with increased metadata unobservability. +That said, one should not rely on any software when the stakes are too high. -## What an attacker sees in a normal Tor connection + +## what an attacker sees in a normal Tor connection ![](no-dummy.png) -## What an attacker sees in a youandme connection +## what an attacker sees in a youandme connection ![](dummy.png) diff --git a/logo.png b/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..bef3c7db06169d8aabfff3adb52d68f0d5bbfd3f GIT binary patch literal 6455 zcmZv91yCHo(&pmsu7SmZd+@~;3r=te1U9&PaEBnl-Q9h03ldzyBEbn3TmnHC`FVd` zU0v0?v6|`X`lhRA+P-S2Dd1pIVgdjF93@4t765?2|GKwAM}1xGc}lSW0BkuQZGCsG zPhND+u1=OV_Mhq8zc_!U`|NFF2>^Jn^kmq$?zIzyz3dQ!5L*XasX4;YH@}bE>d^_- z>Q;~JU_@>vgE1L{WjHep+#l)#X>ajBta9f~^SVB)dFp2!BmGKOGy5W_`RAK(r9%lU z$@ng<%}Ai^*qPrm=L7YinQ?%)#+4W-kk-qi=L+gobUQE-Hm3V6=j7L@R}pdk-;3vS zA3rtuduZ;hS1;aX>Qnv8el&k8k7+cQE#}x}->CtsL|^FU*;_QOz;!RQ^u@7Ndf0rKq@!!%a4qP$W`l&_m~P^=>W_!>p3O#gwn!)2lP1zw>~NQ%JjZ9{(CU$( zMW{+r;nZ&TS=@Fj&agYU34Rn`!E1axLfrow%wY-U_#-t`Ef*B_jg)^=W_lKA#d{^e zoc^7&h8Sxamy{QnAqW=PieGw)T65a@b8!|()plpHn-hK(NFZWW2q*3^-MLYnziD@d z^W^BzgHY&+_C|0--7O3&te`rcDfIlDlU1c7%kxfOcNE1q`6@T5idpla}u{L8~dEoaz? zTB|waj~FMU!Hj{HcI;7iUFf3*Q}xlWo`-l6sUD}Bz&2P zvqHPwZf6Q|O^yZXri)}aY=3foc4XF{<}OBIb~(N;Td$#;+N#|C=r7t>6t-xSefm4X z!3<%C9FGsdO)9>uRCOak@<_9z9_5DXY>b15%F+1=)6DyJyZ}V`8;nT<_@evHqI$mt z8cz{dnRJ;7dkfcRks#3-g44e^-kJ`P-oK#gpD<)P?4w;7hEwgnBro~cdMpa7R~v30 zo~@=8{(I`2U-`Ja zK7i8>?5-rzHA(lBJ9ZVWRsj&_toH`@ZZ9LzlD1nK0s}eH9im zW?ds)#XkdP%*{h`!{MCs=P*xO|GXjR-FcGcVP2O{13Iv7Nme-vz9!WGG&b7|MEqJe z0Jtbp24{wgIk}I9$dKH(98dLBi67RQ8&$L4W)=O*(0UB0<(U1j#4NTjc0&=I^)jn^Bk($r_1R>`e-Egz$M_ z4c$O|Kq`95M{_R2Pm%hbu=w{d+DG#qxy=*<(+e|-&sLbZtUzc;pVSkxZ{r&jQNI&M z%QsNfZn4UoPkf*1Fuvqf;A<^|(G?v28C1EUn)KEWXAud+M7%X)YdAcxQY_(*N|G8a zELuyLGBID1cS6g=7cIimicNUV%cd*+z($aaSedq_p!dDcQF}PA`d0;!YJ1!k01fJK zppY`2!;@0Kmc_CrOt$`;)_2Yy)kr)}Fh|X&pD=-X*K;zp2y<#Yj%`rGSVs9EkUIFc z#hKnrFB_=hjwWABg{f47@`8Vd5;ZosKmvkZ`<>0^=d};vTgSba04c-Klv%$aw`7QF z?H5CIj`z85e&FhswlpuejC~w2x~N>0I*o0zOf%@3>9Dr;Ij|#z0QLu;qBS-gxR%p| zMVyTBQJAC$(i$}zn|`vo{b{je(`AmT*Rc*k;Duz(Li6b$@($K-mvA8mie`8V6gRkE z3M?$K;vNM#)h$mkjFL)DwaI}5G&mpjm!QXkRk$SW=BQcGidl0oUJp+zvl~a^LAwwx z&5{#OQ~b<*7`r8c{XCv1pDlw6( zecrBZjMPh^ter#OPj0Ec-kjE@NKs!&lk(KOD~njA8Tj4Da4qGmlsa3 zA@Vm^E#iPkaY5%2R?7I6QNMCWxi5~kW>l(V z(N=)!K2zp7d#%4Ub41F{wjm=sijC(o@60W$dpGMTkB-^VhnlE(huCb?HNHY=LR5B!qZfJAcNV$W5pN8Q^cbe) zniT6|aKrIs%-YRD8=dn23-EMJt3iM;lpKa7Mvz+0_)G6?r-GrygU>rMqP$X8@A}U8 zWJpl!w2qeky$ci(xM}e1xk|v~y{DYDb%^vl@4d7g3P&fdbPCh5XcNR52Jh}y;L=Sd zeZb86dqL|Leq{cGKfRPlu+74BELFq$dgZ-9f_G&a$$Ya*&KXI^yXbEK>E9`U7Y!8N zibKVVFGw4T0#bd9La5<&yX?#FEyV(jQV$fY0E7HnJ=%CE0=SyQ1R1?b7>Jm)!48I6$PSPY< z7~KTmC;esFzVy6j2%jgT#2WinjP~U?&o9><9{=z3cnosfX5EFXWj@V^@$gOws)^a8 z6*MB$guob12|K{OPh&BUtE0bnI45b)=E)P-xJMyOPS=fth<~rjkdZ`H1|D3DwalKD zC6Eu$t->?%5X6?yQJ@}%Gr6ih!FvOw2;+o+NO`JOO@yxriGHCng(i^)SBOgo%S)Fj z%$X5{=EuU64M6k-p?8^$p#;+`!5WvQ9*<-^E=5256&2+F(UKB0dyo*i^q(c_E}%JUYApAU}RLztoL zbV;1}HDLTGobL@F%WHeYkmb>3V$4d#zJ!CWD`|@*yDL1Uzt;x=UR#nh!P_OyBmgDH z`%_GU5arSW2I)Bzfo1pwJ~zfsH=tsncMc9)Op^ufAEIDAE=u(y>DTVG(rasif`mo=C$&Ftcjl== zIG&Vq+u&5S4=)bD?>i@F&p2dZn{qkrSnjVChNF$FtcHz+#cTPHSU4%Q?e4!r7* zN<_hexRA+`rbKa2#4M}83b5bt|MIKw9XZ{|6j)}XiebfS{M&Nzra`AQMXQ7nD=@e| zuIyN%j`FLU*zMDG&Q*8r74^jk&boUDk{M~VCy;dEPtuj)!B;w(unH^TQnAImdF`CQ z5jYM=ryj0T|8n~zl9k5y4YwC{i(tJeX24?L??O?j_lI`Xnew!-+irlv zZTib&)l#04N|5RGysM<}Q|NWK1LiHJf=Y2oV7|gSV-D-2n(}GNa=2^=xuyUtMSr+J zv2Q*Ea?|GYdqQX|+S~o!D5dd7A_MmZNK+Xm$RNn>BM%B~8h`T2Q}eX`c})9FWuB-qCnE$6= zehjjHrC>NK8n^)fxI_P$2&wG2RIfxdcO_Lhv|VHhGwoY^a0P|i6EUoRma=IR< zLVQSrdSSH~E;kN5kam&g@#0+BB_uhnUy7KwF6tSY*KV&Ovzz}XFiT!snWs}ct9*to zp=!;hs%FbB-3*p!%=57Vi>te_S=;HzwCLb{PS*i{3N|4v3w+xi!!e27+|1uK!?J9Q zYvpOR>9xOnE(V{*mID7*BhD#s|Is<-3w~#64biJ7TfziiW-K9thj0-ZBnlE~A5~EeQ#DC!?Z1 z$^S2cc?QA%bA;s`+(r%EG9r%7-Cx}_M0Rou8zn7k;b{B1tz}t!et#aR|Gdxt%{^r|Hxo&! z$&sina^|1Zoy zSo!aj&v|DU=hM@}H95Z}HnMck5A*(53Vsb;-J7Xie>gIdp0(Dh!s(95J>P1zSCpZ) zHY2rUfZxknhg)J+R`k-6eo1*b12;F`$Tu4H9-r%~gp?FW4No(q9LUTra&)sX)UiYH zX+_(ICsUN#dq!8^b6$?wF`Xk6C|+sd}!c$4?T^)0I7O=idN7kZDPaO#pg`ic+66 zKJv*@<4$6lQ=TLsfgmC)DIz0=j2pzZHwJ^jczkb8;(@iFRGFVnrsv93;Xnr2)rk<^ z$+zYz`5=?&=^LdI9Kp~>*J_Uz96*ME4Gf;u7kGw9jJj9P#;@lTZ{y zQ)wF+W!JEzcKMMnZ+RIzZx4Od+n>zj7nG2oQBqPmI5`QMI|Qq$s%|t|jGPoz#CN-O zttZl0<_IVUAotl?jLNFM{tBy^JbDp>m4EpW5vaw`543=x;oM6=fCyoKm_ zzEOL_O1C}ch9Q4)S1F8ssE_6@VEL1jUq{09V`}df9{QT7`tE zav{gHp4noB)t#N4^LxKuaNBCGiK%Jd$wrT_3!$lAHI^DGGF5;~n6MkQ z#?vpT{p*pdZ{Q(AzjQ4+3hVgw1F^3=3^EgWzqMg&ipcmnoAP+WtvTnP3LP>!p7l}G zbJ;mKDI`UZ7y^Z8z{HsXSj{(f*VZ6+3414KPbaP9s6Seo3+u`CX#MzGOdHQhj^Q-) z4>I<58`d%$=JsDtT>J@_ks%r5llIDB-DR``zega4lfWxe^1=Y^FR~X?G=tPc-hmpH zpOZD;^!;7DmE`gGff3}dF1=q)0HBt|1dN~{AQ+7OzaIYo9N$8;Gp+u(K?|M?dzx?* zn}N(0VcWlM=HC@{E!Z8XU2HgQvm`3weOh$wB;_o(OLdU4MI5FzL8YIrd5cWTC4uaY z_gDNg?}af{GM&_J$INRW8Lv8`H2Mp@Ybx@{?V84w7!68KufFj;*dx6KLkf71f~-CZ zUTpZY)l)uJ;nKYLP0}(J72@zOwA-nl)8uu^347*9|LOmcH2s@M%+J|hxAf@dZqtG7 zZ2gT)L)bY~NBPF+5khD~Vre^C_mTTwSX6l{!PE_vqEFyri2y z)5uRRs^q)EgD#GDS$91aZ0@a*J;&TsZ${dCD`gQeia+RXX{DzVi30)p9Hb{}9Uq*9 zsRxP`;(gvwy|c$hmNqNko!oUhd!RIrlUj{XmmP9gu#BZ zmxh(K{`_}pT3W=wfDAD)@mrkt(XBjJ^-X?pwcbtVTHpI5;c&sboZ6c4qGlhgJ$zC? zgFoDpUPwsjAmsI??_n53bv`W@(EA2`Dl?wY^EhF` ztQ;R7_ef1mJzgTDwu~qdO}_F10@pw0B=*Zu5)y-=237ncjjpzic?@>kmvPhD6o8-9 zT6g!vUSIFWm{?N!?V5{gJza#sTf`d2OIpoiw%Yp(91|}?OI<#WW!9uLhb2G4ycPKX z7`%R1xF=*#1y^WrtZ^@;WG|1@)H31KD*jFQ_F<^QbLeOFMy5~&{GVy4lqq$s3AAjJ zrSD9o2myS`WP^O5>$ts6qaN>z?9dAl!+(Zb(R`ADuJxSER$mg~i0u5BR|%_)*Y152 zf~49;4`hAI%W_EJdIwP|NqJkWv3rBd0HINNIjFEUB z83R7%C7iEa3sNceK7s~S#2)%6xk6(<$rsLF9a|3mNj~uOjnhaS%XMe-Dyo8gtqrXm z9BUHgZX7Fk48)Imnym<0y?!GuL|VbbxxL+2NMukzZz&# n;@@8M|4JzTKZKH&7o-TLZ=bVk`e