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

Proposed JSON Schema Changes for Discussion #738

Closed
WebBreacher opened this issue Jul 27, 2023 · 7 comments
Closed

Proposed JSON Schema Changes for Discussion #738

WebBreacher opened this issue Jul 27, 2023 · 7 comments
Assignees

Comments

@WebBreacher
Copy link
Owner

WebBreacher commented Jul 27, 2023

There are several bigger changes to the JSON file I have not moved on recently and I want to put them in one place and discuss and then act.

  1. Invalid char in username for some sites Invalid char in username for some sites #673 - Add an optional strip_bad_char parameter with a value of whatever characters cause issues. For instance, if a period (.) causes problems, that line would be "strip_bad_char" : ".",. Whatever characters are in that field would be removed from the username prior to making the request to the destination site.
  2. Change the category XXXPORNXXX to xx NSFW xx to reflect that not all NSFW (Not Safe For Work) sites are pornographic in nature.
  3. Change valid parameter to optional
  4. Remove all valid=True entries. Only time we will use the valid parameter would be when we want to temporarily turn off a site. otherwise checkers will assume that if no valid parameter is present then valid=True.

I'm looking for feedback until Thursday, August 17, 2023. At that point, we will move forward with the changes or what has been decided in this issue.

@WebBreacher WebBreacher self-assigned this Jul 27, 2023
WebBreacher added a commit that referenced this issue Jul 27, 2023
- Remove valid=true
- change XXXPORNXXX to xx NSFW xx
- Only keep contributors that have done something from 2022 until present day.
- removed whitespace
- removed funding.yml file as only 1 person ever used it
- Sorted readme tools section
- Removed Twitter from readme
@swedishmike
Copy link
Contributor

Looks good to me - will just have to change validation of 'valid' a bit and that's not a biggie.

@C3n7ral051nt4g3ncy
Copy link
Contributor

Looks good!
Once the JSON is modified, I will then modify it also for my tool.

@AccentuSoft
Copy link
Contributor

AccentuSoft commented Aug 2, 2023

Not sure about point 1. Having an optional bad_chars (or valid_chars) field where required seems like a better solution that a binary choice of restricting users to that set.

While it may not matter at this point, I think the flexibility could be important down the line to handle edge cases, i.e. where sites allow only certain special characters. If I am looking for !_john.smith_! for example, and one of the sites does not allow dots, is it not preferable to search for !_johnsmith_! rather than johnsmith?

Alternatively, if '.' is the only character that causes issues as discussed in #673, the invalid char field could just be about stripping the dot. That way we preserve other special characters. This also allows users to get output that matches their original input as closely as possible; for example, if someone puts in !johnsmith! vs johnsmith. The user can always run the second query if the first does not give any results, but if we always strip all special characters, then the user will never get any results that only match the first query.

All other points are great.

@WebBreacher
Copy link
Owner Author

I see your points @AccentuSoft. It'd be simple to change the boolean T/F value to "insert the characters that cause issues for this site". I do see it as more complete and customizable too. Will make the change to the proposed list above. Thanks.

@TURROKS
Copy link
Contributor

TURROKS commented Aug 6, 2023

Looks good to me as well. I would need to slightly modify the code to account for the change on the valid parameter, but other than that, it should be fine. Thanks for the heads up Micah.

WebBreacher added a commit that referenced this issue Aug 17, 2023
WebBreacher added a commit that referenced this issue Aug 17, 2023
@WebBreacher
Copy link
Owner Author

This has been completed.

smicallef added a commit to smicallef/spiderfoot that referenced this issue Aug 18, 2023
@smicallef
Copy link

SpiderFoot has been updated to reflect this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants