update api documentation

[Darkcast]

update the documentation to reflect the correct way of setting up the apis keys

An example provider config file -

binaryedge:
  - 0bf8919b-aab9-42e4-9574-d3b639324597
  - ac244e2f-b635-4581-878a-33f4e79a2c13
censys:
  - ac244e2f-b635-4581-878a-33f4e79a2c13:dd510d6e-1b6e-4655-83f6-f347b363def9
certspotter: []
passivetotal:
  - [email protected]:sample_password
securitytrails: []
shodan:
  - AAAAClP1bJJSRMEYJazgwhJKrggRwKA
github:
  - ghp_lkyJGU3jv1xmwk4SDXavrLDJ4dl2pSJMzj4X
  - ghp_gkUuhkIYdQPj13ifH4KA3cXRn8JD2lqir2d4

[ehsandeep]

@Darkcast thank you, could you please point out what's the difference in the existing example shared in readme?

[ipk1]

is ti possible to get the format on how to use the API keys? some of them are straight forward, some such as zoomeye and zoomeyeapi are confusing atleast for me
[DBG] API key(s) found for binaryedge.
[DBG] API key(s) found for c99.
[DBG] API key(s) found for censys.
[DBG] API key(s) found for certspotter.
[DBG] API key(s) found for chaos.
[DBG] API key(s) found for dnsdb.
[DBG] API key(s) found for fofa.
[DBG] API key(s) found for github.
[DBG] API key(s) found for intelx.
[DBG] API key(s) found for passivetotal.
[DBG] API key(s) found for securitytrails.
[DBG] API key(s) found for shodan.
[DBG] API key(s) found for threatbook.
[DBG] API key(s) found for virustotal.
[DBG] API key(s) found for zoomeye.
[DBG] API key(s) found for zoomeyeapi.
[DBG] Selected source(s) for this search: crtsh, certspotter, chaos, intelx, sitedossier, threatminer, whoisxmlapi, fullhunt, riddler, c99, hackertarget, chinaz, github, zoomeyeapi, commoncrawl, dnsrepo, quake, virustotal, censys, securitytrails, dnsdumpster, waybackarchive, bevigil, anubis, rapiddns, shodan, binaryedge, threatbook, passivetotal, robtex, dnsdb, fofa, bufferover, alienvault, zoomeye
[INF] Enumerating subdomains for '8x8staging.com'
[DBG] Cannot use the 'quake' source because there was no API key/secret defined for it.
[DBG] Cannot use the 'dnsrepo' source because there was no API key/secret defined for it.
[DBG] Cannot use the 'bevigil' source because there was no API key/secret defined for it.
[DBG] Cannot use the 'robtex' source because there was no API key/secret defined for it.
[DBG] Cannot use the 'fofa' source because there was no API key/secret defined for it.
[DBG] Cannot use the 'bufferover' source because there was no API key/secret defined for it.
[DBG] Cannot use the 'zoomeye' source because there was no API key/secret defined for it.
[DBG] Cannot use the 'intelx' source because there was no API key/secret defined for it.
[DBG] Cannot use the 'whoisxmlapi' source because there was no API key/secret defined for it.
[DBG] Cannot use the 'fullhunt' source because there was no API key/secret defined for it.

[forgedhallpass]

zoomeye requires a composite secret key which consists of a zoomeye username and a password. Such secrets are expected to be separated using a : (colon).

e.g. myzoomeyeusername:myzoomeyepassword

zoomeyeapi should work the same as any other providers, as it requires a a simple API key.

In the provider_config.yaml file you can define multiple secrets/keys for all sources and subfinder will use them randomly.

Example:

provider_with_simple_key:
  - secret1
  - secret2
provider_with_composite_key:
  - secret1_part1:secret1_part2
  - secret2_part1:secret2_part2

Also please see the Post installation instructions in the README.

For sources that require multiple keys, namely Censys, PassiveTotal, they can be added by separating them via a colon (:).

That being said, we could add a new method in the Source interface that would describe additional information about the every provider when the -debug flag or an increased log level is used. What do you think @ehsandeep?