Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix documentation markdown #49

Merged
merged 2 commits into from
Apr 27, 2020
Merged

fix documentation markdown #49

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94d54ae
fix documentation markdown
PhilETaylor Oct 13, 2019
af9e847
Update README.md
PhilETaylor Oct 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#DoctrineEncryptBundle
#D octrineEncryptBundle
PhilETaylor marked this conversation as resolved.
Show resolved Hide resolved

Bundle allows to create doctrine entities with fields that will be protected with
help of some encryption algorithm in database and it will be clearly for developer, because bundle is uses doctrine life cycle events
Expand All @@ -10,7 +10,7 @@ I improved several things, i make better use of the doctrine events. and it work
This will be an long term project we will be working on with long-term support and backward compatibility. We are using this bundle in all our own symfony2 project.
More about us can be found on our website. [Ambta.com](https://ambta.com)

###What does it do exactly
### What does it do exactly

It gives you the opportunity to add the @Encrypt annotation above each string property

Expand All @@ -24,19 +24,19 @@ protected $username;
The bundle uses doctrine his life cycle events to encrypt the data when inserted into the database and decrypt the data when loaded into your entity manager.
It is only able to encrypt string values at the moment, numbers and other fields will be added later on in development.

###Advantages and disadvantaged of an encrypted database
### Advantages and disadvantaged of an encrypted database

####Advantages
#### Advantages
- Information is stored safely
- Not worrying about saving backups at other locations
- Unreadable for employees managing the database

####Disadvantages
#### Disadvantages
- Can't use ORDER BY on encrypted data
- In SELECT WHERE statements the where values also have to be encrypted
- When you lose your key you lose your data (Make a backup of the key on a safe location)

###Documentation
### Documentation

This bundle is responsible for encryption/decryption of the data in your database.
All encryption/decryption work on the server side.
Expand All @@ -49,15 +49,15 @@ The following documents are available:
* [Console commands](https://github.com/ambta/DoctrineEncryptBundle/blob/master/Resources/doc/commands.md)
* [Custom encryption class](https://github.com/ambta/DoctrineEncryptBundle/blob/master/Resources/doc/custom_encryptor.md)

###License
### License

This bundle is under the MIT license. See the complete license in the bundle

###Versions
### Versions

I'm using Semantic Versioning like described [here](http://semver.org)

###Todos
### Todos

The following items will be done in order

Expand Down