Git Product home page Git Product logo

tshark.dev's Introduction

Packet Analysis with Tshark

Netlify Status Lighthouse Performance Badge Lighthouse Best Practices Badge Lighthouse Accessibility Badge Lighthouse SEO Badge



tshark.dev screenshot

tshark.dev exists to teach you about packet analysis.

The main aim for the site is to provide example usage of working with packets and hopefully give back something to the networking community in the process.

This website is built using hugo, an open-source static site generator. Most of the HTML/CSS/JS, shortcodes, and partials come from the Learn Theme.

Build it

Serve tshark.dev locally

  1. Download the repo

    git clone https://github.com/pocc/tshark.dev
    cd tshark.dev
    
  2. Install hugo

  3. Start the server: hugo server

  4. Open the address in a browser (default is localhost:1313)

Contributing

Become a Patron!

Support me if you like good documentation!

Raising an Issue

Apart from manually adding an issue, there are multiple ways to raise an issue for this website:

  • Edit this page: Every page has a link in the upper right corner that can click on to see the page in github. You can then make a pull request once you are satisfied with your changes.
  • Comment: At the bottom of every article, there is a comments section that is tied to github issues.
  • Email: If you do not want to use github, you can interact with the contributors by emailing tshark_dev[АТ]fire.fundersclub.com. This will make a github issue that functions like an email chain. As this is public, do not put any PII or sensitive information in it.
  • Contact: If you do not want your issue to be public, you can contact me directly at rj[АТ]tshark.dev

Submitting a Pull Request

Contributions to the site are greatly appreciated, if you see a typo or something that isn't quite right and want to help improve the site for everyone then please feel free to submit a pull request.

  • Start off by forking the repository
  • Make any changes you have in mind
  • Submit a Pull Request from your forked version back into the original version of the site
  • I'll review it and approve it
  • It'll automatically go live in seconds!

A list of contributors is available here.

Guide Philosophy

  • If you can't understand an article, that's a bug
  • Bad style and tone are high-priority issues
  • Prefer linking to articles than writing new ones
  • Link to manpages/Wireshark docs wherever relevant
  • Further reading links should provide something that the article above it does not

tshark.dev's People

Contributors

paraacha avatar pocc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

tshark.dev's Issues

Progressive Web App > Fast and Reliable

  • Current page does not respond with a 200 when offline
    If you're building a Progressive Web App, consider using a service worker so that your app can work offline. Learn more.

  • start_url does not respond with a 200 when offline
    No usable web app manifest found on page.
    A service worker enables your web app to be reliable in unpredictable network conditions. Learn more.

Add Links for

  • Lua scripting (/packetcraft/lua_scripts.md)
  • Scripting (/packetcraft/scripting.md)

Progressive Web App > PWA Optimized

  • Content is not sized correctly for the viewport
    The viewport size is 808px, whereas the window size is 1440px.
    If the width of your app's content doesn't match the width of the viewport, your app might not be optimized for mobile screens. Learn more.

Fix /capture/sources/pipe page

  • What does having some of the outputs in parentheses mean?

  • I really think this table would benefit from some quick links to each tool, or a tool-tip for each tool - something that just reminds the reader what each one does. Perhaps also some examples too. And one more suggestion would be to include sample output when you show a sample command-line - helps me to understand better what the command is doing. I write this from the point of view of someone who was arrived at this page with a google search, so without the context of the rest of tshark.dev - someone just looking for a quick answer.

  • Possibly show samples for json format, explain what ek output format is.

  • Small typo, confrom -> conform

Cheers @gcla

Implement Better Search

Current Search

Upper lefthand corner shows a list of pages that match content

Desired Search

Page opens showing context, like google results so it's easier to find things. Specifically, have link at the top with a paragraph below where the terms occur in context, ideally highlighted as well.

Provide more context for reordercap and examples of how to create an out-of-order pcap

Feedback from Jasper:

The "Sanitze the Packet Capture" mentions "reordercap" but doesn't explain what could cause packets to be out of order. This is one of the parts where I think you'll add more content later to explain in greater detail why someone might need to use those tools.

This covers /share/pcap_preparation/#sanitize-the-packet-capture, /edit/reordercap

Be more consistent in referring to tshark/wireshark

The problem is that people refer to both the GUI and project as a whole as "Wireshark".

Make it clear in the README when you are referring to tshark, GUIreshark, and the Wireshark project generally. This could mean using lowercase wireshark to refer to the gui or using "GUIreshark".

Expand on tshark

Summary is only 2 sentences, but should be longer (maybe explain history and relationship with Wireshark?)

--minify breaks svgs

This was recognized as an issue in minify and was fixed in v2.5.1.

Now we just need to wait for it to percolate into hugo versions so that in netlify commands, --minify can be specified.

Accessibility > Names and Labels

  • Form elements do not have associated labels
    Labels ensure that form controls are announced properly by assistive technologies, like screen readers. Learn more.
    Failing Elements
    input#search-by
    

Fonts not found

4 files are resources not found. Redownload them from learn theme to /static/webfonts.

/webfonts/fa-regular-400.svg
/webfonts/fa-regular-400.woff
/webfonts/fa-regular-400.ttf
/webfonts/fa-regular-400.woff2

Acessibility > Best Practices

  • [id] attributes on the page are not unique
    The value of an id attribute must be unique to prevent other instances from being overlooked by assistive technologies. Learn more.
    Failing Elements
    
    text#text3
    text#mermaid-1560775179966Text
    

Accessibility > Contrast: Make it higher

  • Background and foreground colors do not have a sufficient contrast ratio.
    Low-contrast text is difficult or impossible for many users to read. Learn more.
    Failing Elements
    input#search-by
    a.highlight
    a.highlight
    a.highlight
    a.highlight
    a.highlight
    ...
    

Make content map

  • Create stub articles for each planned article
  • Finish mermaid map with planned articles
  • Add a link for every mermaid map item

Make sure sections have appropriate intros

Each section should have an intro (##) which explains exactly what the section contains and what you can do with that information.

The introduction for main page should say something like (but as clearly and with as short sentences as possible):

tshark.dev exists to help you script your pcap pipeline using tshark and friends. Bash is used throughout, with the expectation that it is cross-platform with the advent of WSL on Windows.

Accessibility > Tables and lists

  • Lists do not contain only <li> elements and script supporting elements (<script> and <template>)
    Screen readers have a specific way of announcing lists. Ensuring proper list structure aids screen reader output. Learn more.

SEO > Mobile Friendly

  • Tap targets are not sized appropriately
    29% appropriately sized tap targets
    Interactive elements like buttons and links should be large enough (48x48px), and have enough space around them, to be easy enough to tap without overlapping onto other elements. Learn more.
    Tap target (links in the TOC are marked as hits)

Progressive Web App > Installable

  • Does not register a service worker that controls page and start_url
    The service worker is the technology that enables your app to use many Progressive Web
    App features, such as offline, add to homescreen, and push notifications. Learn more.

  • Web app manifest does not meet the installability requirements
    Failures: No manifest was fetched, No <meta name="theme-color"> tag found.
    Browsers can proactively prompt users to add your app to their homescreen, which can lead to higher engagement. Learn more.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.