Go to file
Donal McBreen 1d996ee059 Fix binary decryption on Postgres
When encrypting attributes we need to do it just before inserting the
data into the database, so after any other serialization steps, e.g. for
serialized types or normalization. And we need things to happen in
reverse order when decrypting.

With attribute decoration we end up with types nested in other
types. To ensure that the encryption happens in the right place, the
EncryptedAttributeType first serializes the value with the type it is
wrapping and then encrypts it. And in reverse it decrypts then
deserializes with the wrapped type.

There's an assumption here, which is that the wrapped type doesn't need
to do anything in between the database and the encryption layer - so
any database specific casting is skipped.

This works fine for String columns as there's nothing for them to do. It
also works for binary columns for MySQL and SQLite. But is doesn't for
PostgreSQL which needs to receive the data as Binary::Data and has to
call `PG::Connection.unescape_bytea` when deserializing the data.

The serialization part was fixed in https://github.com/rails/rails/pull/50920,
where the encryption output is wrapped in Binary::Data, which let's the
PostgreSQL adapter know to convert the value
[here](5a0b2fa5a3/activerecord/lib/active_record/connection_adapters/abstract/quoting.rb (L83)).

That PR however didn't fix deserializing the data when it comes back out
of the database (it wasn't round-tripping the data properly in the
tests).

We need to deserialize binary types before decrypting them - and we'll
have to just assume that the wrapped type can do that for us.

This won't work for serialized types as they'll also attempt to convert
the data with the coder which needs to happen after decryption, so we
need to special case them and extract the subtype instead.

