AMCL is a cryptographic math library that we use in the login process for all clients, including Java, JavaScript, and Swift-based clients. It is also used on the server side in KeeperApp.
We have forked this project in order to maintain control over code updates.
We have created the keeper branch from the master branch. We will probably branch off of that for client releases. For example:
[Keeper AMCL fork]
master -- synchronized with the actual AMCL code
keeper -- our base branch
release_1.0.0 -- a version used by some clients
release_2.0.0 -- a version used by some clients
Inside AMCL we use their version3 code.
See the https://github.com/Keeper-Security/keeper-pythia-client project for the actual library versions you should use with Keeper processing.
To pull updates from our master branch into our keeper branch, run:
$ git checkout master
$ git pull
$ git checkout keeper
$ git merge master
$ git push
The master branch is often updated by the main AMCL developers. To pull changes into our master branch, first checkout our fork (this project).
Then, on your machine, run:
$ git checkout master
$ git pull https://github.com/miracl/amcl master
After resolving any merge conflicts push the changes to the master branch of our fork.
$ git add ...
$ git commit -m "Update from amcl project <date>"
$ git push
$ git push
After testing, merge changes into the 'keeper' branch as described above.
$ git checkout master
$ git pull
$ git checkout keeper
$ git merge master
$ git push
After that you probably want to make a new release branch from the keeper branch.
To rebuild all clients, run bash keeper/scripts/build-all.sh.
Run this command in the root directory of this project.
$ bash keeper-scripts/build-java.sh
The output will be a jar file in $AMCL/dist/java. Copy that file to the keeper-pythia-client project for testing and deployment.
$ bash keeper/scripts/build-js.sh
$ bash keeper/scripts/build-swift.sh