1042112 - [b2ghaystack] add ability to read arguments from file

Status: RESOLVED INCOMPLETE

(Testing :: General, defect)

Description

[Dave Huseby [:huseby]]

currently, b2ghaystack requires you to type your password as a command line parameter.  this is bad because your password goes into command history files.  a more secure option is to put your password in a file that only you have read access to and then tell b2ghaystack to use the password in the file.

Comment 1

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Julien: Is this something you might be interested in working on?

Comment 2

[Dave Huseby [:huseby]]

I thought about this more.  I'd prefer if we added support for a config file.  The b2ghaystack script should first search the user's home directory, then the /etc directory for a config file that contains the username and passphrase.  The command line switches for username and passphrase should override the config values.  And, I want a command line switch for specifying a passphrase file.

0. Use command line username and passphrase switches.
1. If #0 doesn't exist, search for: $HOME/.b2ghaystack
2. If #1 doesn't exist, then search for: /etc/b2ghaystack.conf
3. Output error that username and passphrase must be specified.

Comment 3

[Mark Capella [:capella]]

Assigning sagar as requested ... sagar: you can post questions to the bug mentor in here now

Comment 4

[Sagar Pandey]

Thank You Mark.Dave: How do you suggest I should get started with this ?

Comment 5

[Dave Hunt [:davehunt] [he/him] ⌚BST]

b2ghaystack uses argparse. It looks like this has a feature that can read arguments from a file, but is disabled by default. We could enable this and even add the file to the list of arguments if it exists. 

To work on this you would need to fork and clone the github repository at https://github.com/mozilla/b2ghaystack and the changes would likely go at the very start of the `cli` function: https://github.com/mozilla/b2ghaystack/blob/38eeb3b4200f660a9bbffd9cb5c5075e38627120/b2ghaystack/b2ghaystack.py#L131

Here's the argparse feature that allows reading arguments from file:
https://docs.python.org/2/library/argparse.html#fromfile-prefix-chars

Here's an example of automatically using a file if it exists: http://stackoverflow.com/a/7789081/154975

Dave: Would this meet your needs?

Comment 6

[Julien Pagès (:parkouss)]

Hi Dave,

Sorry for the delay, I was in holidays this week. :)

Apparently this bug is now assigned. Thank you for the proposal, I will take another one next time!

Comment 7

[Sagar Pandey]

Dave : Okay. I will get on it right away.

Comment 8

[Sagar Pandey]

Dave : I have pushed the new edited code in my forked repo . What next ?

Comment 9

[Julien Pagès (:parkouss)]

Hi sagar,

I think you can create a pull request and add an attachment to this bug as described here: http://globau.wordpress.com/2013/10/21/github-pull-requests-and-bugzilla/.

Don't forget to add  Dave on the review field, with the "?" selected.

Dave will then review your patches then merge the code.

Hope this helps!

Comment 10

[Sagar Pandey]

Attachment: Enable b2ghaystack to take password argument from file

Comment 11

[Sagar Pandey]

Thanks a lot Julien . It was of great help .

Comment 12

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Comment on attachment 8462956 [details] [review]
Enable b2ghaystack to take password argument from file

A good start, however the file can support more than just the password, so we should make that clear in the code. I included a couple of comments about code style, where we usually adhere to PEP 8. You might want to run your code through a pep8 checker before submitting your next patch.

Unfortunately b2ghaystack currently requires access to our private builds, so it's difficult for you to test your changes. You should at least be able to run it until the authentication error though, which will allow you to test influencing the arguments by using a configuration file.

Comment 13

[Sagar Pandey]

Thanks a lot Dave . I am on it.

Comment 14

[Sagar Pandey]

Attachment: Applied review suggestions .

Comment 15

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Comment on attachment 8463344 [details] [review]
Applied review suggestions .

Check pull request for comments. Also, could you add a note to the README about the b2ghaystack.conf file?

Comment 16

[Sagar Pandey]

Yes, Sure . I am on it .

Comment 17

[Sagar Pandey]

Attachment: Applied Second Review

Hopefully it will work just fine .

Comment 18

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Comment on attachment 8463344 [details] [review]
Applied review suggestions .

Don't forget to mark previous patches as obsolete, however if you're using the same github pull there's no need to attach a new patch. You can just flip the review flag from - to ?

Comment 19

[Sagar Pandey]

Right Dave . I will definitely keep this in mind in future instances .

Comment 20

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Comment on attachment 8464854 [details] [review]
Applied Second Review

This looks okay to me. Dave: could you confirm this works for you?

Comment 21

[Sagar Pandey]

Any instructions for me Dave ?

Comment 22

[Dave Hunt [:davehunt] [he/him] ⌚BST]

(In reply to Sagar Pandey from comment #21)
> Any instructions for me Dave ?

I'm just waiting on the reporter of this bug to confirm this addresses their request. Once this is confirmed I will go ahead and merge your patch. For now there's nothing for you to do. Thanks.

Comment 23

[Sagar Pandey]

Alright , Thanks :)

Comment 24

[Dave Huseby [:huseby]]

I'm neck deep in some high priority privacy stuff and unable to test this out.

Comment 25

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Closing this as incomplete. The patch is fine, but I don't believe this tool is being used anymore.

Comment 26

[Sagar Pandey]

So , Is it now confirmed ? Working fine right ?

Comment 27

[Dave Hunt [:davehunt] [he/him] ⌚BST]

(In reply to Sagar Pandey from comment #26)
> So , Is it now confirmed ? Working fine right ?

The patch was fine Sagar, however the feature is no longer needed as the application is not being used. Thank you for your contribution, and I hope that you can find another bug to work on.