This isn't ideal but it should work ok for all built in types.
2024-08-28 09:12:16 +01:00
.devcontainer Upgrade devcontainer to use ruby 3.3.4 2024-07-09 10:25:16 +05:30
.github No need to remove docker-compose anymore on the smoke test 2024-07-31 21:33:57 +00:00
actioncable Remove `private` call 2024-08-19 18:12:49 +02:00
actionmailbox Fix Action Mailbox assuming request.body present 2024-08-21 19:56:34 +00:00
actionmailer Deprecate hash key path mapping 2024-07-31 01:41:46 -05:00
actionpack Merge pull request #51927 from collimarco/patch-1 2024-08-27 14:26:44 -03:00
actiontext Merge pull request #52680 from MatheusRich/action-text-attachment-events 2024-08-26 21:20:59 -03:00
actionview Remove redundant requires 2024-08-23 20:22:46 +02:00
activejob Merge pull request #52468 from heka1024/available-processor-count-in-async-adapter 2024-08-02 14:34:23 +02:00
activemodel Permit frozen models to be validated (#47969) 2024-08-16 08:24:39 -07:00
activerecord Fix binary decryption on Postgres 2024-08-28 09:12:16 +01:00
activestorage Dispatch direct-upload events on attachment uploads 2024-08-26 16:15:35 -03:00
activesupport class_attribute: reduce reliance on define_method 2024-08-27 17:31:00 +02:00
guides Merge pull request #52669 from maximerety/fix-rspec-rails-issue-2779 2024-08-27 14:09:33 -03:00
railties Merge pull request #52266 from Shopify/mariadb-options 2024-08-27 17:31:20 -03:00
tasks Fix release task 2024-08-09 23:49:56 +00:00
tools Revert "Remove deprecated support for the pre-Ruby 2.4 behavior of `to_time`" 2024-06-02 23:52:59 +09:30
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore Ignore tarball from rake preview_docs 2024-05-01 08:05:42 +09:00
.mdlrc Introduce markdownlint for guides 2023-03-27 12:14:18 +09:00
.mdlrc.rb Introduce markdownlint for guides 2023-03-27 12:14:18 +09:00
.rubocop.yml Remove redundant requires 2024-08-23 20:22:46 +02:00
.yardopts Updating .yardopts to document .rb files in [GEM]/app 2019-08-20 13:25:36 -04:00
.yarnrc Make Webpacker the default JavaScript compiler for Rails 6 (#33079) 2018-09-30 22:31:21 -07:00
Brewfile chore: update Brewfile per renaming postgresql Formula 2024-05-23 13:47:57 +00:00
CODE_OF_CONDUCT.md Trim trailing whitespace from *.md files 2022-12-17 15:27:51 -08:00
CONTRIBUTING.md Replace outdated links with correct links 2023-12-17 13:39:05 +09:00
Gemfile Use the new SQLite3::Database#busy_handler_timeout= method for a non-GVL-blocking, fair retry interval busy handler implementation 2024-08-16 13:56:24 +02:00
Gemfile.lock Bump minitest to 5.25.1 and clean up hacks for minitest 5.25.0 2024-08-16 11:28:19 -07:00
MIT-LICENSE Remove Copyright years (#47467) 2023-02-23 11:38:16 +01:00
RAILS_VERSION Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
README.md Add markdown codehighlight for bash script 2024-01-04 00:30:50 +05:30
RELEASING_RAILS.md Update Twitter account name in release documentation to X 2024-08-06 09:52:39 +05:30
Rakefile Add support for fast smoke tests. 2024-06-12 16:51:26 +09:00
package.json chore: remove webpack from yarn dependencies in Rails dev 2024-05-23 16:25:00 +00:00
rails.gemspec Bump the required Ruby version to 3.1.0 2023-12-31 08:54:03 +01:00
version.rb Development of Rails 8.0 starts now 2024-05-13 16:45:20 +00:00
yarn.lock Depend on activestorage 8.0.0-alpha 2024-05-31 23:04:54 +00:00

README.md

Welcome to Rails

What's Rails?

Rails is a web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Controller (MVC) pattern.

Understanding the MVC pattern is key to understanding Rails. MVC divides your application into three layers: Model, View, and Controller, each with a specific responsibility.

Model layer

The Model layer represents the domain model (such as Account, Product, Person, Post, etc.) and encapsulates the business logic specific to your application. In Rails, database-backed model classes are derived from ActiveRecord::Base. Active Record allows you to present the data from database rows as objects and embellish these data objects with business logic methods. Although most Rails models are backed by a database, models can also be ordinary Ruby classes, or Ruby classes that implement a set of interfaces as provided by the Active Model module.

View layer

The View layer is composed of "templates" that are responsible for providing appropriate representations of your application's resources. Templates can come in a variety of formats, but most view templates are HTML with embedded Ruby code (ERB files). Views are typically rendered to generate a controller response or to generate the body of an email. In Rails, View generation is handled by Action View.

Controller layer

The Controller layer is responsible for handling incoming HTTP requests and providing a suitable response. Usually, this means returning HTML, but Rails controllers can also generate XML, JSON, PDFs, mobile-specific views, and more. Controllers load and manipulate models, and render view templates in order to generate the appropriate HTTP response. In Rails, incoming requests are routed by Action Dispatch to an appropriate controller, and controller classes are derived from ActionController::Base. Action Dispatch and Action Controller are bundled together in Action Pack.

Frameworks and libraries

Active Record, Active Model, Action Pack, and Action View can each be used independently outside Rails.

In addition to that, Rails also comes with:

  • Action Mailer, a library to generate and send emails
  • Action Mailbox, a library to receive emails within a Rails application
  • Active Job, a framework for declaring jobs and making them run on a variety of queuing backends
  • Action Cable, a framework to integrate WebSockets with a Rails application
  • Active Storage, a library to attach cloud and local files to Rails applications
  • Action Text, a library to handle rich text content
  • Active Support, a collection of utility classes and standard library extensions that are useful for Rails, and may also be used independently outside Rails

Getting Started

  1. Install Rails at the command prompt if you haven't yet:

    $ gem install rails
    
  2. At the command prompt, create a new Rails application:

    $ rails new myapp
    

    where "myapp" is the application name.

  3. Change directory to myapp and start the web server:

    $ cd myapp
    $ bin/rails server
    

    Run with --help or -h for options.

  4. Go to http://localhost:3000 and you'll see the Rails bootscreen with your Rails and Ruby versions.

  5. Follow the guidelines to start developing your application. You may find the following resources handy:

Contributing

We encourage you to contribute to Ruby on Rails! Please check out the Contributing to Ruby on Rails guide for guidelines about how to proceed. Join us!

Trying to report a possible security vulnerability in Rails? Please check out our security policy for guidelines about how to proceed.

Everyone interacting in Rails and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Rails code of conduct.

License

Ruby on Rails is released under the MIT License.