PhoenixPassword

The PhoenixPassword generator gem is intended to be used in password recovery operations or random password generation purposes.

You can also use the godian generator written in C.

Add this line to your application's Gemfile:

gem 'phoenix_password'

And then execute:

$ bundle

Or install it yourself as:

$ gem install phoenix_password

In order to generate combinations simply add the minimum of the required options here is an irb example:

irb(main):001:0> require 'phoenix_password'
=> true
irb(main):002:0>  PhoenixPassword.new.combinations({:piped=>true,:type=>'matching',:cmb_length=>[6],:characters=>[0,1,2,3,4,5,6,7,8,9]})

001273

001274

001275

.....

This is a list of the options available to you and what they do

obj_a=PhoenixPassword.new() 
obj_b=PhoenixPassword.new({:rules=>true})
obj_c=PhoenixPassword.new({:rules=>true,:stricness=>2})
obj_d=PhoenixPassword.new({:rules=>true,:stricness=>2,:own_rules=>[/regexp_a/,/regexp_b/]})

You can initialize a PhoenixPassword object in 4 different ways.

a)No arguments: This means that there will be no extra combination restriction rules other than the ones defined in the combinations method.

obj_a=PhoenixPassword.new()

b)rules By setting rules to true there is an extra combination filter added, namely any combinations that have alternating letter digit value get discarded: 0a0a0a or a0a0a0 etc.

obj_b=PhoenixPassword.new({:rules=>true})

c)strictness

obj_b=PhoenixPassword.new({:rules=>true,:stricness=>2})

When using rules you can also change the strictness level of combination filtering.By default it is set to 0 meaning no other combinations will be filtered other than what rules filters on its own.

When using a level say 2 you are implementing the filters provided by 0,1 and 2.If you use 3 the you use 0,1,2 and 3 filters.

There are 4 levels in total: X=digit,A=letter

Level 0: default filtering XAXAXA or AXAXAX

Level 1: Filters combinations that are half digits or half letters XXXAAA or AAAXXX.

Level 2: Filters combinations that have only digits XXXXXX

Level 3: Filters combinations that have only letters AAAAAA

d)own_rules

obj_d=PhoenixPassword.new({:rules=>true,:stricness=>2,:own_rules=>[/regexp_a/,/regexp_b/]})

If you want to use your own combination filtering rules you must use the own_rules key and add an array with Regexp objects.

The rules that you will add will be implemented after all the rules that are used by the strictness level have been checked.Make sure when using your rules that you don't filter twice things that have been already checked.

==================================================================================================

Checkpoint and Restore

In order to be able to use the checkpoint functionality it is required that you have mysql database and mysql2 gem installed.

If don't want to change the settings that are provided by default, you will have to do the following steps in you database:

a)Create a database called phoenix_password

create database phoenix_password

b)Grant all privileges on that database to a user named phoenix,with the password Gordian100!

grant all privileges on phoenix_password.* to 'phoenix'@'localhost' identified by 'Gordian100!';

c)Create a checkpoint table in the phoenix_password database as follows

create table checkpoint ( id int not null auto_increment primary key,combination varchar(200) not null,chars_used varchar(255) not null,i bigint unsigned not null);

d)Insert a row in the checkpoint table

insert into checkpoint (combination,chars_used,i) values ('000000','00000',0);

You can customize the settings if you want but you must change the phoenix_password.rb file accordingly.

Checkpoint

PhoenixPassword.new({:checkpoint=>true,:check_fraction=>2,:check_cmb=>7})

check_cmb:

Is to be used when you want to set a checkpoint in a specific combination length when generating multiple length combinations. Example:

PhoenixPassword.new(:checkpoint=>true,:check_cmb=>7,:check_fraction=>4).combinations({:piped=>false,:type=>'matching',
:characters=>[0,1,2,3,4,5,6,7,8,9],:cmb_length=>[6,7,8]})

check_fraction:

Is optional if not set it's by default set to 2 meaning 1/2 of the total combinations.You can set it to a greater value if you want to create checkpoint sooner, a vale of 4 will mean that when about 1/4 of the total combinations is tested a checkpoint is set and the program exits.I recommend that you use even numbers as a check_fraction value.

If you are dealing with an odd number of total combinations say 11^6=1771561 using the 2 fraction will result in you having to do three iterations of the program before you get the full amount of combinations:

1)1771561/2=885780,5 rounded to_i 885780 = %49.99

2)1771561/2=885780,5 rounded to_i 885780 = %49.99

3)1771561-1771560=1 1/1771561 = %0.000000564

Restore

PhoenixPassword.new(:restore=>true)

PhoenixPassword.new(:restore=>true,:checkpoint=>true,:check_fraction=>4)

PhoenixPassword.new(:restore=>true,:restore_cmb=>7,:checkpoint=>true,:check_cmb=>7,:check_fraction=>4)

In order to restore you must use the same file name as when the checkpoint was set,since the new combinations will be appended to it.

restore_cmb:

Is to be used when restoring from a multiple combination process.In the previous example in order to do a proper restore you must set restore_cmb=>7 as that will discard all of the 6 length combinations.

You can use restore and checkpoint at the same time resulting in resuming from where you left off and creating a new checkpoint when the check_fraction is met here is an example:

PhoenixPassword.new(:checkpoint=>true,:check_cmb=>7,:check_fraction=>4)

PhoenixPassword.new(:restore=>true,:checkpoint=>true,:check_fraction=>4)

When operation has finished you should have about 2/4 of the total combinations.

You can restore and set checkpoint in a multi combination as well.

PhoenixPassword.new(:checkpoint=>true,:check_cmb=>7,:check_fraction=>4)

PhoenixPassword.new(:restore=>true,:restore_cmb=>7,:checkpoint=>true,:check_cmb=>7,:check_fraction=>4)

If you continue to restore you will be notified when all the combinations have been generated and how to change to the next combination length.

==================================================================================================

:piped=>(true or false)

Lets you decide whether you want to pipe the results to an other program or write them to a file.

:cmb_length=>([5] or [5,6])

Set the length of the possible combinations to be generated if there is more than one value first all the combinations with the starting value are generated and then once done combinations of the following length are generated till all the values have been used.

:characters=>["e","x","m","p","l","e",1]

Sets the characters that will be used in the combination generation process.

:extra_chars=>["x",1] (Optional)

Set extra characters to be used one at a time if the initial characters,minimum value 1 char. Note that when etxra_chars are used only combinations that include them will be written to file.

:type=>("matching","unique","all")

Sets which type of combinations to be generated. Matching: Characters repeating them selves any number of times xx or xxx Unique:Characters are different in every position xz or xzx All: Creates all possible combinations, note that you can't use any rules when using "all".

:match_limit=> 2 (:optional)

Set the max matching characters for each combination example:

2 = xxabc, axxbc,abxxc,abcxx

3 = xxxab, axxxb,abxxx

Note that you can set the limit to more than 3 but file size info will not be accurate.

:skip_first=>(true |false) (Optional)

Used with extra_chars allows you to skip the first iteration with the main characters thus starting from the extra characters.Useful if you want to continue from where you left off.

:uniqueness_type=>("repeat"|"singe") (Optional)

If not set all possible unique combinations are generated i.e reappearing char xzx,single char xyz When set to repeat only reappearing character combinations are generated xzx When set to single only single character appearance combinations are generated xzy.

:cap_limit=>1 or more (optional)

When used it ensures that each combination generated will contain only the amount of capital letters specified.

Note that file size and combination estimates when using match_limit may not be accurate

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/phoenix_password. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.