-
Notifications
You must be signed in to change notification settings - Fork 3
pydoc
hashit module for hashit command is contaning all the code for hashit
hashit is an hashing application which main purpose is to replace all the 'default' hashing commands that comes with linux and also provide a usable hashing program for windows hence the choice of using python. while hashit supports both python 2 and 3 i would strongly recommend using python3 because that python3 comes with a newer version of hashlib and therefore many new hash-functions, altough it is posible to add these into python2 with the load() function which acts like a 'connecter' and enables hashit to use third-party hashing-functions as long as the have the same api as specified in docs/index
The GLOBAL dict contains all the configurations for this program, translations, error messages settings, plugins and more.
algorithms is a list that contains all the builtin algorithms including crc32
LICENSE:
MIT License
Copyright (c) 2020 Javad Shafique
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
NO ONE CAN CLAIM OWNERSHIP OF THIS "SOFTWARE" AND ASSOCIATED DOCUMENTATION FILES.
fixpath(path)Fixpath converts the releative path into an absolute path and if needed can append the path to the snap host-filesystem which if the application is in devmode gives hashit access to the hole filesystem, if you're not in devmode and you're still using snap, then you will need sudo to access the intire system. Also replaces / with \ on windows
reader(filename, mode='r', comments=True, newlines=False)Creates generator for a file or stdin, better for larger files not part of the MEMOPT, so an standard reader for most uses. Works like readlines but instead of a list it creates an generator that sortof clean the input before it is parsed by something like BSD() or SFV().
SFV(self, filename=None, size=False)Class for parsing and creating sfv strings SFV() contains all functions needed for parsing, creating and formating SFV strings
BSD(self, filename=None, size=False)Parser for bsd and formater, also the same as SFV() but BSD() instead of sfv uses the bsd checksum output which is like this: hashname (filename) = hash [size]
eprint(*args, **kwargs)Prints to stderr usefull for warnings and error messages
supports_color()Returns True if the running system's terminal supports color, and False otherwise.
detect_format(hashstr, use_size=False)Autodetect hash format, by checking the length and what it contains
choose_hash(hash1, hashit, cli=True)Uses detect.decect to identify hashes with a high accuracy but when there if some issues it will take user input. CLI-only
new(hashname, data=b'')Custom hash-init function that returns the hashes depends on hashlib.new and GLOBAL["EXTRA"]. One of its' features is it's support for the python3 only shake-hash scheme were the default hash is shake_256 and the input is taken like this: shake_[amount of output]
load(hashclass)Add hashes to GLOBAL.EXTRA which is the dict that contains all the "extra" hash-functions such as Crc32, which allows external hashing algorithms to be used as long as the have the same api as specified in docs/README
returns True/False based on whether or not the data is loaded
load_all(list_of_hashclasses)Just for it, a function that loads all plugins in a list
hashIter(bytesiter, hasher, ashexstr=True)Will hash the blockIter generator and return digest
blockIter(afile, blocksize=65536)Will create a generator for reading a file
hashFile(filename, hasher, memory_opt=False)hashFile is a simple way to hash files using diffrent methods
check_files(file_read, hashit, first_line, sfv=False, size=False, bsdtag=False, dry_run=False)Will read an file which have a SFV compatible checksum-file or a standard one and verify the files checksum by creating an generator which loops over another generator which parses/reads the file and then it will check if the hash and optionally the size of the files matches the current state of them. For more info on how this work see docs/index#technical.
check(path, hashit, usecolors=False, be_quiet=False, detecthash=True, sfv=False, size=False, bsdtag=False, strict=False, trace=False, dry_run=False)Uses check_() to print the error messages and statuses corrent (for CLI) they are seperated so that you can use the python api, if you so please.
Command line application for hashit
this module "main" contains all the code for argparsing, running and anything needed for an command lin application such as hashit.
it uses argc another package by me, but i am considering switching to argparse
Print(self, nargs=0, **kwargs)Print action for argparse, takes one kwarg which is text the varible which contains the string to be printed
Execute(self, nargs=0, **kwargs)Same as Print() but instead of printing an object it calls it takes func (function), and exit (bool)
walk(go_over)Goes over a path an finds all files, appends them to a list and returns that list
exclude(items, excludes)Exclude removes all items in a list that is in the excludes list (for dirs)
config(parser)Sets argvs' config and commands with argparse and returns it for good sake
main_(args)Main function which is the cli parses arguments and runs appropriate commands
main(args=None)Main function with error catching, can force-exit with os._exit(1)
this main function calls main_() and cathes any error while giving the user some "pretty" errors.
Copyrigth (c) 2020-present Javad Shafique
this module using length and connections to find a match for an hashing algorithem. It's basicly a matching algorigtem it can be used for almost any pure function in this case for hashes.
Copyright (c) 2020-present Javad Shafique
This 'Software' can't be used without permission
from Javad Shafique.
this module using length and connections to find a match
for an hashing algorithem. It's basicly a matching algorigtem
it can be used for almost any pure function in this case for hashes.
basic template:
def generate_some_dataset(datatoworkon = "some data"): dict_for_storing_set = dict()
for each_element in a_list_of_something_to_compare_with:
data = function_that_uses_data_to_generate_something(each_element, datatoworkon)
dict_for_storing_set.update({each_element:{"data":data, "size":len(data), "size-as":list(), "connection":list()}})
`find` connection and size
for each_element in dict_for_storing_set:
elements_data = dict_for_storing_set[each_element]["data"]
elements_size = dict_for_storing_set[each_element]["size"]
for second_element in dict_for_storing_set:
if dict_for_storing_set[second_element]["size"] == elements_size:
if elements_data == dict_for_storing_set["data"]:
dict_for_storing_set[each_element]["connection"].append(second_element)
else:
dict_for_storing_set[each_element]["size-as"].append(second_element)
else:
continue
# return finished dataset
return dict_for_storing_set
and for parsing that infomation
you can use the detect function
as here:
def detect(string, table, maybe = True): if not (type(string) == str): return None
so = list()
so_far = list()
length = len(string)
for key in table:
dat = table[key]
if dat["size"] == length:
for i in dat["connection"]:
if i not in so_far:
so_far.append(i)
for i in so_far:
dat = table[i]["connection"]
for j in so_far:
if not j in dat:
so_far.remove(j)
if maybe:
for key in table:
dat = table[key]
if dat["size"] == length:
so.append(key)
if len(so_far) >= 0 and len(so) == 1:
# if there only is one option then use it
return tup(certain=so, maybe=[])
else:
return tup(certain=so_far, maybe=so)
compare hashes for hash-detection
it can generate data that can compare
diffrences between the results
if works by categorizing the hashes into
two categorizes. one for thoose who look alike
and one for thoose who generates the same output
given the same input. And with it a sorted result
is outputted and is ready to be used be the user.
list of which algorithms is most likly used (WIP)
PRIORITY = { "md5":["md5"], "sha1":["dsaEncryption", "DSA", "ecdsa-with-SHA1", "dsaWithSHA", "DSA-SHA"] }
Closest(self, /, *args, **kwargs)Closest(certain, maybe)
ishex(hexstr)Checks if string is hexidecimal
generate_data_set(hashon, algos, hasher_that_takes_new)Generates dataset based on data and list of strings that can be used to create objects to use that data
detect(s, table, maybe=True)Compares result from datasets, finds connections and eleminates contestants
Extra functions and classes for hashit
Crc32(self, data=b'')This class is an api for the crc32 function that is compatible with mor
shake(self, hashn, data=b'')Top-level api for hashlib.shake