InQuest / ThreatIngestor

Extract and aggregate threat intelligence.
https://inquest.readthedocs.io/projects/threatingestor/
GNU General Public License v2.0
821 stars 135 forks source link

Clarify Twitter Credentials #67

Closed TacticalCheerio closed 5 years ago

TacticalCheerio commented 5 years ago

The Twitter credentials in the config.yml and documentation can be more clear:

Instead of the current

- name: twitter-auth
    # https://dev.twitter.com/oauth/overview/application-owner-access-tokens
    token:
    token_key:
    con_secret_key: 
    con_secret: 

This would be more clear, as it uses the same terms and order of keys that Twitter presents

- name: twitter-auth
    # https://dev.twitter.com/oauth/overview/application-owner-access-tokens
    api_key:
    api_key_secret:
    access_token: 
    access_token_secret: 
rshipp commented 5 years ago

Thanks for the issue!

I definitely agree that the credential names are confusing, I've mixed them up a lot myself. Where did you see these names you suggested? I think the names we're currently using are just taken from the Python Twitter library we're using. If there are more standardized names Twitter is using in their UI / docs, I'm happy to update our config keys and docs to use that.

TacticalCheerio commented 5 years ago

When you go to generate the credentials (App > Details > Keys and Tokens) it displays the terms there:

4gc6AmcbjX

rshipp commented 5 years ago

Perfect, thank you! I'll get this updated and put in some kind of message to help people migrate their config over.

rshipp commented 5 years ago

Alright, I''ve pushed version 1.0.0b5 to address this. I used a slightly different key name for one of the credentials (api_secret_key instead of api_key_secret) to better match the language Twitter uses in the app details.

Migration notes are here: https://github.com/InQuest/ThreatIngestor/releases/tag/v1.0.0b5.

Let me know if you run into any problems migrating your config, or if anything else comes up!