Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add advice / documentation in readme on using cookies #326

Closed
olearycrew opened this issue Feb 20, 2023 · 7 comments · Fixed by #461
Closed

Add advice / documentation in readme on using cookies #326

olearycrew opened this issue Feb 20, 2023 · 7 comments · Fixed by #461
Assignees
Labels
Status: Completed Nothing further to be done with this issue. Awaiting to be closed. Type: Maintenance Updating phrasing or wording to make things clearer or removing ambiguity.
Milestone

Comments

@olearycrew
Copy link
Contributor

Please describe your feature request:

We need to be clear about the expected format of using a cookie in headless mode. I believe it is:

katana -u "https://hackerone.com" -H 'cookie: ab={"x:{y}"}'

But we should be more clear about what the format is and what the parser expects.

@olearycrew olearycrew added the Type: Enhancement Most issues will probably ask for additions or changes. label Feb 20, 2023
@ehsandeep ehsandeep changed the title Add advice on using cookies Add advice / documentation in readme on using cookies Apr 8, 2023
@leveryd
Copy link

leveryd commented Apr 20, 2023

What this mean?

@Mzack9999
Copy link
Member

@olearycrew cookies use the standard format defined by RFC. There is no expected format besides the one required by the specific web app being crawled. @dogancanbakir, can you check if the docs need to be extended with examples of authenticated crawling?

@Mzack9999 Mzack9999 added Type: Maintenance Updating phrasing or wording to make things clearer or removing ambiguity. and removed Type: Enhancement Most issues will probably ask for additions or changes. labels May 28, 2023
@dogancanbakir
Copy link
Member

@Mzack9999 @olearycrew While it's indeed helpful to have as much detail and clarity in our documentation as possible, adding a specific section for using cookies in the README may not be necessary in this case. Since this usage is common across many tools and not unique to katana, it is typically expected that users would be familiar with it or can easily find information on it.

@dogancanbakir dogancanbakir added the Type: Question A query or seeking clarification on parts of the spec. Probably doesn't need the attention of all. label May 29, 2023
@olearycrew
Copy link
Contributor Author

I think we’ve seen this question many times in the community so I think we should consider documenting an example somewhere.

Perhaps @pd-jason and Carrie can weigh in here

@dogancanbakir
Copy link
Member

we’ve seen this question many times in the community

Then let's address it, on it!

@Sim4n6
Copy link

Sim4n6 commented Jun 3, 2023

Sorry to intervein, I asked that question on Discord if I remember.
It was not an ephemeral question, but rather something that requires a documentation update.

@ehsandeep ehsandeep linked a pull request Jun 3, 2023 that will close this issue
@ehsandeep ehsandeep added Status: Completed Nothing further to be done with this issue. Awaiting to be closed. and removed Type: Question A query or seeking clarification on parts of the spec. Probably doesn't need the attention of all. labels Jun 4, 2023
@ehsandeep
Copy link
Member

@ehsandeep ehsandeep added this to the katana v1.0.2 milestone Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Completed Nothing further to be done with this issue. Awaiting to be closed. Type: Maintenance Updating phrasing or wording to make things clearer or removing ambiguity.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants