From ec284f6ee60dc9c1473fc48d0ae56b53fb534bc0 Mon Sep 17 00:00:00 2001 From: Unic-X Date: Sun, 18 Jun 2023 14:16:12 +0530 Subject: [PATCH] Changed readme --- README.md | 57 +++++++++++++----------------------- assets/images/confusion.png | Bin 0 -> 6536 bytes 2 files changed, 20 insertions(+), 37 deletions(-) create mode 100644 assets/images/confusion.png diff --git a/README.md b/README.md index 3818235..a2b91e4 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,45 @@ -[![Documentation](https://img.shields.io/badge/documentation-read-green)](https://docs.deepfence.io/flowmeter) -[![GitHub license](https://img.shields.io/github/license/deepfence/FlowMeter)](https://github.com/deepfence/FlowMeter/blob/main/LICENSE) -[![GitHub stars](https://img.shields.io/github/stars/deepfence/FlowMeter)](https://github.com/deepfence/FlowMeter/stargazers) -[![GitHub issues](https://img.shields.io/github/issues/deepfence/FlowMeter)](https://github.com/deepfence/FlowMeter/issues) -[![Slack](https://img.shields.io/badge/slack-@deepfence-blue.svg?logo=slack)](https://join.slack.com/t/deepfence-community/shared_invite/zt-podmzle9-5X~qYx8wMaLt9bGWwkSdgQ) - -# FlowMeter -FlowMeter is an experimental utility built for analysing and classifing packets by looking at packet headers. +# PacketBreeze +PacketBreeze is an utility tool built for analysing and classifing packets by looking at packet headers. ## Primary design goals: -FlowMeter aims to: +PacketBreeze aims to: - **Classify packets and flows as benign or malicious with high true positives (TP) and low false positives (FP)**. - **Use the labeled data to reduce amount of traffic requiring deeper analysis**. -Additionally, Deepfence FlowMeter also categorizes packets into flows and shows a rich ensemble of flow data and statistics. +Additionally, PacketBreeze also categorizes packets into flows and shows a rich ensemble of flow data and statistics. -| Flowmeter-flows | +| Packetbreeze-flows | |:--:| -| *FlowMeter takes packets and returns file with statistics of flows.* | +| *PacketBreeze takes packets and returns file with statistics of flows.* | -| Flowmeter-flowsClassification +| Packetbreeze-flowsClassification |:--:| -| *Flowmeter takes packets and returns file with statistics of flows and classifies packets as benign or malicious.* | +| *Packetbreeze takes packets and returns file with statistics of flows and classifies packets as benign or malicious.* | -## When to use FLowMeter -Use FlowMeter if you wish to build and operate machine-learning models on network packet data. +| Packetbreeze-Confusion-Matrix +|:--:| +| *Packetbreeze's output shown in a confusion matrix.* | + +## When to use Packetbreeze + +Use PacketBreeze if you wish to build and operate machine-learning models on network packet data. ## Quick Start -For full instructions, refer to the [FlowMeter Documentation](https://docs.deepfence.io/flowmeter). -![FlowMeter QuickStart](docs/docs/flowmeter/img/flowmeter.svg) +## Who uses PacketBreeze? -## Who uses FlowMeter? - - * We use FlowMeter internally to quickly analyse and label packets. It forms one part of a project to build a fast pre-filter for packets before we conduct deeper layer-7 analysis in [Deepfence ThreatMapper](https://deepfence.io/threatmapper/). + * One can use PacketBreeze to label the network packets using ML before deep analysis. Thus resulting in faster analysis overall. ## Get in touch -Thank you for using FlowMeter. +Thank you for using PacketBreeze. - * [](https://docs.deepfence.io/flowmeter) Start with the documentation - * [](https://join.slack.com/t/deepfence-community/shared_invite/zt-podmzle9-5X~qYx8wMaLt9bGWwkSdgQ) Got a question, need some help? Find the Deepfence team on Slack - * [![GitHub issues](https://img.shields.io/github/issues/deepfence/FlowMeter)](https://github.com/deepfence/FlowMeter/issues) Got a feature request or found a bug? Raise an issue - * [productsecurity *at* deepfence *dot* io](SECURITY.md): Found a security issue? Share it in confidence - * Find out more at [deepfence.io](https://deepfence.io/) + * -## Security and Support +## Support -For any security-related issues in the FlowMeter project, contact [productsecurity *at* deepfence *dot* io](SECURITY.md). - -Please file GitHub issues as needed, and join the Deepfence Community [Slack channel](https://join.slack.com/t/deepfence-community/shared_invite/zt-podmzle9-5X~qYx8wMaLt9bGWwkSdgQ). - -## License - -The Deepfence FlowMeter project (this repository) is offered under the [Apache2 license](https://www.apache.org/licenses/LICENSE-2.0). - -[Contributions](CONTRIBUTING.md) to Deepfence FlowMeter project are similarly accepted under the Apache2 license, as per [GitHub's inbound=outbound policy](https://docs.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license). diff --git a/assets/images/confusion.png b/assets/images/confusion.png new file mode 100644 index 0000000000000000000000000000000000000000..59f1835ec173f7ebfd64a013ab0ffb5917b5b9fe GIT binary patch literal 6536 zcmeAS@N?(olHy`uVBq!ia0y~yVB}|DV3gosV_;x#`co{+z`$Tx;u=vBoS#-wo>-L1 z;G0-dkdt4MlbNJYmReMtnV)B@XRK$WqmWTjQc!HAub&H7pqF2iuCL!E$j!jOz**oC zSlFzshIQjZuy+ht9$=_JkRXBp36){ET_X|LIUT;gx;HZJ(?=K4p|^U4bGUfaOrMd3ZF-^4^6*+ds}dI-8Wba8Mn-~WC5 zUUU1zT{C7HKdsy!_jy+Fw_E9R-zT24+5GKRw!DbojG1fKvmMnta3)K=y?v%?Va1F{ zAvDH~EYB>pm-VV=Cx5xX_T{qwrOQ(zqc?ioa=)~{E7sjtVg2V7e^q4p=Wv&>?PIvd z_|IA??&g6yf0lDBRjw{K+pa}k_T)-v@Ay%^F?%Ji&8HPlRpxTv;rPRLgXad<4oQnm zLc8uu{n%i~a(vf>kf1kGSyMVbgzNrgy2ZfVFn>+re6^H^M!NrZ31&>%{*`SR({sl8 zjF%h#Ro)gz;M`zR-xu7d-B8W_>mD1&0+s#sTn3FfUyKD`gm3sewdwd*rh81!p5Ct( z-LjVc6Uf-53AE4=g`m`}Fpw<2lpq-TVL4u_uUK*nQ)DZ&u}h(cKL7xd-_9`B+b#s;>;+ ze17Ty`$peJ--hcAt3PeK_w(_37OAKEOSl_*KYi;;+<5B)Llnd3#<`!i={CfEx~+YP z`G&*{<~cL$-!1?7x2*Cv_ksEb*~YY=f3w3r-#Ybrzs~yqCJAZ<_7}KrutxBdocjKs zZ$tRMJ+~PiHy&jD%evvO*0253bXsPMwz=;+pIK>twsCnw;?cVJkn7X=qqDY`9at0b zInmYr!KscPI!bAidNurXGU8`#*YE96Kk@I?yD1Upix#Y2k|t}QvJX04Y7<$kKT6t zNdLD-o_Rad@3n`sciAZIJM}u!)8!6d4a*)!u^H3XEZuK)_+jAgvuwB4KaJSKY_Rgd zza=%dyX>@D&O0r5`b$hmFn$v6*Lpsm=_Wxz&r4S<-?L1Y`(6DmxvyvXI#PeW{S^OB zlJ#x(DS7=&ch7$BUm=%jHdQYAmizAxm*~+M=l|Nz2%q8+(S&TKVWj{9Oh}POLzR`GD z;i)>Qk98MAzxuT;c2N`0p4K_x?#isasrR3?hsmq4@W6|j=u^eE%zrH3zs?Q&*P8E8b}dcnrew$8 z2FKMelFbTS_Px*9WUT7$a%9bvS=TQAJn%6ky)aL`TDNr_!@Ef);g<}vU;A8|m@@gA z{dx1b++QYKS$|1u-N8K`XU1U4sQTTyL23+)NMI=)IvU?%mE?YVzAKOOT-|;?BGI`h$Z! zRo`RTdZmvCe!uVUIay8nR@K~cxp0>Ydt$8_X65cNRJZ>wBVPZJwf*nAa_z5|zwUS} z5fOFjz{X_Dhwtm-KT6y-kiC7l_&@La`#kUOv7~=Jxh?;S(7b&@c6&^J-`nQ8?eBtj z2CvvO{>FZ*{U6&MR<(5Xmk$%R_*}A{bj(Xicja}qFQrSDG;3|%H)~C3JKvkiYms-Z zZB{q0|9#seA{@o#S9{dw@i z!#i95|GRT(t+cV1_sz#W#;d+=y%L&w`oSLS1*a8mysr6i^x=lj+aDZS{P1SbjgMd6 z{BCtm|9yTIf9<-a*z+xu^Bbzq>E`{Nx>Czcu3KqQwMz-J9@9F%w;D=%-5vEIahay^ z&69+rOtamZ+jujt?6HjZnay@!q4}Ky#^Nyyg4*9=cNHj3j<21%>1cQOI~S%-H{DJ4 z^}bQt<1Y5+&hUSJV8;KH?czF3AA=K4mlZsjS8#pv&2PKsweG7<-F|;2!)5#PdHc;J zXPGq}Q@t8r9=hVy;c3?n%=u(JsZR5yuIJK8ZBK4*n`jbu>FuO@lfP_Pl2&-lT559QrH zDE+_b?5(teOgF##-mWYDzqsn)49*Qp)>y4xV-+eWclOiaY5WcU8P_pQDB;+^yn+3K z?2o=BwV#i_VYnkAxSOH4aWR+mlq(`TM1MHCyy49WdT43QeEcHhNZ>@ z8U@=`7~7x3CpTP7+5f@%N&idl`atTFrk`tSA}_WHdNe!CdeYNE~_4O^&X`>U(ty6RSSX-$qDR!Vugcib{(>Hlat4Uq7|@ROMv#%Z2OrW?We#=`F6Cbeow!<&ScI!F5LVH8;{f z9O(pQBkuI`ak=*KHJ>g*4{Qt#DwtUN>DlZ(|34fC1;**qr)Jot@#NnxyDcSeT=B?d)|Ncq z!^e7G-r27IU8ab`_;~;Gql(Ti{$KLeiQhG4=VY~y+k^d9&JzzjUb~)qP6@*lzZS#8 zn{&nQ^Io^%;s3|wXDgw0zGZ&QzxONV81^$v_gKuj zJL)E_V-RyWvfEy$U*`k~)t}GK>w%oIdy@Ef(x$N7~GhIur`RF`b+_Pk2 z+sx2?w@f}6Y?gx8K0}e=A{h8aYSr8;iU|%IPjAS75&VYfjkKT2quRBrjwq2KSz6W8yJy0A9dIIg}{ z{aDY>WDfBnzAp9u^=n&S z{Cd}4U(@c)zjynM)QG$vAM!swnf&=i<@4_^uI1W1KCYkk;zA#fq|w~FWzy$Ur~4+q zxX^c0Z}X+Kr%ycg2DNK{{%vmbzxLcy>CwiH9cjA1zeLTqd%byj{JbO2=j&^gNwRIp zy4q0tJ@;gX;AX~%T_!Wk^CblxUti;G%t%&RTBPc=uN$7eKk)G9+xblVQ_MYX zIbX`2bnMCf@>M?)JePa?s;#Rw_NA#%v=bP!Id(%U-GH+D<*PfyJ>dHz^)>S=J_1sse;Pe^vYIF&6|5jS;?z0_k^3Q ze@I3ivyIBj*avJ0)3=tCGZc8=d%vk;M)<_fHQ&7b?qUA(OWpgQ&8aD}ma9zBW8k+nX}A5B z5qLyv^|4=baw~Zx+zu*wztei~v*QKV7sgq63BFNhzZr$C+pg*0GKI04p`P&_Or~p| z2MZNGbS;_Y@VTSH>5_e8{rcnCtERr&|6il(`@ObrZ)Y2)p4u5x_w)0e!s9cNribRw zt$Zf(Zg+mPl)0F&n$E)d|NWI;F7D)!|EKHab>z{}gAI(6yJORqMnC`1(XsNthfot< z)_0Ri^gi6NDk(K9n7t&pF*U{UQ!@2s)ccF?y*XlAueBZ%4EN7{q@QCV`BGA=m>}V+w$m*+#B*&h}#RF zubdGn)Q=V%YbJSIn)U9wDPMooia)-ZE9Wlh<=!4y=n?cJU0&s_e&**DkJFW9SxyXdKG>B{tDAr$AUTRF+5vz@>j1u7#H-0Dd(@}EmjL=3*H-iJG_D(cT{ZH zG4*Qxq;KqfOy7Dtj6CNyrV4(XxP(n`k=3-oTz{uKKl*7NiUrX_(c zcf#**y*6cxXSAQRMg0Qvjo?f3ex6_D_c761S1I###|*YT3{yO$%2M9_I>wc zBlKQA?D#QzNw{)S+C=YlpSkMPo=#p;&0x*gt@J3I_4i+qAA+SNJ9iyk+@?K4<}Lpj z);gV)DoX37Z;^SyYci$8++cUb)NAsrlP}+9{NLBHaMC#zzR6c4ez0%Q{*e7(MaPVY zB|)pFtj}H9sIrx1n)?wa&)ml44U7jW9_&7#-yp91NX_$aW1yhnx(wFq&XcyWyD@Bc zJM#DEw$F`+8>1VRH@cNps=To5mr~>J{@nQN=fabd_GCJ`=rFo5FFl|+$*;G=T2?01 zKj`TFsh%nA%Evvd_!N}d7=2IhsZYQ9^Z|qXwksBbhT)fT9fBXY3x4caa=hWS>Rds= zVAWn$Gp29TzQn}Jid`4^dFR-tKV|U=#SiWu*nGfg!Tu#_2YUWwSGd#!E-6~wdw4OM zW<0lm;AItFCcab8P5-gzFwZ;NoGNfr=7hq6(2rW{%voBNTy8XOtZux|@O|Rh{6F(@ z>XJ1J%3OSO!xmmW`7qFV%Ky^ITOwV~bac#CJ*z%@Z9c;tk8ju4>0S`e;CsVR6E~;p zwVmf~_ao6i&!;Ls_K6 z|6pau4)ge%f1EeXznUz#G2&8roqim&FelJmp=FWO(v3 zrF;G=cBzScleBuax=%KTr)^{M$*}%uOus#>bd}z*#;Hi>ZaG>0pU1*X>6qB!YrEFf z6qzX1vE}H${JQ7m`vccfmLF%7nmpG|fAuq=Y?k?})-tMWRgX5cGE@5HnZ@)+;)d`K z1N)Yj6V~f()e3p|>c+C49`AV{JnpavyCiww`w2ez+l5DAK4HiD;V4rm0%m7XmO71miv*VKmUd|`YSz}@#l<}c|wqjkAB?Iqfb9*G&Mav z`+LG#P7T&$6IhR$9+=Sa!&^>acGZ!=t!{5qHt?||3Yj;Q;DVB4c zzg((+Y~Sx@zmPkBQ!<6Sm0SH2k!wqr&8V8RG@+8%#eu|Anv9H?UTUJNG@ZkSA}d ze^B|RQYm4Tw=6MyF}~Z5{E>W+@}P3lg8d>ECzKDa|G8mlm**|PiYYm5|H3EL%`^Yo zo-^}vX=T9|mUXJqr3~7!do!o%?Em$(;K8&%O50~1s7{%G;hW~oTeG}RsBNrglzIFh zVy3%Xs7H|aCe<_3U61_tvTDq+{8=pcQQvbqv-PC8-(GXXND20fu6}Be4^>eshSgi z^a|WvVuG(Qy`ISR+F}>;<`e6hbQ$#&W>2?bpTRzd#U^C_^};p1hZjqESWS4tTq`9W zbE{VCf|=4f{j9>T0smIU|2<(>yhZuuk&Fqf9{HQJr!B8y*^xHSU@e>AN1dB2ciJ~R z3SLpi`NO$pm1CW2&d;}tPp(t6Qn|l{{pRvIQ--#u+YcYySjN|%HA$br+WC^xrp@}z z%8yQGF@8sWoXf)8y+Hri&I-glzsJaE$xFs`Jba z>IqyokF%Qfci2Cl&%b;AlD!S@8PtE5y!rJp(R-qW#j3s~v8r!p-Tyo1jq{S-6KYpg z+Nb{4eUjhcmZChNTUO@v`Sj>DeiN_sosK5ej4RZ3%KpE$SauBe5`j@fS>9rjgv