Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eniac/faas

Factoring as a Service
https://github.com/eniac/faas

Last synced: 3 days ago
JSON representation

Factoring as a Service

Awesome Lists containing this project

README 

        
# FaaS

The purpose of the FaaS (Factoring as a Service) project is to demonstrate that 512-bit integers can be factored in only a few hours, for less than $100 of compute time in a public cloud environment.  This illustrates the amazing progress in computing power over time, and the risk of continued use of 512-bit RSA keys.



Please do not use these scripts to attack any systems that you do not own.



Our scripts launch a compute cluster on Amazon EC2 and run the [CADO-NFS](http://cado-nfs.gforge.inria.fr/) and [Msieve](http://sourceforge.net/projects/msieve/) implementations of the number field sieve factoring algorithm, with some improvements to parallelization. For more information about the project, see [our paper](http://seclab.upenn.edu/projects/faas/faas.pdf).



# Quick Start Guide

This section shows you how to quickly get set up to factor. 



### Set up command machine (e.g., your workstation)

Set up and configure AWS CLI using these [instructions](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html). We recommend version 1.7.15 or higher. Make sure that your ~/.aws/config looks like



```

[default]

region = 

output = json

```



and your ~/.aws/credentials looks like



```

[default]

aws_access_key_id = 

aws_secret_access_key = 

```



Install Ansible using these [instructions](http://docs.ansible.com/ansible/intro_installation.html#installation). Some older versions of Ansible do not work so we recommend version 1.9.2 or higher. Configure Boto (python interface to AWS) using these [instructions](https://github.com/boto/boto). We recommend Boto version 2.38.0 or higher. Make sure your ~/.boto config looks like



```

[Credentials]

aws_access_key_id = 

aws_secret_access_key = 

```

 

Disable host key checking for Ansible hosts if you understand the security risks. Edit ~/.ansible.cfg to add the following lines:



```

[defaults]

host_key_checking = False

```



Install GNU Parallel using these [instructions](http://www.gnu.org/software/parallel/).



### Go to the ec2 directory (some of our scripts use relative paths)



```bash

>$ cd ec2

```



### Download Ansible EC2 dynamic inventory scripts

The scripts are available [here](http://docs.ansible.com/ansible/intro_dynamic_inventory.html#example-aws-ec2-external-inventory-script), and you can download them with the following commands:

```bash

>$ wget https://raw.githubusercontent.com/ansible/ansible/devel/contrib/inventory/ec2.py

>$ chmod +x ec2.py

>$ wget https://raw.githubusercontent.com/ansible/ansible/devel/contrib/inventory/ec2.ini

```



Set the following values in ec2.ini.



```

regions =   # you can leave this as 'all', but the script runs more quickly with a single region

cache_max_age = 0       # we want to always see the most up-to-date info about running instances, so do not cache

rds = False             # if your AWS user does not have rds permissions

elasticache = False     # if your AWS user does not have elasticache permissions

```



### Configure AWS (Amazon Web Services) environment

The following script will create a new AWS VPC (Virtual Private Cloud) configured for FaaS. 



```bash

>$ ./configure-aws.py

```



### Set custom values for your setup in vars/custom.yml using your favorite text editor.



```bash

>$ vim vars/custom.yml

```



### Build a base AMI

Use the following script to build a base AMI, which can take up to an hour to run. If the script fails halfway through (e.g., if you lose a connection to the instance), you can re-run it and it will skip any steps that have already been completed.



```bash

>$ ./build-base.sh

```



### Optional: Run test factorization

To check that your AWS environment is correctly configured, we recommend that you run a small test factorization. Our test script will build a custom AMI for the test factorization, launch a cluster of four m4.large nodes, and factor a 100-digit number. The entire process should cost less than a dollar in EC2 credit, but will hopefully help you debug any issues with cluster setup. We recommend that you run the commands in the script one by one.



```bash

>$ ./test-factor.sh

```



### Run factorization

The following script will build a new AMI, launch a cluster, and factor the 512-bit integer that you specified in vars/custom.yml. We recommend that you run the commands in the script one by one. After you've already built a custom AMI, it is no longer necessary to build a new AMI for each 512-bit factorization, so you may wish to comment out the first few lines. NOTE: You should not use the AMI built in test-factor.sh for 512-bit factorizations. Make sure that you terminate any instances with the tags 'faas_master', 'faas_slave', or 'faas_mpi' that might be left over from a previous run before running this script.



```bash

>$ ./factor.sh

```



### Collect results

If all goes to plan, you will recieve an email with the results of the factorization. However, this is research code, and things do not always go as planned :).  Some email providers may mark the result email as spam, and prevent its delivery.



By default, the master node will be stopped (not terminated) after the factorization has completed so that the relevant log files will not be deleted. This will continue to use resources on your Amazon account until the node is terminated. 



The relevant log files are in the following locations on the master node:

    

```

/home/ubuntu/server.stderr          # the supervisor output file. You can watch the factorization live with 'tail -f server.stderr'.

/workdir//.log  # the faas log file

/workdir//.cmd  # the commands executed by the factoring script

/var/log/slurm/slurmctld.log        # the Slurm controller daemon log file

```



Good luck!